Python包管理工具setuptools
什么是setuptools
setuptools是Python distutils增强版的集合，它可以帮助我们更简单的创建和分发Python包，尤其是拥有依赖关系的。用户在使用setuptools创建的包时，并不需要已安装setuptools，只要一个 启动模块 即可。
try:
from setuptools import setup
except ImportError:
from distutils.core import setup创建一个简单的包
有了setuptools后，创建一个包基本上是无脑操作
cd /tmp
mkdir demo
cd demo
在demo中创建一个
setup.py
文件，写入
from setuptools import setup, find_packages
setup(
name = "demo",
version = "0.1",
packages = find_packages(),
#packages=['myapp'] # 包括在安装包内的Python包
)
执行
python setup.py bdist_egg
即可打包一个test的包了。
运行如下命令：
>>python setup.py sdist #打包后的格式为tar.gz/zip当前目录下新增一个dist目录，里面会有一个同name值相同的文件包。Windows下时zip包，linux下是tar.gz包。
demo
|-- build
| `-- bdist.linux-x86_64
|-- demo.egg-info
| |-- dependency_links.txt
| |-- PKG-INFO
| |-- SOURCES.txt
| `-- top_level.txt
|-- dist
| `-- demo-0.1-py2.7.egg
`-- setup.py现在可以介绍一下刚刚setup()中的参数了
- name 包名
- version 版本号
- packages 所包含的其他包
要想发布到PyPI中，需要增加别的参数，这个可以参考 官方文档 中的例子了。
给包增加内容
上面生成的egg中没有实质的内容，显然谁也用不了，现在我们稍微调色一下，增加一点内容。
在demo中执行mkdir demo，再创建一个目录，在这个demo目录中创建一个
__init__.py
的文件，表示这个目录是一个包，然后写入：
#!/usr/bin/env python
#-*- coding:utf-8 -*-
def test():
print("hello world!")
if __name__ == '__main__':
test()现在的主目录结构为下：
demo
|-- demo
| `-- __init__.py
`-- setup.py再次执行python setup.py bdist_egg后，再看egg包
这回包内多了demo目录，显然已经有了我们自己的东西了，安装体验一下。
python setup.py install这个命令会讲我们创建的egg安装到python的site-packages目录下。 - 卸载：
python setup.py uninstall- 开发方式安装
python setup.py develop如果应用在开发过程中会频繁变更，每次安装还需要先将原来的版本卸掉，很麻烦。使用”develop”开发方式安装的话，应用代码不会真的被拷贝到本地Python环境的”site-packages”目录下，而是在”site-packages”目录里创建一个指向当前应用位置的链接。这样如果当前位置的源码被改动，就会马上反映到”site-packages”里。
打开python终端或者ipython都行，直接导入我们的包
>>> import demo
>>> demo.test()
hello world!setup函数各参数详解：
>>python setup.py --help
--name 包名称
--version (-V) 包版本
--author 程序的作者
--author_email 程序的作者的邮箱地址
--maintainer 维护者
--maintainer_email 维护者的邮箱地址
--url 程序的官网地址
--license 程序的授权信息
--description 程序的简单描述
--long_description 程序的详细描述
--platforms 程序适用的软件平台列表
--classifiers 程序的所属分类列表
--keywords 程序的关键字列表
--packages 需要打包的目录列表
--py_modules 需要打包的python文件列表
--download_url 程序的下载地址
--cmdclass
--data_files 打包时需要打包的数据文件，如图片，配置文件等
--scripts 安装时需要执行的脚步列表setup.py打包命令各参数详解：
>>python setup.py --help-commands
--python setup.py build # 仅编译不安装
--python setup.py install #安装到python安装目录的lib下
--python setup.py sdist #生成压缩包(zip/tar.gz)
--python setup.py bdist_wininst #生成NT平台安装包(.exe)
--python setup.py bdist_rpm #生成rpm包或者直接”bdist 包格式”，格式如下：
#python setup.py bdist --help-formats
--formats=rpm RPM distribution
--formats=gztar gzip'ed tar file
--formats=bztar bzip2'ed tar file
--formats=ztar compressed tar file
--formats=tar tar file
--formats=wininst Windows executable installer
--formats=zip ZIP file如：
python setup.py bdist --formats=zip 等价于 python setup.py sdistsetuptools进阶
在上例中，在前两例中，我们基本都使用setup()的默认参数，这只能写一些简单的egg。一旦我们的project逐渐变大以后，维护起来就有点复杂了，下面是setup()的其他参数，我们可以学习一下
使用find_packages()
对于简单工程来说，手动增加packages参数很容易，刚刚我们用到了这个函数，它默认在和setup.py同一目录下搜索各个含有
__init__.py
的包。其实我们可以将包统一放在一个src目录中，另外，这个包内可能还有aaa.txt文件和data数据文件夹。
demo
├── setup.py
└── src
└── demo
├── __init__.py
├── aaa.txt
└── data
├── abc.dat
└── abcd.dat
如果不加控制，则setuptools只会将
__init__.py
加入到egg中，想要将这些文件都添加，需要修改setup.py
from setuptools import setup, find_packages
setup(
packages = find_packages('src'), # 包含所有src中的包
package_dir = {'':'src'}, # 告诉distutils包都在src下
package_data = {
# 任何包中含有.txt文件，都包含它
'': ['*.txt'],
# 包含demo包data文件夹中的 *.dat文件
'demo': ['data/*.dat'],
)这样，在生成的egg中就包含了所需文件了。
另外，也可以排除一些特定的包，如果在src中再增加一个tests包，可以通过exclude来排除它,
find_packages(exclude=["*.tests", "*.tests.*", "tests.*", "tests"])使用entry_points
一个字典，从entry point组名映射到一个表示entry point的字符串或字符串列表。Entry points是用来支持动态发现服务和插件的，也用来支持自动生成脚本。这个还是看例子比较好理解：
setup(
entry_points = {
'console_scripts': [
'foo = demo:test',
'bar = demo:test',
'gui_scripts': [
'baz = demo:test',
)修改setup.py增加以上内容以后，再次安装这个egg，可以发现在安装信息里头多了两行代码（Linux下）：
Installing foo script to /usr/local/bin
Installing bar script to /usr/local/bin查看/usr/local/bin/foo内容
#!/usr/bin/python
# EASY-INSTALL-ENTRY-SCRIPT: 'demo==0.1','console_scripts','foo'
__requires__ = 'demo==0.1'
import sys
from pkg_resources import load_entry_point
if __name__ == '__main__':
sys.exit(
load_entry_point('demo==0.1', 'console_scripts', 'foo')()
)这个内容其实显示的意思是，foo将执行console_scripts中定义的foo所代表的函数。执行foo，发现打出了hello world!，和预期结果一样。
使用Eggsecutable Scripts
从字面上来理解这个词，Eggsecutable是Eggs和executable合成词，翻译过来就是另eggs可执行。也就是说定义好一个参数以后，可以另你生成的.egg文件可以被直接执行，貌似Java的.jar也有这机制？不很清楚，下面是使用方法：
setup(
# other arguments here...
entry_points = {
'setuptools.installation': [
'eggsecutable = demo:test',
)这么写意味着在执行python *.egg时，会执行我的test()函数，在文档中说需要将.egg放到PATH路径中。
包含数据文件
在上面我们已经列举了如何包含数据文件，其实setuptools提供的不只这么一种方法，下面是另外两种
1）包含所有包内文件
这种方法中包内所有文件指的是受版本控制（CVS/SVN/GIT等）的文件，或者通过MANIFEST.in声明的
from setuptools import setup, find_packages
setup(
include_package_data = True
)2）包含一部分，排除一部分
from setuptools import setup, find_packages
setup(
packages = find_packages('src'),
package_dir = {'':'src'},
include_package_data = True,
# 排除所有 README.txt
exclude_package_data = { '': ['README.txt'] },
)如果没有使用版本控制的话，可以还是使用3中提到的包含方法
可扩展的框架和应用
setuptools可以帮助你将应用变成插件模式，供别的应用使用。官网举例是一个帮助博客更改输出类型的插件，一个博客可能想要输出不同类型的文章，但是总自己写输出格式化代码太繁琐，可以借助一个已经写好的应用，在编写博客程序的时候动态调用其中的代码。
通过entry_points可以定义一系列接口，供别的应用或者自己调用，例如：
setup(
entry_points = {'blogtool.parsers': '.rst = some_module:SomeClass'}
setup(
entry_points = {'blogtool.parsers': ['.rst = some_module:a_func']}
setup(
entry_points = """
[blogtool.parsers]
.rst = some.nested.module:SomeClass.some_classmethod [reST]
extras_require = dict(reST = "Docutils>=0.3.5")
)上面列举了三中定义方式，即我们将我们some_module中的函数，以名字为blogtool.parsers的借口共享给别的应用。
别的应用使用的方法是通过
pkg_resources.require()
来导入这些模块。
另外，一个名叫 stevedore 的库将这个方式做了封装，更加方便进行应用的扩展。
引入非Python文件
上例中，我们只会将”myapp”包下的源码打包，如果我们还想将其他非Python文件也打包，比如静态文件（JS，CSS，图片），应该怎么做呢？这时我们要在项目目录下添加一个”MANIFEST.in”文件夹。假设我们把所有静态文件都放在”static”子目录下，现在的项目结构如下：
setup-demo/
├ setup.py # 安装文件
├ MANIFEST.in # 清单文件
└ myapp/ # 源代码
├ static/ # 静态文件目录
├ __init__.py
...我们在清单文件”MANIFEST.in”中，列出想要在包内引入的目录路径：
recursive-include myapp/static *
recursive-include myapp/xxx *“recursive-include”表明包含子目录。还有一件事要做，就是在”setup.py”中将” include_package_data”参数设为True：
#coding:utf8
from setuptools import setup
setup(
name='MyApp', # 应用名
version='1.0', # 版本号
packages=['myapp'], # 包括在安装包内的Python包
include_package_data=True # 启用清单文件MANIFEST.in
)之后再次打包或者安装，”myapp/static”目录下的所有文件都会被包含在内。如果你想排除一部分文件，可以在setup.py中使用”exclude_package_date”参数，比如：
setup(
include_package_data=True, # 启用清单文件MANIFEST.in
exclude_package_date={'':['.gitignore']}
)上面的代码会将所有”.gitignore”文件排除在包外。如果上述”exclude_package_date”对象属性不为空，比如”{‘myapp’:[‘.gitignore’]}”，就表明只排除”myapp”包下的所有”.gitignore”文件。
自动安装依赖
我们的应用会依赖于第三方的Python包，虽然可以在说明文件中要求用户提前安装依赖包，但毕竟很麻烦，用户还有可能装错版本。其实我们可以在setup.py文件中指定依赖包，然后在使用setuptools安装应用时，依赖包的相应版本就会被自动安装。让我们来修改上例中的setup.py文件，加入”install_requires”参数：
#coding:utf8
from setuptools import setup
setup(
name='MyApp', # 应用名
version='1.0', # 版本号
packages=['myapp'], # 包括在安装包内的Python包
include_package_data=True, # 启用清单文件MANIFEST.in
exclude_package_date={'':['.gitignore']},
install_requires=[ # 依赖列表
'Flask>=0.10',
'Flask-SQLAlchemy>=1.5,<=2.1'
)上面的代码中，我们声明了应用依赖Flask 0.10及以上版本，和Flask-SQLAlchemy 1.5及以上、2.1及以下版本。setuptools会先检查本地有没有符合要求的依赖包，如果没有的话，就会从PyPI中获得一个符合条件的最新的包安装到本地。
执行下试试，会发现不但Flask 0.10.1（当前最新版本）被自动安装了，连Flask的依赖包Jinja2和Werkzeug也被自动安装了
如果应用依赖的包无法从PyPI中获取怎么办，我们需要指定其下载路径：
setup(
install_requires=[ # 依赖列表
'Flask>=0.10',
'Flask-SQLAlchemy>=1.5,<=2.1'
dependency_links=[ # 依赖包下载路径
'http://example.com/dependency.tar.gz'
)路径应指向一个egg包或tar.gz包，也可以是个包含下载地址（一个egg包或tar.gz包）的页面。个人建议直接指向文件。
自动搜索Python包
之前我们在setup.py中指定了”packages=[‘myapp’]”，说明将Python包”myapp”下的源码打包。如果我们的应用很大，Python包很多怎么办。大家看到这个参数是一个列表，我们当然可以将所有的源码包都列在里面，但肯定很多人觉得这样做很傻。的确，setuptools提供了”find_packages()”方法来自动搜索可以引入的Python包：
#coding:utf8
from setuptools import setup, find_packages
setup(
name='MyApp', # 应用名
version='1.0', # 版本号
packages=find_packages(), # 包括在安装包内的Python包
include_package_data=True, # 启用清单文件MANIFEST.in
exclude_package_date={'':['.gitignore']},
install_requires=[ # 依赖列表
'Flask>=0.10',
'Flask-SQLAlchemy>=1.5,<=2.1'
extras_require={
'lxml': ['lxml']
)这样当前项目内所有的Python包都会自动被搜索到并引入到打好的包内。”find_packages()”方法可以限定你要搜索的路径，比如使用”find_packages(‘src’)”就表明只在”src”子目录下搜索所有的Python包。
补充
- zip_safe参数
决定应用是否作为一个zip压缩后的egg文件安装在当前Python环境中，还是作为一个以.egg结尾的目录安装在当前环境中。因为有些工具不支持zip压缩文件，而且压缩后的包也不方便调试，所以建议将其设为False：”zip_safe=False”。
- 描述信息
部分参数提供了更多当前应用的细节信息，对打包安装并无任何影响，比如：
setup(
author = "Billy He",
author_email = "[email protected]",
description = "This is a sample package",
license = "MIT",