Python project template

基本能力

产品定位

mcp-python-server 是一个 Python 项目模板，适用于需要快速启动 Python 项目的开发者。

核心功能

• 代码质量检查：使用 ruff 进行错误和风格检查（包括 flake8、isort、pyupgrade）。
• 代码自动格式化：使用 black 自动格式化代码。
• 测试框架：集成 pytest 和 pytest-cov 插件，用于测试和覆盖率测量。
• 预提交钩子：使用 pre-commit 库在提交前自动运行检查和格式化。
• GitHub Actions：在每次拉取请求和合并到主分支时自动运行检查和测试。

适用场景

• 快速启动新的 Python 项目。
• 需要集成代码质量检查和自动化测试的项目。
• 使用 GitHub Actions 进行持续集成的项目。

工具列表

• ruff：代码质量检查工具。
• black：代码自动格式化工具。
• pytest：测试框架。
• pytest-cov：测试覆盖率测量插件。
• pre-commit：预提交钩子管理工具。

常见问题解答

• 如何更改 Python 版本？
• 修改 .devcontainer/devcontainer.json 中的 image 参数。
• 修改 .precommit-config.yaml 中的配置选项。
• 修改 .github/workflows/python.yaml 中的版本号。

使用教程

使用依赖

• 安装 Python 3.11。
• 安装 VS Code 和 Dev Containers 扩展（如果使用 devcontainer）。

安装教程

使用 devcontainer

1. 在 Codespaces 中打开项目，devcontainer 会自动初始化。
2. 本地使用 VS Code 打开项目，确保已安装 Dev Containers 扩展。

不使用 devcontainer

1. 创建虚拟环境： python3 -m venv .venv source .venv/bin/activate
2. 安装开发工具和预提交钩子： python3 -m pip install --user -r requirements-dev.txt pre-commit install

调试方式

1. 运行测试： python3 -m pytest
2. 检查代码质量和格式化： pre-commit run --all-files

许可证

该项目遵循 MIT 开源许可条款，请参阅 MIT 了解完整条款。