MCP Python Server

🚀 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 則用於測量代碼的覆蓋範圍，幫助開發者瞭解測試的完整性。

📄 反饋與建議

🔎 若發現問題或有改進建議，可通過提交問題幫助改進這個模板倉庫！