python打包工具distutils、setuptools分析

上一篇博文中总结了python中导入包,安装包一条完整的线路。其中有一个有意思的知识点,安装包的方式有很多种,模块和包管理中打包,发布,安装也是值得研究的内容。

python中安装包的方式有很多种:

  1. 源码包:python setup.py install
  2. 在线安装:pip install 包名(linux) / easy_install 包名(window)

python包在开发中十分常见,一般的使用套路是所有的功能做一个python模块包,打包模块,然后发布,安装使用。打包和安装包就是最常见的工作。学习中遇到distutils和setuptools两种打包的工具,学习之后做笔记记录。

distutils

distutils 是 python 标准库的一部分,这个库的目的是为开发者提供一种方便的打包方式, 同时为使用者提供方便的安装方式。当我们开发了自己的模块之后,使用distutils的setup.py打包。

一、完成功能python

hello.py

def hello_fun():
    print "i say hello to you"

二、建立setup.py文件

setup.py

from distutils.core import setup

setup(
    name="hello_module",
    version="1.0",
    author="ljk",
    author_email="[email protected]",
    py_modules=[‘hello‘],
)

三、执行打包命令

python setup sdist

再次查看当前目录下自动生成了一个文件夹dist,文件夹中有一个压缩包即为我们的目标文件。另外有一个记录文件MANIFEST。

四、安装模块

hello_module-1.0.tar.gz 是生成的python模块。切换到的我的python虚拟环境中,安装该模块。

使用python setup.py install 安装该模块。从路径可以看出,该模块安装到标准库的制定路径下。

五、使用模块

安装好模块之后,在python的交互环境中导入模块。模块就是hello.py文件,引用hello.py文件中的hello_fun()函数。

setuptools

setuptools是distutils的增强版。setuptools有一个entry_points功能很方便,类似linux启动某个服务,如在linux命令行里firefox能启动火狐浏览器。

首先检验没有安装之前,命令path没有作用。

 一、创建功能包

创建一个文件夹demo,在文件夹里创建get_path.py和__init__.py两个文件。get_path.py是功能函数,__init__.py是包的标识文件。

get_path.py

import os 

def fun():
    print "i am in the path:"
    print os.getcwd()

二、配置setup.py文件

创建setup.py文件,填写必要的打包信息。

setup.py

#-*- encoding: UTF-8 -*-
from setuptools import setup

setup(
    name = "demo",                # 包名
    version = "0.1",              # 版本信息
    packages = [‘demo‘],          # 要打包的项目文件夹
    include_package_data=True,    # 自动打包文件夹内所有数据
    zip_safe=True,                # 设定项目包为安全,不用每次都检测其安全性
    install_requires = [          # 安装依赖的其他包(测试数据)
    ‘docutils>=0.3‘,
    ‘requests‘,
    ],

    # 设置程序的入口为path
    # 安装后,命令行执行path相当于调用get_path.py中的fun方法
    entry_points={
        ‘console_scripts‘:[
            ‘path = demo.get_path:fun‘
                                      ]
    },
)

在配置中将该模块需要的依赖全部都写好,安装时指定地址去下载。这种方式简化了使用时的安装过程,但是还不够好。最好的方式是pip的自动下载。

三、打包

python setup.py sdist

打包之后多出两个文件夹,分别是demo.egg-info和dist。demo.egg-info是必要的安装信息,而dist中的压缩包就是安装包。

查看dist/demo-0.1.tar.gz解压之后的文件。

四、安装包

五、使用包

安装之后在命令行中直接输入path,回车能够看到调用了get_path.py中的函数fun(),输出字符串。

同时也可以导入使用。

setuptools的进阶使用

上面使用setuptools时只是简单的用一个配置文件setup.py就完成了打包信息填写。在真实的开发环境中,往往是多个文件配合。以openstack的打包为例。openstack中引入了Pbr的管理工具。

pbr是setuptools的辅助工具,最初为openstack开发,基于d2to1。Pbr会读取和过滤setup.cfg中的内容,然后将解析后的数据提供给setup.py作为参数。
setup.cfg提供setup.py的默认参数,同时易于修改。Setup.py先解析setup.cfg文件,然后执行相关命令。包括以下功能:

1、从git中获取Version,AUTHORS和ChangeLog信息

2、SphinxAutodoc。pbr会扫描project,找到所有模块,生成stubfiles

3、Requirements。读取requirements.txt文件,生成setup函数需要依赖包

4、long_description。从README.rst、README.txt或者READMEfile中生成long_description参数

Pbr的文件很简单,如下。配置之后会自动寻找目录下的setup.cfg文件,解析文件参数给setup.py使用。

setup.py

from setuptools import setup

setuptools.setup(

setup_requires=[‘pbr‘],

pbr=True)

setup.cfg

[metadata]

name= keystone

version= 2015.2

summary= OpenStack Identity

description-file=

README.rst

author= OpenStack

author-email= [email protected]

home-page= http://www.openstack.org/

classifier=

Environment:: OpenStack

IntendedAudience :: Information Technology

IntendedAudience :: System Administrators

License:: OSI Approved :: Apache Software License

OperatingSystem :: POSIX :: Linux

ProgrammingLanguage :: Python

