weatherlink-mcp

🚀 Devcontainer Python 开发环境模板

本仓库借助 Devcontainer 技术，为 Python 项目开发环境的搭建提供了便捷途径。它预先配置了所需工具和依赖项，能带来一致的开发体验。

🚀 快速开始

按照以下步骤使用此开发环境：

1. 克隆仓库：

   git clone https://github.com/tomohiroJin/devcontainer-python.git -b feature/add-reference
   cd devcontainer-python
   

2. 用 VS Code 打开项目：

   code .
   

3. 当 Devcontainer 提示重新打开项目时，请按照指示操作。
4. 运行测试以验证环境：

   pytest
   

✨ 主要特性

• 使用 Python 3.11 进行开发。
• 预先安装好的工具：
  • pytest（测试框架）
  • flake8（代码检查工具）
  • black（代码格式化工具）
• Devcontainer 提供一致性的开发环境。
• 基于 Docker 的隔离环境，确保配置一致性。
• 配备了示例代码和参考文档：
  • 包含 Python 的基础语法和主要的设计模式。
  • 提供详细的测试案例和实现。

💻 使用示例

运行测试

使用pytest来执行项目的测试。可以通过多种方式运行测试：

执行所有测试

pytest

指定文件的测试

只想运行特定的测试文件，可以指定文件路径：

pytest tests/reference/basic/test_conditions.py

查看详细信息

使用-v选项查看每个测试的详细信息：

pytest -v

运行特定测试用例

通过-k选项匹配测试名称来运行特定用例：

pytest -k test_name

只显示失败测试

使用--lf选项仅显示未通过的测试：

pytest --lf

检查代码质量

使用flake8检查代码的质量和风格：

flake8 src/

格式化代码

使用black对 Python 代码进行格式化：

对所有文件进行格式化

black .

查看格式化建议而不实际修改

black --check .

指定特定文件或目录

black src/fizzbuzz/fizzbuzz.py

📚 详细文档

此项目包含了学习和参考 Python 基础知识及主要设计模式的样例代码，涵盖以下内容：

• Python 的基本语法
• 主要的设计模式
• 详细的测试案例

🔧 技术细节

通过编辑.devcontainer/devcontainer.json文件，可以进一步定制你的开发环境。例如，可以根据需要调整 Python 版本或安装额外的工具。

📄 许可证

本项目遵循 MIT 许可证。