article
README
🚀 ODS Jaquel MCP开发容器
本开发容器为ODS Jaquel MCP项目提供了一个完全配置好的Python 3.13开发环境。
✨ 主要特性
- Python 3.13:
pyproject.toml中指定的最新稳定Python版本。 - Git集成:预安装,用于版本控制。
- VS Code扩展:包含Pylance、调试器、Black格式化器和Ruff lint工具等Python开发工具。
- 预配置环境:
- 项目以可编辑模式安装(
pip install -e .)。 - 开发依赖已安装(
pip install -e '.[dev]')。 - 已配置Python格式化和代码检查。
- 已配置Pytest测试。
- 项目以可编辑模式安装(
🚀 快速开始
1. 在开发容器中打开项目
- 在VS Code中打开项目文件夹。
- 运行:Dev Containers: Reopen in Container(Cmd/Ctrl + Shift + P)。
2. 验证安装
python --version
python -m pytest tests/ -v
3. 运行服务器
python -m odsbox_jaquel_mcp
4. 构建软件包
python -m build
📚 详细文档
开发工作流程
- 格式化代码:使用
black .或VS Code的“格式化文档”功能。 - 代码检查:运行
flake8 .。 - 类型检查:运行
mypy odsbox_jaquel_mcp/。 - 运行测试:按Ctrl + Shift + D打开测试资源管理器,或运行
pytest tests/ -v。 - 调试:设置断点并使用VS Code调试器(F5)。
SSH访问
本地SSH密钥以只读方式挂载,用于Git身份验证。这允许在容器内无缝进行Git操作。
故障排除
- 端口转发:如果要连接到ODS服务器,请在VS Code中使用端口转发。
- 依赖项:如果需要额外的软件包,请运行
pip install -r requirements.txt。 - 重建容器:关闭开发容器,然后使用Dev Containers: Rebuild Container进行重建。
微信扫一扫