套件與模組層級的文件能幫助使用者理解並瀏覽你的套件。
在本練習中,你將為 impyrial 套件撰寫文件。請特別留意這份文件,你會在整門課程中持續使用這個套件,了解各部分的用途很值得。
impyrial
注意:你可以按一下編輯器左側以紅色標示的圖示,開啟或關閉資料夾與檔案總覽。
本練習屬於課程
將理論付諸實踐,立即體驗我們的互動練習
把你已經寫好的指令碼轉成套件,為你的套件開個頭。你會建立一個簡單的套件,並可在自己的電腦上使用。
當前練習
讓你的套件可供你自己與他人安裝。在本章中,你會學到如何處理相依套件、撰寫 README,以及加入授權條款。你也會完成將套件發佈到 PyPI——Python 套件的主要家園——所需的全部步驟。
把你的套件提升到專業水準。你將學會使用 pytest 防止錯誤、用 tox 測試套件是否能在多個 Python 版本下運作,以及用 flake8 維持良好的程式風格。
更快速地建立你的套件。在最後一章中,你會學到如何使用 cookiecutter 產生套件所需的各種支援檔案、利用 Makefile 簡化新版本釋出流程,並認識最後幾個能吸引使用者與貢獻者的必要檔案。