好不容易碼了個 python 項目，是不是很興奮？那麼怎麼把這個項目發出去讓大家看到呢？本文作者寫了一份在 GitHub 上釋出 python 包的簡單分步指南。
選自 medium，作者：Gabriel Lerner、Nathan Toubiana，機器之心編譯，參與：陳韻瑩、張倩。
作者以 SciTime 項目（一個對算法訓練時間進行估計的包）的釋出為例，詳細解釋了釋出的每個步驟。
注意：本文假設你在 GitHub 上已經有一個想要打包和釋出的項目。
第 0 步：擷取項目許可證
在做其他事之前，由于你的項目要開源，是以應該有一個許可證。擷取哪種許可證取決于項目包的使用方式。開源項目中一些常見許可證有 MIT 或 BSD。
第 1 步：讓你的代碼準備就緒
要将項目進行打包，你需要做一些預備工作：讓你的項目結構正确就位。通常情況下，項目庫的根目錄包含一個以項目名稱命名的檔案夾，項目的核心代碼應該位于此檔案夾中。在這個檔案夾之外是運作和建構包（測試、文檔等）所需的其他代碼。
核心檔案夾應包括一個（或多個）子產品和一個 __init__.py 檔案，該檔案包含你希望讓終端使用者通路的類/函數。此檔案還可以包含包的版本，以便于終端使用者通路。
理想情況下，應使用 logging 包來設定合理的日志記錄系統（而不是用 prints 輸出）。
理想情況下，應将你的核心代碼配置設定到一個或多個類中。
from .estimate import Estimator
以__init__.py 為例，如果 Estimator 是終端使用者将會通路的類（該類在 estimate.py 檔案中定義）
import logging
class LogMixin(object):
@property
def logger(self):
name = '.'.join([self.__module__, self.__class__.__name__])
FORMAT = '%(name)s:%(levelname)s:%(message)s'
logging.basicConfig(format=FORMAT, level=logging.DEBUG)
logger = logging.getLogger(name)
return logger
以日志系統為例：LogMixin 類可以在其他任何類中使用
第 2 步： 使用打包工具建立 setup.py
在你的項目有了一套結構之後，你應該在項目庫的根目錄下添加 setup.py 檔案。這有助于所有釋出和版本維護過程的自動化。以下是 setup.py 的例子（源代碼：https://github.com/nathan-toubiana/scitime/blob/master/setup.py）。
from setuptools import setup
from os import path
DIR = path.dirname(path.abspath(__file__))
INSTALL_PACKAGES = open(path.join(DIR, 'requirements.txt')).read().splitlines()
with open(path.join(DIR, 'README.md')) as f:
README = f.read()
setup(
name='scitime',
packages=['scitime'],
description="Training time estimator for scikit-learn algorithms",
long_description=README,
long_description_content_type='text/markdown',
install_requires=INSTALL_PACKAGES,
version='0.0.2',
url='http://github.com/nathan-toubiana/scitime',
author='Gabriel Lerner & Nathan Toubiana',
author_email='[email protected]',
keywords=['machine-learning', 'scikit-learn', 'training-time'],
tests_require=[
'pytest',
'pytest-cov',
'pytest-sugar'
],
package_data={
# include json and pkl files
'': ['*.json', 'modelsscitime_data.py
*/setup.py
.coveragerc 檔案示例
第 4 步：标準化文法和代碼風格
你還需要確定你的代碼遵循 PEP8 準則（即具有标準樣式并且文法正确）。同樣，有很多工具可以幫助你解決。這裡我們用了 flake8。
第 5 步：建立一個合理的文檔
現在你的項目已經測試過了，結構也很好了，是時候添加一個合理的文檔。首先是要有一個好的 readme 檔案，它會在你的 Github 項目庫的根目錄上顯示。完成後，加上以下幾點會更好：
由于 readme 檔案應該相當綜合，是以通常會有一個更詳細的文檔。你可以用 sphinx 來完成，然後在 readthedocs 上管理文檔。與文檔相關的檔案通常放在 docs/檔案夾中。sphinx 和 readthedocs 相關教程：https://docs.readthedocs.io/en/stable/intro/getting-started-with-sphinx.html。包含标簽和說明的項目庫示例
第 6 步：建立持續內建
此時，你的項目離釋出就緒不遠了。但是，在每次送出之後，必須更新文檔、運作測試以及檢查樣式和覆寫率似乎有點難以應付。幸運的是，持續內建（CI）可以幫助你完成。你可以在每次送出之後使用 GitHub 的 webhook 來自動執行所有的這些操作。以下是我們在 SciTime 中使用的一套 CI 工具：對于運作測試，我們使用了 travis ci 和 appveyor（用于 Windows 平台上的測試）。對于 Travis CI，除了在項目庫上設定 webhook 之外，你還必須建立一個.travis.yml 檔案，在該檔案中，你不僅可以運作測試，還可以上傳更新的覆寫率輸出以及檢查樣式和格式。通過建立 appveyor.yml 檔案，appveyor 也可以這樣做。
codecov 和 readthdocs 也有專用的 webhook
language: python
python:
- "3.6"
# command to install dependencies
install:
- pip install -r requirements.txt
- pip install flake8
- pip install pytest-cov
- pip install codecov
# command to run tests
script:
- python -m pytest --cov=scitime
- ./build_tools/flake_diff.sh
after_success:
- codecov
.travis.yml 檔案的示例：請注意，每次送出，測試都需要與檢查測試覆寫率一起進行。但還有一個 flake8 檢查（邏輯則在 flake_diff.sh 檔案中定義：https://github.com/nathan-toubiana/scitime/blob/master/build_tools/flake_diff.sh）
environment:
matrix:
- PYTHON: "C:\\Python36-x64"
install:
# We need wheel installed to build wheels
- "%PYTHON%\\python.exe -m pip install -r requirements.txt"
- "%PYTHON%\\python.exe -m pip install pytest==3.2.1"
build: off
test_script:
- "%PYTHON%\\python.exe -m pytest"
appveyor.yml 檔案示例：這裡我們隻運作測試
這将使更新項目庫的整個過程更加容易。內建 webhook 的送出曆史記錄示例
第 7 步：建立你的第一個 release 和 publication
此時，你即将釋出的包應與以下類似：
your_package/
__init__.py
your_module.py
docs/
tests/
setup.py
travis.yml
appveyor.yml
.coveragerc
.codecov.yml
README.md
LICENSE
.github/
CODE_OF_CONDUCT.md
CONTRIBUTING.md
PULL_REQUEST_TEMPLATE.md
ISSUE_TEMPLATE/
現在可以釋出了！首先要做的是在 GitHub 上建立你的第一個 release——這是為了在給定的時間點跟蹤項目的狀态，每次版本更改時都需要建立新的 release。建立步驟：https://help.github.com/en/articles/creating-releases。
完成後，唯一要做的就是釋出包。釋出 python 包最常見的平台是 PyPI 和 Conda。以下我們将描述如何用兩者釋出：對于 PyPI，首先需要建立一個帳戶，然後用 twine 執行一些步驟：https://realpython.com/pypi-publish-python-package/。這應該相當簡單，而且 Pypi 還提供了一個可以在實際部署之前使用的測試環境。PyPI 總體上包括建立源代碼（python setup.py sdist）并使用 twine（twine upload dist/*）來上傳。完成後，應該有一個與你的包對應的 PyPI 頁面，并且任何人都應該能夠通過運作 pip 指令來安裝你的包。
對于 Conda，我們推薦通過 conda forge 來釋出你的包，conda forge 是一個社群，幫助你通過 conda 管道釋出和維護包。你可以按照以下步驟将包添加到社群：https://conda-forge.org/#add_recipe，然後你會被添加到 conda forge Github 組織中，并能夠非常輕松地維護你的包，然後任何人都可以通過運作 conda 指令來安裝你的包。
完成！
現在，你的包應該已經發出去，并且任何人都可以使用了！雖然大部分工作都完成了，但是你仍然需要維護你的項目，你需要進行一些更新：這大體上意味着每次進行重大更改時都要更改版本，建立新的 release，并再次執行第 7 步。
有關 Scitime 的詳細資訊參見：