bootstrap python package

Bootstrap-Python包裝

此模板存儲庫提供了製定python軟件包的樣板。它具有以下所有功能：

• 使用托克斯和pytest測試套件
• 使用mypy打字
• 使用ruff（使用黑色代碼樣式和強盜安全規則）的覆蓋，安全性和代碼格式
• 與Codeclimate集成以進行代碼質量和覆蓋範圍檢查
• CI管道支持：
  • 針對多個Python版本進行測試
  • 釋放PYPI
  • 使用MKDOCS的GitHub頁面文檔
• Pycharm個人資料基本配置

如何使用此存儲庫模板創建一個新軟件包

• 使用此模板創建您的GitHub存儲庫。 （大綠色Use this template按鈕）
• 重命名bootstrap_python_package目錄
• 搜索並替換所有發生的bootstrap-python-package和bootstrap_python_package
• 使用以下值在PYPI上配置已待定的受信任的發布者：
  • PYPI項目名稱：GitHub存儲庫名稱（在這種情況下bootstrap-python-package ）
  • 所有者：GitHub存儲庫所有者（在這種情況下febus982 ）
  • 存儲庫名稱：GitHub存儲庫名稱（在這種情況下bootstrap-python-package ）
  • 工作流名稱： release.yml
• 創建一個名為CODECLIMATE_REPORTER_ID的github動作（在url https://github.com/GITHUB_NAME_OR_ORGANIZATION/GITHUB_REPOSITORY/settings/secrets/actions ）包含CodeClimate Reporter ID（您可以在AT https://codeclimate.com/repos/YOUR_REPO_ID/settings/test_reporter ）。如果您不想使用codeclimate，則只需刪除workflows/python-quality.yml 。
• 更新README.md中的徽章！ （Check Shields.io以獲取額外的徽章）
• 更新IDE設置中的Pycharm版權配置文件：編輯器|版權|版權配置文件（如果要使用）
• 設置本地開發：
  • 克隆存儲庫
  • 安裝詩歌pip install poetry
  • 以make dev-dependencies
  • （可選）強烈建議安裝預簽名並運行pre-commit install以便在git commit中自動執行格式和覆蓋。
• 設置GitHub頁面（此需要本地開發設置）：
  • 初始文檔分支機構poetry run mike deploy dev latest --update-aliases --push
  • 將GitHub頁面配置為從gh-pages分支部署（在url https://github.com/GITHUB_NAME_OR_ORGANIZATION/GITHUB_REPOSITORY/settings/pages ）
  • 在GH https://github.com/GITHUB_NAME_OR_ORGANIZATION/GITHUB_REPOSITORY/settings/environments gh-pages環境中添加main分支和v*.*.*

重要的是：存儲庫被配置為在測試PYPI存儲庫中部署。強烈建議在測試PYPI存儲庫中創建項目並測試部署管道。當您對結果滿意時，請在官方PYPI存儲庫中創建項目，然後刪除workflows/release.yml中的標記線。

包裝釋放

此設置使用詩歌動態反复。這意味著不必在代碼中提交版本，但是CI管道將從git標籤中推斷出來。

要發布新版本，只需在GitHub存儲庫中創建新版本並在：

• 將Python軟件包構建和部署到PYPI
• 將文檔的新版本構建和部署到GitHub頁面

重要：默認配置需要發布名稱和標籤以遵循章程vX.XX （語義版本啟動之前，請先使用小寫v ）。它將在PYPI上發布正確的版本，省略v （即v1.0.0 ）將發布1.0.0 ）。

可以自定義這種格式，請參閱詩歌觸手可及的文檔

開發命令

在開發過程中使用的所有常見命令都可以使用Make Targets運行：

• make dev-dependencies ：安裝DEV要求
• make update-dependencies ：更新開發要求
• make fix ：運行代碼樣式和絨毛自動修復（如有可能）
• make test ：針對系統python版本運行測試套件
• make check ：針對所有可用的Python版本，代碼樣式和棉絨檢查進行測試
• make type ， make format ， make lint ， make bandit ：運行相關檢查
• make docs ：在本地渲染MKDOCS網站