如何将自己的Python程序打包--setuptools

0.对于python，你必须知道的基础

0-1）PyPI：Python Package Index

PyPI首页网址：pypi.python.org，基本上能在这上面找到所有的扩展包。

0-2）PyPI上的软件包实际上是经过一些处理才被收录的，所以从PyPI上下载的东西有一些通用的安装方法。主要有两大类安装方法：

(1)自行安装；（2)通过工具安装。

自行安装：从PyPI上下载的包解压后，都可以通过python setup.py install来安装。这将把程序安装到site-package目录中，把脚本安装到Scripts目录中(Linux是bin目录)。这种方式无法自动解决依赖关系。

通过工具安装：常用的工具有两个——easy_install和pip。

安装：easy_install packageName

安装：easy_install package.egg

---

安装：pip install packageName

更新：pip install -U packageName

移除：pip uninstall packageName

搜索：pip search packageName

帮助：pip help

---

这两个工具实际上都是基于 setuptools这个三方包的。只不过easy_install 是setuptools的亲儿子，pip 是后儿子而已。当你安装setuptools 时，会自动在Scripts 文件夹中生成一个 easy_install.exe 。 之后就可以在 cmd 中直接用easy_install 安装 package 了。setuptools 实际上提供了发布你自己的python package的功能，而easy_install 只是 setuptools 的一个工具而已。pip之所以是后儿子，是因为安装完setuptools，不会自动安装pip，必须手动安装。而pip又依赖于setuptools，所以说是儿子，还是后的。

注：还有个第三方包，叫 distutils，setuptool是基于这个第三包做的。其实pip依赖于setuptools或者distutils，这两个只要装了任意一个，就可以装pip了。

注：easy_install和pip这两个工具安装的软件，都涉及到一个叫egg的东西。egg包是目前最流行的python应用打包部署方式。总是安装别人的egg包，是不是也想制作自己的egg包呢？

1.什么是setuptools

setuptools是Python distutils增强版的集合，它可以帮助我们更简单的创建和分发Python包，尤其是拥有依赖关系的。用户在使用setuptools创建的包时，并不需要已安装setuptools，只要一个启动模块即可。

功能亮点：

·利用EasyInstall自动查找、下载、安装、升级依赖包

· 创建Python Eggs

·包含包目录内的数据文件

·自动包含包目录内的所有的包，而不用在setup.py中列举

·自动包含包内和发布有关的所有相关文件，而不是创建一个MANIFEST.in文件

·自动生成经过包装的脚本或Windows执行文件

·支持Pyrex，即在可以setup.py中列出.pyx文件，而最终用户无需安装Pyrex

·支持上传到PyPI

·可以部署开发模式，使项目在sys.path中

·用新命令或setup()参数扩展distutils，为多个项目发布/重用扩展

·在项目setup()中简单声明entry points，创建可以自动发现扩展的应用和框架

总之，setuptools就是比distutils好用的多，基本满足大型项目的安装和发布。

 

2.安装setuptools

检查是否安装好setuptools：

可以查到setuptools的版本号，说明已经安装好

若未安装：Windows 下安装 setuptools 步骤

 

3.创建一个简单的包

1）创建一个demo文件夹: mkdir demo  ； 也可以在pycharm里手工创建：

2）在demo文件夹内创建setup.py文件，并写入一个setup函数，该函数中大部分是描述性东西。最主要的是package参数，可以手动列出所有的package，也可以用用自带的find_packages来动态获取package。所有setup.py文件是很简单的。   

*****注意：packages 不要拼错了或少了s

3）检查setup.py是否有错误或警告：python setup.py check

该警告是由于将packages拼错了，少了一个s'

检查无error、无warning 通过

4）执行python setup.py bdist_egg即可打包一个test的包了。

注意，该图中的packages拼写错了，其他没错

在dist中生成的是egg包，.egg文件其实是一个zip包。

5）将demo-0.1-py3.6.egg上传到Linux服务器上，解压：unzip -l demo-0.1-py3.6.egg 。

解压：unzip -l demo-0.1-py3.6.egg   

解压可以看到，.egg文件里面是一些自动生成的文件。可以看出这个.egg文件包含了demo.egg-info文件内的一些文件名。

4.给包增加内容

上面生成的egg中没有实质的内容，显然谁也用不了。

1）现在给包中再增加一些内容。在demo目录下，再创建一个demo2文件夹，再在demo2文件夹下创建一个__init__.py文件，表示该目录是一个包。 

2）然后在__init__.py里写入：

同上，也创建一个文件名与工程名一样的包。如下：

3）再次执行python setup.py bdist_egg ；然后在Linux系统中解压.egg文件，查看文件内容：

将所有的文件信息都放入.egg文件里了

4）安装该包：python setup.py install

egg会安装到python的site-package目录下

在python终端中，直接导入这个包，检查该模块是否能成功使用。

ok

说明，可以在demo目录下创建与它不同名的模块

6.python setup.py --help-commands

7.setup.py卸载

通过发行包附带的setup.py安装的模块，首选setup.py提供的uninstall选项。如果没有提供uninstall选项，则通过如下命令行手动卸载：

1）首先获取安装过程中产生的文：

python setup.py install --record record.txt

2）然后删除它们

FOR /F "delims=" %f in (record.txt) DO del "%f"

参考文章：

【1】PyPI, pip, easy_install, setuptools，distutils，egg 等等

【2】Python模块常用的几种安装方式

【3】python技巧26[python的egg包的安装和制作]