🚀 Python项目模板

这是一个适用于任意Python项目的模板仓库，配备了一系列实用的开发工具，能够有效提升开发效率和代码质量。

🚀 快速开始

使用devcontainer

此仓库包含一个devcontainer（Docker化的Python环境）。若在Codespaces中打开，会自动初始化devcontainer；在本地使用时，可在VS Code中安装Dev Containers扩展来打开。

不使用devcontainer

若无法或不想使用devcontainer，需先创建虚拟环境：

python3 -m venv .venv
source .venv/bin/activate

然后安装开发工具和预提交钩子：

python3 -m pip install --user -r requirements-dev.txt
pre-commit install

✨ 主要特性

• 代码检查：使用 ruff 识别众多错误和风格问题（如 flake8、isort、pyupgrade），并使用 black 自动格式化代码。这些检查通过 pre-commit 库作为预提交钩子执行。
• 测试与覆盖度测量：项目采用 pytest 进行测试，搭配 pytest-cov 插件测量覆盖范围。
• 自动化运行：所有检查和测试均在Github Actions上运行，针对每个拉取请求和对主分支的合并。

📦 安装指南

此仓库设置为Python 3.11。若要更改版本，需进行以下操作：

1. 更改 .devcontainer/devcontainer.json 中的 image 参数（参见 https://github.com/devcontainers/images/tree/main/src/python 获取预构建的Docker镜像列表）
2. 更改 .precommit-config.yaml 中的配置选项
3. 更改 .github/workflows/python.yaml 中的版本号

💻 使用示例

添加代码和测试

此仓库初始包含一个简单的 main.py 和针对它的测试文件 tests/main_test.py。您需将其替换为自己的代码，并可根据需求添加更多文件以增加代码复杂性。

运行测试

准备好运行测试时，执行以下命令：

python3 -m pytest

📚 详细文档

文件分解

以下是部分文件/文件夹的简要说明：

如需更详细的说明，请参阅 this blog post。

🔧 技术细节

本项目使用了 ruff、black、pre-commit、pytest 和 pytest-cov 等工具。ruff 可以快速识别代码中的错误和风格问题，black 能自动格式化代码，保证代码风格的一致性。pre-commit 作为预提交钩子，确保在代码提交前进行必要的检查。pytest 用于编写和运行测试用例，pytest-cov 则用于测量代码的覆盖范围，帮助开发者了解测试的完整性。

📄 反馈与建议

🔎 若发现问题或有改进建议，可通过提交问题帮助改进这个模板仓库！