Python 簡易手冊
單元 72 - 發布套件
如果要在 PyPI 發布自己開發的套件 (package) 專案,依官方文件至少要提供以下的檔案架構
- packaging_tutorial/
-
- LICENSE
- pyproject.toml
- README.md
- src/
-
- example_package_YOUR_USERNAME_HERE/
-
- __init__.py
- example.py
- tests/
LICENSE 是此份專案的開放原始碼授權,如果不知道如何選擇開放原始碼授權,請參考以下連結
pyproject.toml 是專案的配置檔案,有關如何撰寫這份檔案,請參考以下官網連結
README.md 為專案的簡介說明文件,這方面完全自訂,請參考以下官網連結
src 資料夾為自行開發的套件,有關怎麼組織套件,請參考單元 69 - 套件。
tests 資料夾放的是專案測試檔案。
套件專案的檔案準備好之後,接下來還要用指令產生發布的套件並上傳,請參考官網文件後續的說明
其他細節請參考官網文件的說明。
參考資料
- https://packaging.python.org/en/latest/
- https://packaging.python.org/en/latest/tutorials/packaging-projects/