cookiecutter-sicheng-pythonic-pkg

一个使用 Cookiecutter 工具生成 Python 工程化项目的模板。

• 文档: https://cookiecutter-sicheng-pythonic-pkg.readthedocs.io/en/latest/
• GitHub: https://github.com/sicheng1806/cookiecutter-sicheng-pythonic-pkg

特性

• 使用uv作为项目虚拟环境管理工具
• 配置GitHub Actions
• 使用ruff作为格式风格审查工具
• 使用pytest作为测试框架
• 使用sphinx作为文档生成工具
• 使用pre-commit配置git commit执行前的自动化审查脚本
• 使用nox作为自动化工具，并配置代码风格审查、测试、文档构建脚本
• 使用typos作为源代码拼写错误检查工具

工具的具体使用方法可以查看模板内的development.md 文档。

如何使用

1. 安装cookiecutter
2. 使用模板:

cookiecutter https://github.com/sicheng1806/cookiecutter-sicheng-pythonic-pkg

项目结构

my_project/
├── docs
│   ├── conf.py
│   ├── development.md
│   ├── doc_requirements.txt
│   ├── index.md
│   ├── _static
│   └── _templates
├── LICENSE
├── noxfile.py
├── pyproject.toml
├── README.md
├── src
│   └── my_project
│       └── __init__.py
└── tests
    ├── conftest.py
    ├── __init__.py
    ├── settings.yml
    └── test_version.py

使用项目

具体查看development.md或者查看项目内docs/development.md文档。