把 python 程序打包成 egg 或者 whl 安装包
原文出处：http://www.worldhello.net/2010/12/08/2178.html
本文略有改动
1.1 安装setuptools
首先要安装setuptools工具。debian/ubuntu下可以直接使用apt安装：
$ sudo apt-get install python-setuptools
或者通过pip安装：
$ pip install setuptools
更新setuptools：
$ pip install --upgrade setuptools
或者下载setuptools的whl包来安装。可以在查看最新版本下载。下载完毕以后通过sh安装。
$ wget https://files.pythonhosted.org/packages/ec/51/f45cea425fd5cb0b0380f5b0f048ebc1da5b417e48d304838c02d6288a1e/setuptools-41.0.1-py2.py3-none-any.whl $ pip install setuptools-41.0.1-py2.py3-none-any.whl
现在就可以使用pip命令来安装其他的 egg 或者 whl 包了。
1.2 制作自己的egg包
总是安装别人的 egg/whl 包，是不是也想制作自己的包呢？好，接下来我们就自己制作一个简单的包。 首先建立工程目录egg-demo，初始化一个 setup.py 文件：
$ mkdir egg-demo $ cd egg-demo $ touch setup.py $ ls setup.py
下面主要就是填充 setup.py。setup.py 其实是 python 工具包distutils的配置文件，setuptools就是基于distutils来做的。 在 setup.py 中通过setup函数来配置打包信息。首先要引入setuptools的函数setup。setuptools的setup其实就是distutils的setup函数，填写 setup.py 为以下内容：
$ cat setup.py #!/usr/bin/env python #-*- coding:utf-8 -*- from setuptools import setup setup()
写到这里，一个空的 egg 配置文件就写好了。我们可以使用下面命令生成 egg 包：
$ python setup.py bdist_egg
或者生成 whl 包：
$ python setup.py bdist_wheel
下面看看究竟生成了什么：
$ ls -f build/ dist/ setup.py unknown.egg-info/
可以看到多了三个文件夹。而在 dist 文件夹下，有一个 egg 文件：unknown-0.0.0-py3.6.egg。 产蛋成功！先看看这个 egg 文件是什么格式的：
$ file dist/unknown-0.0.0-py3.6.egg dist/unknown-0.0.0-py3.6.egg: zip archive data, at least v2.0 to extract
噢，原来就是一个zip压缩包呀！好，再来看看内部构造：
$ unzip -l dist/unknown-0.0.0-py3.6.egg
archive: dist/unknown-0.0.0-py3.6.egg
length date time name
--------- ---------- ----- ----
181 2019-07-16 14:43 egg-info/pkg-info
132 2019-07-16 14:43 egg-info/sources.txt
1 2019-07-16 14:43 egg-info/dependency_links.txt
1 2019-07-16 14:43 egg-info/top_level.txt
1 2019-07-16 14:43 egg-info/zip-safe
--------- -------
316 5 files
同样的，可以对 whl 文件进行查看：
$ file dist/unknown-0.0.0-py3-none-any.whl
dist/unknown-0.0.0-py3-none-any.whl: zip archive data, at least v2.0 to extract
$ unzip -l dist/unknown-0.0.0-py3-none-any.whl
archive: dist/unknown-0.0.0-py3-none-any.whl
length date time name
--------- ---------- ----- ----
171 2019-07-16 06:44 unknown-0.0.0.dist-info/metadata
97 2019-07-16 06:44 unknown-0.0.0.dist-info/wheel
1 2019-07-16 06:44 unknown-0.0.0.dist-info/top_level.txt
296 2019-07-16 06:44 unknown-0.0.0.dist-info/record
--------- -------
565 4 files
可以看到，whl 文件和 egg 文件还是有不同的。
只有一个egg-info文件夹，内含五个 egg 信息文件，没了。 这个 egg 名称未知，版本 0.0.0。这是因为我们在setup里什么也没有设置。 显然，这个 egg 什么也不能做。 下面给它加点料。 在setup.py中，setup函数接收一系列属性作为配置参数。
- name：name 是 egg 包的名称，也是寻找要打包的文件夹的名称，默认是 unknown。
- version：版本号，默认 0.0.0
- packages：这里要用到 setuptools 的另一个函数 find_packages，顾名思义，find_packages 用来将指定目录下的文件打包。
- zip_safe：默认是 false，这样在每次生成 egg 包时都会检查项目文件的内容，确保无误。
还有一些描述性的属性，如 description，long_description，author，author_email，license，keywords，platform，url 等。 填充setup.py文件如下：:
$ cat setup.py
#!/usr/bin/env python
#-*- coding:utf-8 -*-
from setuptools import setup, find_packages
setup(
name = "demo",
version="0.1.0",
packages = find_packages(),
zip_safe = false,
description = "egg test demo.",
long_description = "egg test demo, haha.",
author = "amoblin",
author_email = "amoblin@ossxp.com",
license = "gpl",
keywords = ("test", "egg"),
platforms = "independant",
url = "",
)
在egg-demo目录下建立和上述 name 名称相同的目录demo，demo目录下写__init__.py文件：
$ mkdir demo
$ cat demo/__init__.py
#!/usr/bin/env python
#-*- coding:utf-8 -*-
def test():
print "hello, i'm amoblin."
if __name__ == '__main__':
test()
再次生成 egg 包以后查看 egg 包信息：
$ python setup.py bdist_egg
$ unzip -l dist/demo-0.1.0-py3.6.egg
archive: dist/demo-0.1.0-py3.6.egg
length date time name
--------- ---------- ----- ----
227 2019-07-16 14:50 egg-info/pkg-info
164 2019-07-16 14:50 egg-info/sources.txt
1 2019-07-16 14:50 egg-info/dependency_links.txt
1 2019-07-16 14:50 egg-info/not-zip-safe
5 2019-07-16 14:50 egg-info/top_level.txt
111 2019-07-16 14:49 demo/__init__.py
--------- -------
509 6 files
可以看到，多了一个文件夹demo，里面有我们写的__init__.py。 奉行敏捷原则，先安装了体验一下再说：
$ sudo python setup.py install running install running bdist_egg running egg_info writing demo.egg-info/pkg-info writing dependency_links to demo.egg-info/dependency_links.txt writing top-level names to demo.egg-info/top_level.txt reading manifest file 'demo.egg-info/sources.txt' writing manifest file 'demo.egg-info/sources.txt' installing library code to build/bdist.linux-x86_64/egg running install_lib running build_py creating build/bdist.linux-x86_64/egg creating build/bdist.linux-x86_64/egg/demo copying build/lib/demo/__init__.py -> build/bdist.linux-x86_64/egg/demo byte-compiling build/bdist.linux-x86_64/egg/demo/__init__.py to __init__.cpython-36.pyc creating build/bdist.linux-x86_64/egg/egg-info copying demo.egg-info/pkg-info -> build/bdist.linux-x86_64/egg/egg-info copying demo.egg-info/sources.txt -> build/bdist.linux-x86_64/egg/egg-info copying demo.egg-info/dependency_links.txt -> build/bdist.linux-x86_64/egg/egg-info copying demo.egg-info/not-zip-safe -> build/bdist.linux-x86_64/egg/egg-info copying demo.egg-info/top_level.txt -> build/bdist.linux-x86_64/egg/egg-info creating 'dist/demo-0.1.0-py3.6.egg' and adding 'build/bdist.linux-x86_64/egg' to it removing 'build/bdist.linux-x86_64/egg' (and everything under it) processing demo-0.1.0-py3.6.egg removing '/usr/local/lib/python3.6/dist-packages/demo-0.1.0-py3.6.egg' (and everything under it) creating /usr/local/lib/python3.6/dist-packages/demo-0.1.0-py3.6.egg extracting demo-0.1.0-py3.6.egg to /usr/local/lib/python3.6/dist-packages demo 0.1.0 is already the active version in easy-install.pth installed /usr/local/lib/python3.6/dist-packages/demo-0.1.0-py3.6.egg processing dependencies for demo==0.1.0 finished processing dependencies for demo==0.1.0
在这一步，也可以直接进入到 dist 文件夹中，使用 pip install demo-0.1.0-py3.6.egg 命令来安装。还更加方便，因为在卸载的时候也可以使用 pip remove 命令来卸载
ok!安装完毕！接下来我们就可以直接通过import来使用啦！
$ python -c "from demo import test;test()" hello, i'm amoblin.
成功输出！这说明安装正确。我们的一个 egg 包诞生了。 一般情况下，我们的源程序都放在 src 目录下，所以接下来将 demo 文件夹移动到 src 里。但这样也要修改setup.py文件，修改find_packages函数中参数为'src'，同时增加package_dir参数：
packages=find_packages('src'),
package_dir = {'':'src'}
这样告诉 setuptools 在 src 目录下找包，而不是原来默认的工程根目录。
1.3 egg 文件卸载
以 python3.6 版本为例，egg 文件一般安装在/usr/local/lib/python3.6/dist-packages/目录下，该目录下还有一个easy-install.pth文件，用于存放安装的 egg 信息：
$ cd /usr/local/lib/python3.6/dist-packages $ cat easy-install.pth|grep demo ./demo-0.1.0-py3.6.egg $ ls -f|grep demo demo-0.1.0-py3.6.egg/
卸载 egg 文件很简单，首先将包含此 egg 的行从 easy-install.pth 中删除，然后删除 egg 文件夹即可。