如果是開源的Python程式碼，為了能夠讓大家更方便的使用，放到PyPI上也許是個非常不錯的主意（PyPI：Python Package Index）。剛開始我以為要將程式碼打包放到PyPI上是一件非常複雜繁瑣的事情，不過看過《Dive Into Python 3》的PACKAGING PYTHON LIBRARIES介紹（CHAPTER 16），並自己動手操作了一下，發現打包釋出這個事情並沒有想象中的那麼有難度。為了方便其他朋友閱讀的方便，就嘗試寫了這個博文，來記錄下如何將自己寫的Python程式碼打包上傳到PyPI上。

在Python的世界裡，有個叫Distutils的工具模組可以幫我們輕鬆的解決這個問題，既然這樣，讓我們開始打包之旅吧。

要打包程式碼，首先你的確保你的程式碼得是個包。比如，你寫了一些功能的程式碼塊，為了方便引用，你就需要將程式碼變成一個包，下次需要使用的時候，直接引用這個包裡面的某個具體功能就好了。在Python中，要將這些程式碼變成包非常容易，你的這些功能的合集，可以用一個你覺得合適的名稱來命名，建立這個命名的資料夾，並在資料夾下建立一個__init__.py檔案，剩餘的就是將你這些程式碼放入到這個資料夾下面即可。整理成包的檔案結構大概像下面這樣：

somefunctions/
    |
    +-- __init__.py
    |
    +-- myscripts1.py
    |
    +-- mysscripts2.py
    |
    +-- mymorescripts.py
    |

somefunctions就是你包的名稱，下面my***.py的各種檔案就是你原有的各種程式碼模組。是不是很簡單就將自己的程式碼變成了包？確實很簡單，你這步就是新建一個資料夾，把檔案全放進去而已——哦，還有添加個__init__.py檔案（檔案內容可以為空）.

到這裡，我們已經有Python包了，如果不傳到PyPI上的話，你都可以直接用了，最直接的方法是將這個資料夾拷到你的專案目錄下，然後在專案程式碼裡，你大概就能引用它了：

當然，我們的目標是打包到PyPI上，而不是將這個包拷來拷去的，後面安裝一下，引用起來將更加的方便。

好了，既然要放到PyPI上，那麼我們就需要在上面的基礎上，在加點料。首先，我們需要調整下檔案的目錄結構，把上面的改成下面這個樣子：

somefunctions/
    |
    +-- somefunctions/
    .       |
    .       +-- __init__.py
    .       |
    .       +-- myscripts1.py
    .       |
    .       +-- mysscripts2.py
    .       |
    .       +-- mymorescripts.py
    .       |
    .
    |

就是將原來的目錄深移一層，資料夾名稱一樣即可。這步也不難吧。好吧，然後在到第一層的目錄下建立些特殊檔案，具體你可以看看下面這個檔案結構你就明白了：

somefunctions
    |
    +-- COPYING.txt
    |
    +-- README.txt
    |
    +-- setup.py
    |
    +-- somefunctions
    .       |
    .       +-- __init__.py
    .       |
    .       +-- myscripts1.py
    .       |
    .       +-- mysscripts2.py
    .       |
    .       +-- mymorescripts.py
    .       |
    .
    |
    +-- docs/
    |

哇，咋一看，變了好多啊，其實不多，解釋下：

TIPS:

1. COPYING.txt 就是授權檔案，裡面是你關於這個包的授權，比如：MIT license，那麼你裡面放入MIT License全文即可，當然，如果你不清楚這個，你完全可以不要這個檔案。
2. README.txt，這個檔案想必研發都應該清楚。如果有，儘量放些東西在這裡了，後面如果可能我們會用到它的。需要注意的是，Windows的回車和Linux不一樣，所以建議用Windows的好了。另外你也可以使用README.rst這類檔案表示（reStructuredText檔案，如果不清楚可以參看我前面幾篇文章：入門，Emacs快捷鍵）
3. setup.py，核心檔案，這裡面的內容馬上我們會講。
4. docs/，這個資料夾你放你的documents吧，不過要用心寫文件真是個難事，所以這個資料夾基本是不存在的——為自己的懶惰可恥一把。
5. 如果的包整個就一個檔案，那麼你也完全可以不用考慮再建一層目錄了，直接放到README檔案所在目錄下就可以了，雖然我不建議這麼操作。

好了，檔案都建好了，再來進化下，我們為setup.py填上內容，讓我們的setup.py真正的能用起來，注意哦，前面沒distutils什麼事情，他的作用在這裡哦。放出一個setup.py的Demo：