adk-setup

ADK Python の開発環境のセットアップ

uv で管理する仮想環境にすべての依存関係エクストラをインストールし、pre-commit フックを設定して、ユニットテストがすべて成功する adk-python のチェックアウトをセットアップします。

前提条件

1. Python。 ADK は 3.11 から 3.15 までをサポートしています（pyproject.toml の requires-python = ">=3.11"）。ここでは、リポジトリ独自のツールでデフォルトに設定されているバージョンである 3.11 を使用します。

   python3 --version
   

2. uv。 依存関係は pyproject.toml で宣言されています。以下の uv sync の手順で、このリポジトリでは無視されるローカルの uv.lock が作成されます。ロックファイルを必要とする tox のロックランナーを使う前に、この手順を実行してください。

   uv --version
   

インストールされていない場合は、次の手順でインストールします。

curl -LsSf https://astral.sh/uv/install.sh | sh

セットアップ

以下の手順は、リポジトリのルートディレクトリから実行します。

1. 仮想環境を作成して有効化します。

   uv venv --python "python3.11" ".venv"
   source .venv/bin/activate
   

2. すべての依存関係エクストラをインストールします。

   uv sync --all-extras
   

   --all-extras を指定すると、test と dev のエクストラがインストールされます。デフォルトの依存関係だけを同期すると、pytest とリンターがインストールされません。

3. pre-commit と tox をスタンドアロンツールとしてインストールします。

   uv tool install pre-commit
   uv tool install tox --with tox-uv
   

   どちらも dev エクストラに含まれています。uv ツールとしてインストールすると PATH に追加されるため、仮想環境を有効化しなくても、git フックと複数バージョンでのテスト実行が可能になります。

4. addlicense をインストールします（任意、Go が必要です）。

   go install github.com/google/addlicense@latest
   

   インストールしていない場合、pre-commit フックは Warning: addlicense not installed, skipping と表示して処理を続行します。そのため、Go ツールチェーンがなくてもセットアップは妨げられません。ライセンスヘッダーの不足は CI で検出されます。

5. git フックをインストールします。

   pre-commit install
   

   コミット時に、フックは isort、pyink、mdformat で自動フォーマットを行い、その後 ruff、addlicense、codespell、およびリポジトリ独自のコンプライアンスチェックを実行します。

6. 環境を確認します。

   pytest tests/unittests -n auto
   

   ここですべて成功すれば、セットアップは完了です。-n auto には pytest-xdist が必要です。これは手順 2 で test エクストラとともにインストールされます。

主なコマンド

タスク	コマンド
ユニットテストを実行する	pytest tests/unittests
ユニットテストを並列実行する	pytest tests/unittests -n auto
テストファイルを 1 つ実行する	pytest tests/unittests/agents/test_base_agent.py
サポート対象のすべての Python でテストを実行する	tox（uv が不足しているインタープリターをダウンロードします）
すべてをフォーマットして lint する	pre-commit run --all-files
Web UI を起動する	adk web {agents_dir}
CLI からエージェントを実行する	adk run {agent_dir}
wheel をビルドする	uv build