MCP Python Server

🚀 Pythonプロジェクトテンプレート

これは、任意のPythonプロジェクトに適用可能なテンプレートリポジトリです。以下の開発ツールが用意されています。

• ruff：flake8、isort、pyupgrade のような多くのエラーやスタイル問題を検出します。
• black：コードを自動的に整形します。

これらのチェックは、pre-commit ライブラリを使用してプリコミットフックとして実行されます。

プロジェクトには、pytest を用いたテストと、カバレッジを測定する pytest-cov プラグインが含まれています。

すべてのチェックとテストは、各プルリクエストとメインブランチへのマージに対して、Github Actions上で実行されます。

このリポジトリはPython 3.11用に設定されています。バージョンを変更するには、以下の手順を実行します。

1. .devcontainer/devcontainer.json の image パラメータを変更します（事前に構築されたDockerイメージのリストについては、https://github.com/devcontainers/images/tree/main/src/python を参照）。
2. .precommit-config.yaml の設定オプションを変更します。
3. .github/workflows/python.yaml のバージョン番号を変更します。

🚀 クイックスタート

✨ 主な機能

• ruff を使用してコードのエラーやスタイル問題を検出。
• black でコードを自動整形。
• pre-commit を用いたプリコミットフックによるチェック。
• pytest と pytest-cov を使ったテストとカバレッジ測定。
• Github Actions上での自動テスト実行。

📦 インストール

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

💻 使用例

基本的な使用法

このリポジトリは、非常にシンプルな main.py とそれに対するテストファイル tests/main_test.py から始まります。自分のコードに置き換え、必要に応じてさらにファイルを追加することで、コードの複雑さを増やすことができます。 テストを実行する準備ができたら、以下のコマンドを実行します。

python3 -m pytest

📚 ドキュメント

文件分解

以下は、いくつかのファイル/フォルダの簡単な説明です。

詳細な説明については、this blog post を参照してください。

🔎 問題の発見や改善提案

問題を発見した場合や改善提案がある場合は、イシューを投稿してこのテンプレートリポジトリの改善にご協力ください！