學習python這麼久，有沒有考慮發佈一個屬於自己的模塊？
1. 為什麼需要對項目分發打包？
平常我們習慣了使用 pip 來安裝一些第三方模塊，這個安裝過程之所以簡單，是因為模塊開發者為我們默默地為我們做了所有繁雜的工作，而這個過程就是 打包。
打包，就是將你的源代碼進一步封裝，並且將所有的項目部署工作都事先安排好，這樣使用者拿到後即裝即用，不用再操心如何部署的問題（如果你不想對照著一堆部署文檔手工操作的話）。
不管你是在工作中，還是業餘準備自己寫一個可以上傳到 PyPI 的項目，你都要學會如何打包你的項目。
Python 發展了這麼些年了，項目打包工具也已經很成熟了。他們都有哪些呢？
你可能聽過 disutils、 distutils 、distutils2、setuptools等等，好像很熟悉，卻又很陌生，他們都是什麼關係呢？
2. 包分發的始祖：distutils
distutils 是 Python 的一個標準庫，從命名上很容易看出它是一個分發（distribute）工具（utlis），它是 Python 官方開發的一個分發打包工具，所有後續的打包工具，全部都是基於它進行開發的。
distutils 的精髓在於編寫 setup.py，它是模塊分發與安裝的指導文件。
那麼如何編寫 setup.py 呢？這裡面的內容非常多，我會在後面進行詳細的解析，請你耐心往下看。
你有可能沒寫過 setup.py ，但你絕對使用過 setup.py 來做一些事情，比如下面這條命令，我們經常用它來進行模塊的安裝。
<code>$ python setup.py install/<code>
這樣的安裝方法是通過源碼安裝，與之對應的是通過二進制軟件包的安裝，同樣我也會在後面進行介紹。
3. 分發工具升級：setuptools
setuptools 是 distutils 增強版，不包括在標準庫中。其擴展了很多功能，能夠幫助開發者更好的創建和分發 Python 包。大部分 Python 用戶都會使用更先進的 setuptools 模塊。
distribute，或許你在其他地方也見過它，這裡也提一下。
distribute 是 setuptools 有一個分支版本，分支的原因可能是有一部分開發者認為 setuptools 開發太慢了。但現在，distribute 又合併回了 setuptools 中。因此，我們可以認為它們是同一個東西。
還有一個大包分發工具是 distutils2，其試圖嘗試充分利用distutils，detuptools 和 distribute 併成為 Python 標準庫中的標準工具。但該計劃並沒有達到預期的目的，且已經是一個廢棄的項目。
因此，setuptools 是一個優秀的，可靠的 Python 包安裝與分發工具。
那麼如何在一個乾淨的環境中安裝 setuptools 呢？
主要有兩種方法：
•源碼安裝：在 https://pypi.org/project/setuptools/#files 中下載 zip 包 解壓執行 python setup.py install 安裝•通過引導程序安裝：下載引導程序，它可以用來下載或者更新最新版本的 setuptools
<code>$ wget http://peak.telecommunity.com/dist/ez_setup.py
# 安裝$ python ez_setup.py
# 更新，以下兩種任選$ python ez_setup.py –U setuptools$ pip install -U setuptools/<code>
4. easy_install 使用指南
當你安裝完 setuptools 後，就擁有了一個叫做 easy_install 的第三方管理工具，這也是它區分於 distutils 的一大改進。
這裡簡單介紹一下它的用法，雖然它已經用得非常少了。
先是包的安裝
<code># 通過包名，從PyPI尋找最新版本，自動下載、編譯、安裝$ easy_install pkg_name
# 通過包名從指定下載頁尋找鏈接來安裝或升級包$ easy_install -f http://pythonpaste.org/package_index.html
# 指定線上的包地址安裝$ easy_install http://example.com/path/to/MyPackage-1.2.3.tgz
# 從本地的 .egg 文件安裝$ easy_install xxx.egg
# 在安裝時你可以添加額外的參數指定安裝目錄：--install-dir=DIR, -d DIR指定用戶安裝：--user/<code>
再者是包的升級
<code># 從 pypi 中搜索並升級包$ easy_install --upgrade pkg_name
# 指定版本進行升級$ easy_install "SomePackage==2.0"/<code>
最後是包的刪除
<code>$ easy_install -m pkg_name/<code>
需要注意的是，這樣的刪除，僅是在 easy-install.pth 文件中刪除，使其不能在 python 中使用 這個模塊，但實際的包還在你的電腦中，若要刪除徹底，需要你手動刪除相關的 .egg 及 其他文件。
默認情況下，easy_install 只會從 pypi 上下載相關軟件包，由於這個源在國外，下載包的速度並不理想，使用過pip的朋友自然會想，easy_install 是否能指定源進行安裝呢？
答案是，可以的。
編輯配置文件 /root/.pydistutils.cfg
<code>[easy_install]index-url=http://mirrors.aliyun.com/pypi/simple/find-links=http://mirrors.aliyun.com/pypi/simple//<code>
以上僅介紹了 easy_install 的一些常用的方法，想要了解更多，你可以點擊官方文檔：https://setuptools.readthedocs.io/en/latest/easy_install.html
總結一句：setuptools 是官方提供的一個專業用於包分發的工具，若只從安裝的角度來看，它的功能確實簡單。它更大的意義是對包的分發很有用，定製化程序非常高，我們現在也還在用它進行版本包的發佈。
5. 源碼包與二進制包什麼區別？
Python 包的分發可以分為兩種：
1.以源碼包的方式發佈
源碼包安裝的過程，是先解壓，再編譯，最後才安裝，所以它是跨平臺的，由於每次安裝都要進行編譯，相對二進包安裝方式來說安裝速度較慢。
源碼包的本質是一個壓縮包，其常見的格式有：
格式後綴zip.zipgztar.tar.gzbztar.tar.bz2ztar.tar.Ztar.tar
1.以二進制包形式發佈
二進制包的安裝過程省去了編譯的過程，直接進行解壓安裝，所以安裝速度較源碼包來說更快。
由於不同平臺的編譯出來的包無法通用，所以在發佈時，需事先編譯好多個平臺的包。
二進制包的常見格式有：
格式後綴egg.eggwheel.whl
6. eggs 與 wheels 有什麼區別？
Egg 格式是由 setuptools 在 2004 年引入，而 Wheel 格式是由 PEP427 在 2012 年定義。Wheel 的出現是為了替代 Egg，它的本質是一個zip包，其現在被認為是 Python 的二進制包的標準格式。
以下是 Wheel 和 Egg 的主要區別：
•Wheel 有一個官方的 PEP427 來定義，而 Egg 沒有 PEP 定義•Wheel 是一種分發格式，即打包格式。而 Egg 既是一種分發格式，也是一種運行時安裝的格式，並且是可以被直接 import•Wheel 文件不會包含 .pyc 文件•Wheel 使用和 PEP376 兼容的 .dist-info 目錄，而 Egg 使用 .egg-info 目錄•Wheel 有著更豐富的命名規則。•Wheel 是有版本的。每個 Wheel 文件都包含 wheel 規範的版本和打包的實現•Wheel 在內部被 sysconfig path type 管理，因此轉向其他格式也更容易
wheel 包可以通過 pip 來安裝，只不過需要先安裝 wheel 模塊，然後再使用 pip 的命令。
<code>$ pip install wheel$ pip wheel --wheel-dir=/local/wheels pkg/<code>
7. 超詳細講解 setup.py 的編寫？
打包分發最關鍵的一步是編寫 setup.py 文件。
以下是一個 setup.py 簡單的使用示例
<code>from setuptools import setup, find_packages
setup( name="mytest", version="1.0", author="wangbm", author_email="[email protected]", description="Learn to Pack Python Module -->公眾號：Python編程時光",
# 項目主頁 url="http://python-online.cn/",
# 你要安裝的包，通過 setuptools.find_packages 找到當前目錄下有哪些包 packages=find_packages())/<code>
接下來，我將慢慢擴充這個setup函數，增加更多的參數，以便你能理解setup函數能做哪些事情。
程序分類信息
classifiers 參數說明包的分類信息。所有支持的分類列表見：https://pypi.org/pypi?%3Aaction=list_classifiers
示例：
<code>from setuptools import setup, find_packages
setup( classifiers = [ # 發展時期,常見的如下 # 3 - Alpha # 4 - Beta # 5 - Production/Stable 'Development Status :: 3 - Alpha',
# 開發的目標用戶 'Intended Audience :: Developers',
# 屬於什麼類型 'Topic :: Software Development :: Build Tools',
# 許可證信息 'License :: OSI Approved :: MIT License',
# 目標 Python 版本 'Programming Language :: Python :: 2', 'Programming Language :: Python :: 2.7', 'Programming Language :: Python :: 3', 'Programming Language :: Python :: 3.3', 'Programming Language :: Python :: 3.4', 'Programming Language :: Python :: 3.5', ])/<code>
關於文件的分發
<code>from setuptools import setup, find_packages
setup( name="mytest", version="1.0", author="wangbm", author_email="[email protected]", description="Learn to Pack Python Module", url="http://python-online.cn/", packages=find_packages(),
# 安裝過程中，需要安裝的靜態文件，如配置文件、service文件、圖片等 data_files=[ ('', ['conf/*.conf']), ('/usr/lib/systemd/system/', ['bin/*.service']), ],
# 希望被打包的文件 package_data={ '':['*.txt'], 'bandwidth_reporter':['*.txt'] }, # 不打包某些文件 exclude_package_data={ 'bandwidth_reporter':['*.txt'] })/<code>
除了以上的參數配置之外，還可以使用一個叫做 MANIFEST.in 的文件，來控制文件的分發。
如下這是一個 MANIFEST.in 的樣例：
<code>include *.txtrecursive-include examples *.txt *.pyprune examples/sample?/build/<code>
這些配置，規定了如下幾點
•所有根目錄下的以 txt 為後綴名的文件，都會分發•根目錄下的 examples 目錄 和 txt、py文件都會分發•路徑匹配上 examples/sample?/build 不會分發
MANIFEST.in 需要放在和 setup.py 同級的頂級目錄下，setuptools 會自動讀取該文件。
關於依賴包下載安裝
<code>from setuptools import setup, find_packages
setup( ...
# 表明當前模塊依賴哪些包，若環境中沒有，則會從pypi中下載安裝 install_requires=['docutils>=0.3'],
# setup.py 本身要依賴的包，這通常是為一些setuptools的插件準備的配置 # 這裡列出的包，不會自動安裝。 setup_requires=['pbr'],
# 僅在測試時需要使用的依賴，在正常發佈的代碼中是沒有用的。 # 在執行python setup.py test時，可以自動安裝這三個庫，確保測試的正常運行。 tests_require=[ 'pytest>=3.3.1', 'pytest-cov>=2.5.1', ],
# 用於安裝setup_requires或tests_require裡的軟件包 # 這些信息會寫入egg的 metadata 信息中 dependency_links=[ "http://example2.com/p/foobar-1.0.tar.gz", ],
# install_requires 在安裝模塊時會自動安裝依賴包 # 而 extras_require 不會，這裡僅表示該模塊會依賴這些包 # 但是這些包通常不會使用到，只有當你深度使用模塊時，才會用到，這裡需要你手動安裝 extras_require={ 'PDF': ["ReportLab>=1.2", "RXP"], 'reST': ["docutils>=0.3"], })
/<code>
關於 install_requires， 有以下五種常用的表示方法：
1.'argparse'，只包含包名。這種形式只檢查包的存在性，不檢查版本。方便，但不利於控制風險。2.'setuptools==38.2.4'，指定版本。這種形式把風險降到了最低，確保了開發、測試與部署的版本一致，不會出現意外。缺點是不利於更新，每次更新都需要改動代碼。3.'docutils >= 0.3'，這是比較常用的形式。當對某個庫比較信任時，這種形式可以自動保持版本為最新。4.'Django >= 1.11, != 1.11.1, <= 2'，這是比較複雜的形式。如這個例子，保證了Django的大版本在1.11和2之間，也即1.11.x；並且，排除了已知有問題的版本1.11.1（僅舉例）。對於一些大型、複雜的庫，這種形式是最合適的。5.'requests[security, socks] >= 2.18.4'，這是包含了額外的可選依賴的形式。正常安裝requests會自動安裝它的install_requires中指定的依賴，而不會安裝security和socks這兩組依賴。這兩組依賴是定義在它的extras_require中。這種形式，用在深度使用某些庫時。
關於安裝環境的限制
有些庫並不是在所以的 Python 版本中都適用的，若一個庫安裝在一個未兼容的 Python 環境中，理論上不應該在使用時才報錯，而應該在安裝過程就使其失敗，提示禁止安裝。
這樣的功能，可以使用 python_requires 來實現。
<code>setup( ... python_requires='>=2.7, <=3',)/<code>
生成可執行文件的分發
<code>from setuptools import setup, find_packages
setup( name="mytest", version="1.0", author="wangbm", author_email="[email protected]", description="Learn to Pack Python Module", url="http://python-online.cn/", packages=find_packages(),
# 用來支持自動生成腳本，安裝後會自動生成 /usr/bin/foo 的可執行文件 # 該文件入口指向 foo/main.py 的main 函數 entry_points={ 'console_scripts': [ 'foo = foo.main:main' ] },
# 將 bin/foo.sh 和 bar.py 腳本，生成到系統 PATH中 # 執行 python setup.py install 後 # 會生成 如 /usr/bin/foo.sh 和 如 /usr/bin/bar.py >
上面的>
若你想對這些文件再作一些更改，比如去掉多餘的後綴，可以這樣做
<code>from setuptools.command.install_scripts import install_scripts
class InstallScripts(install_scripts):
def run(self): setuptools.command.install_scripts.install_scripts.run(self)
# Rename some/>setup( ... /> cmdclass={ "install_scripts": InstallScripts })/<code>
ext_modules
ext_modules 參數用於構建 C 和 C++ 擴展擴展包。其是 Extension 實例的列表，每一個 Extension 實例描述了一個獨立的擴展模塊，擴展模塊可以設置擴展包名，頭文件、源文件、鏈接庫及其路徑、宏定義和編輯參數等。如：
<code>setup( # other arguments here... ext_modules=[ Extension('foo', glob(path.join(here, 'src', '*.c')), libraries = [ 'rt' ], include_dirs=[numpy.get_include()]) ])/<code> setup.py 的參數非常多，能夠不借助文檔寫好一個setup.py好像沒那麼簡單。為了備忘，我整理了 setup 函數常用的一些參數：
參數說明name包名稱version包版本author程序的作者author_email程序的作者的郵箱地址maintainer維護者maintainer_email維護者的郵箱地址url程序的官網地址license程序的授權信息description程序的簡單描述long_description程序的詳細描述platforms程序適用的軟件平臺列表classifiers程序的所屬分類列表keywords程序的關鍵字列表packages需要處理的包目錄(通常為包含 __init__.py 的文件夾)py_modules需要打包的 Python 單文件列表download_url程序的下載地址cmdclass添加自定義命令package_data指定包內需要包含的數據文件include_package_data自動包含包內所有受版本控制(cvs/svn/git)的數據文件exclude_package_data當 include_package_data 為 True 時該選項用於排除部分文件data_files打包時需要打包的數據文件，如圖片，配置文件等ext_modules指定擴展模塊scripts指定可執行腳本,安裝時腳本會被安裝到系統 PATH 路徑下package_dir指定哪些目錄下的文件被映射到哪個源碼包requires指定依賴的其他包provides指定可以為哪些模塊提供依賴install_requires安裝時需要安裝的依賴包entry_points動態發現服務和插件，下面詳細講setup_requires指定運行 setup.py 文件本身所依賴的包dependency_links指定依賴包的下載地址extras_require當前包的高級/額外特性需要依賴的分發包zip_safe不壓縮包，而是以目錄的形式安裝
8. 打包輔助神器PBR 是什麼？
pbr 是 setuptools 的輔助工具，最初是為 OpenStack 開發，基於d2to1。
pbr 會讀取和過濾setup.cfg中的數據，然後將解析後的數據提供給 setup.py 作為參數。包含如下功能：
1.從git中獲取Version、AUTHORS and ChangeLog信息2.Sphinx Autodoc。pbr 會掃描project，找到所有模塊，生成stub files3.Requirements。pbr會讀取requirements.txt，生成setup函數需要的install_requires/tests_require/dependency_links
這裡需要注意，在 requirements.txt 文件的頭部可以使用：--index https://pypi.python.org/simple/，這一行把一個抽象的依賴聲明如 requests==1.2.0 轉變為一個具體的依賴聲明 requests 1.2.0 from pypi.python.org/simple/
4. long_description。從README.rst, README.txt or README file中生成long_description參數
使用pbr很簡單：
<code>from setuptools import setup
setup( setup_requires=['pbr'], pbr=True,)
/<code>
使用pbr時，setup.cfg中有一些配置。在[files]中，有三個key： packages:指定需要包含的包，行為類似於setuptools.find_packages namespace_packages:指定namespace packages data_files: 指定目的目錄和源文件路徑，一個示例：
<code>[files]data_files = etc/pbr = etc/pbr/* etc/neutron = etc/api-paste.ini etc/dhcp-agent.ini etc/init.d = neutron.init
/<code>
[entry_points] 段跟 setuptools 的方式相同。
到此，我講了三種編寫使用 setup.py 的方法
•使用命令行參數指定，一個一個將參數傳遞進去（極不推薦）•在 setup.py 中的setup函數中指定（推薦使用）•使用 pbr ，在 setup.cfg 中指定（易於管理，更推薦）
9. 如何使用 setup.py 構建包
1、構建源碼發佈包。
用於發佈一個 Python 模塊或項目，將源碼打包成 tar.gz （用於 Linux 環境中）或者 zip 壓縮包（用於 Windows 環境中）
<code>$ python setup.py sdist/<code>
那這種包如何安裝呢？
答案是，使用下一節即將介紹的 setuptools 中提供的 easy_install 工具。
<code>$ easy_install xxx.tar.gz/<code>
使用 sdist 將根據當前平臺創建默認格式的存檔。在類 Unix 平臺上，將創建後綴後為 .tar.gz 的 gzip 壓縮的tar文件分發包，而在Windows上為 ZIP 文件。
當然，你也可以通過指定你要的發佈包格式來打破這個默認行為
<code>$ python setup.py sdist --formats=gztar,zip/<code>
你可以指定的格式有哪些呢？
創建一個壓縮的tarball和一個zip文件。可用格式為：
格式描述zip壓縮檔（.zip）gztargzip壓縮的tar文件（.tar.gz）bztarbzip2格式的tar文件（.tar.bz2）xztarxz的tar文件（.tar.xz）ztar壓縮的tar文件（.tar.Z）tartar文件（.tar）
對以上的格式，有幾點需要注意一下：
•在版本3.5中才添加了對 xztar 格式的支持•zip 格式需要你事先已安裝相應的模塊：zip程序或zipfile模塊（已成為Python的標準庫）•ztar 格式正在棄用，請儘量不要使用
另外，如果您希望歸檔文件的所有文件歸root擁有，可以這樣指定
<code>python setup.py sdist --owner=root --group=root/<code>
2、構建二進制分發包。
在windows中我們習慣了雙擊 exe 進行軟件的安裝，Python 模塊的安裝也同樣支持 打包成 exe 這樣的二進制軟件包。
<code>$ python setup.py bdist_wininst/<code>
而在 Linux 中，大家也習慣了使用 rpm 來安裝包，對此你可以使用這條命令實現 rpm 包的構建
<code>$ python setup.py bdist_rpm/<code>
若你喜歡使用 easy_install 或者 pip 來安裝離線包。你可以將其打包成 egg 包
<code>$ python setup.py bdist_egg/<code>
若你的項目，需要安裝多個平臺下，既有 Windows 也有 Linux，按照上面的方法，多種格式我們要執行多次命令，為了方便，你可以一步到位，執行如下這條命令，即可生成多個格式的進制包
<code>$ python setup.py bdist/<code>
10. 如何使用 setup.py 安裝包
正常情況下，我們都是通過以上構建的源碼包或者二進制包進行模塊的安裝。
但在編寫 setup.py 的過程中，可能不能一步到位，需要多次調試，這時候如何測試自己寫的 setup.py 文件是可用的呢？
這時候你可以使用這條命令，它會將你的模塊安裝至系統全局環境中
<code>$ python setup.py install/<code>
如若你的項目還處於開發階段，頻繁的安裝模塊，也是一個麻煩事。
這時候你可以使用這條命令安裝，該方法不會真正的安裝包，而是在系統環境中創建一個軟鏈接指向包實際所在目錄。這邊在修改包之後不用再安裝就能生效，便於調試。
<code>$ python setup.py develop/<code>
11. 如何發佈包到 PyPi？
通過上面的學習，你一定已經學會了如何打包自己的項目，若你覺得自己開發的模塊非常不錯，想要 share 給其他人使用，你可以將其上傳到 PyPi （Python Package Index）上，它是 Python 官方維護的第三方包倉庫，用於統一存儲和管理開發者發佈的 Python 包。
如果要發佈自己的包，需要先到 pypi 上註冊賬號。然後創建 ~/.pypirc 文件，此文件中配置 PyPI 訪問地址和賬號。如的.pypirc文件內容請根據自己的賬號來修改。
典型的 .pypirc 文件
<code>[distutils]index-servers = pypi
[pypi]username:xxxpassword:xxx/<code>
然後使用這條命令進行信息註冊，完成後，你可以在 PyPi 上看到項目信息。
<code>$ python setup.py register/<code>
註冊完了後，你還要上傳源碼包，別人才使用下載安裝
<code>$ python setup.py upload/<code>
最後，小編想說：我是一名python開發工程師，整理了一套最新的python系統學習教程，想要這些資料的可以關注私信小編“01”即可，希望能對你有所幫助。
閱讀更多 Python程序員不動否 的文章
