这是一个Python模板。
项目描述
python-template
这是一个有偏见的Python模板。
用法
本项目使用
- poetry 进行依赖管理和打包。
- poethepoet 运行任务。
- pytest 进行测试。
- black 进行自动格式化。
- mypy 进行静态类型检查。
- pre-commit 进行git钩子。
- ruff 进行代码风格检查。
- mkdocs 进行文档编写。
在继续之前，请确保已安装相关依赖项。
安装依赖项
poetry install
运行测试
poetry run poe test
GitHub Actions设置
验证工作流程
CodeCov.io
工作流程会自动设置以将覆盖率报告传递到CodeCov.io。您必须在存储库设置中设置CODECOV_TOKEN密钥。否则，请在.github/workflows/validate.yaml文件中禁用该常规操作。
发布工作流程
确保您的存储库设置中启用了讨论，或者从.github/workflows/publish.yaml文件中删除discussion_category_name。
PyPi
工作流程已自动设置为发布到PyPi。您必须在仓库设置中设置POETRY_PYPI_TOKEN_PYPI密钥。否则，请在.github/workflows/publish.yaml文件中禁用此常规操作。
