Weatherlink MCP

🚀 Devcontainer Python 開発環境テンプレート

このリポジトリは、Devcontainer技術を利用して、Pythonプロジェクトの開発環境を簡単に構築する方法を提供しています。必要なツールと依存関係が事前に構成されており、一貫した開発体験を提供します。

✨ 主な機能

• Python 3.11 を使用した開発
• 事前にインストールされたツール：
  • pytest（テストフレームワーク）
  • flake8（コードチェックツール）
  • black（コードフォーマッター）
• Devcontainerによる一貫した開発環境の提供
• Dockerベースの隔離環境による設定の一貫性の確保
• サンプルコードとリファレンスドキュメントの提供
  • 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の基礎知識と主要な設計パターンを学習および参照するためのサンプルコードが含まれており、以下の内容がカバーされています：

• Pythonの基本構文
• 主要な設計パターン
• 詳細なテストケース

💻 使用例

基本的な使用法

1. テストの実行

pytestを使用して、プロジェクトのテストを実行します。いくつかの方法でテストを実行できます：

すべてのテストを実行

pytest

特定のファイルのテスト

特定のテストファイルのみを実行する場合は、ファイルパスを指定します：

pytest tests/reference/basic/test_conditions.py

詳細情報の表示

-vオプションを使用して、各テストの詳細情報を表示します：

pytest -v

特定のテストケースの実行

-kオプションを使用して、テスト名を指定して特定のケースを実行します：

pytest -k test_name

失敗したテストのみを表示

--lfオプションを使用して、不合格のテストのみを表示します：

pytest --lf

2. コード品質のチェック

flake8を使用して、コードの品質とスタイルをチェックします：

flake8 src/

3. コードのフォーマット

blackを使用して、Pythonコードをフォーマットします：

すべてのファイルをフォーマット

black .

実際に変更せずにフォーマットの提案を表示

black --check .

特定のファイルまたはディレクトリを指定

black src/fizzbuzz/fizzbuzz.py

🔧 カスタマイズ

.devcontainer/devcontainer.jsonファイルを編集することで、開発環境をさらにカスタマイズできます。例えば、Pythonのバージョンを調整したり、追加のツールをインストールしたりできます。

📄 ライセンス

このプロジェクトはMITライセンスに基づいています。