ProgrammingLanguage :: Python :: 2

ProgrammingLanguage :: Python :: 2.7

[files]

packages=

keystone

[global]

setup-hooks=

pbr.hooks.setup_hook

[egg_info]

tag_build=

tag_date= 0

tag_svn_revision= 0

[build_sphinx]

all_files= 1

build-dir= doc/build

source-dir= doc/source

[compile_catalog]

directory= keystone/locale

domain= keystone

具体参数有待深入学习。。。

原文地址:https://www.cnblogs.com/goldsunshine/p/8872623.html

时间: 2024-10-03 22:40:32

python打包工具distutils、setuptools分析的相关文章

[转]Python打包工具

作者:Tarek Ziadé,翻译:张吉 原文:http://www.aosabook.org/en/packaging.html 转载地址:http://www.ituring.com.cn/article/19090 14.1 简介 对于如何安装软件,目前有两种思想流派.第一种是说软件应该自给自足,不依赖于其它任何部件,这点在Windows和Mac OS X系统中很流行.这种方式简化了软件的管理:每个软件都有自己独立的“领域”,安装和卸载它们不会对操作系统产生影响.如果软件依赖一项不常见的类

Python打包工具setuptools的使用

将我们写的Python程序发布成包后,可以使其能够安装使用. 在项目上测试的时候,某些情况下,可以将Python打包,然后上传到测试服务器,安装测试. setuptools是常用的打包工具. 一个简单的setup.py文件如下: from setuptools import setup, find_packages setup( name = "my_demo", version = "0.1", packages = find_packages() ) 其中,na

最详细的Python打包工具:Pyinstaller实战指南,如丝滑般体验

写了个吊炸天的Python项目,把我和左手相处的时间都赔上了.但出于版权考虑,我不太想让使用方直接用我的代码,毕竟Python代码给出去,就真的收不回来了. 想给客户演示的时候,不想那么墨迹的打开dos cmd 或者 terminal ,然后运行 python app.py 这样的命令行.最好是客户双击,完事儿.就像有人在那自己动一样-- PyInstaller 来了,他就是这么一款帮助我们把整个项目完整打包的工具.目前已经兼容Py3.7,以及 Mac App 和 Windows Exe. 文档

Python 打包工具cx_freeze 问题记录及解决办法

在节前的最后一天,解决了打包过程中遇到的所有问题,可以成功运行了!真是个好彩头,希望新的一年一切顺利! 以下是在使用cx_freeze过程中遇到的问题及解决办法(Win7) 问题描述:运行exe,启动无数个主程序,导致系统无法使用   原因:在程序中使用了multiprocessing的包   解决办法:在主文件if __name__ == "__main__":后,添加multiprocessing.freeze_support(),一定要在添加在最开始处 2. 问题描述:运行后,提

python版本管理工具pyenv和包管理工具pipenv

一.pyenv版本管理工具 pyenv是一个python版本管理工具,可以实现轻松切换多个python版本 它可根据每个用户更改全局python版本,也可以为每个项目指定python版本,还可以管理virtualenv虚拟环境,可以自己创建virtualenv或者通过pyenv-virtualenv来自动化创建虚拟环境 pyenv通过PATH环境变量来匹配切换python或者pip的工作目录,pyenv通过读取工作环境来指定使用哪个python版本,如在当前会话中查找PYENV_VERSION环

Python打包分发工具setuptools

作为Python标准的打包及分发工具,setuptools可以说相当地简单易用.它会随着Python一起安装在你的机器上.你只需写一个简短的setup.py安装文件,就可以将你的Python应用打包 首先,如果你需要另外安装setuptools,你可以使用下面的命令: wget http://peak.telecommunity.com/dist/ez_setup.py sudo python ez_setup.py 第一个安装文件 接下来让我们编写安装文件,假设我们的项目名为setup-dem

python之模块distutils,打包工具

# -*- coding: utf-8 -*- #python 27 #xiaodeng #python之模块distutils,打包工具 import distutils #distutils包有2个目的: 1)distutils希望让最终用户觉得安装新模块.包和工具的过程一致而轻松 2)distutils希望让新模块.包和工具的开发者觉得创建这些容易安装的分发包很轻松 总得来说,distutils就是用来打包的模块. #2.用distutils如何打包? #http://blog.csdn.

Python的包管理工具distribute,setuptools,easy_install与pip

刚开始学习Python时,看资料和别人介绍中提到过,安装Python的包有的用easy_install, setuptools, 有的使用pip,distribute.现在把这些相关的资料整理一下,能更清晰的了解Python的设计,关于这些可以参考http://guide.python-distribute.org/installation.html. 1.distutils Python 自带的基本安装工具,适用于非常简单的应用场景. 2.distribute 通过查阅Distribute的文

python打包成.exe工具py2exe0-----No such file or directory错误

转自:http://justcoding.iteye.com/blog/900993 一.简介 py2exe是一个将python脚本转换成windows上的可独立执行的可执行程序(*.exe)的工具,这样,你就可以不用装python而在windows系统上运行这个可执行程序. py2exe已经被用于创建wxPython,Tkinter,Pmw,PyGTK,pygame,win32com client和server,和其它的独立程序.py2exe是发布在开源许可证下的. 二.安装py2exe 从h