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网站