adk-setup

name	adk-setup
description	Set up a local development environment for the ADK Python project. Use when the user wants to get started developing, set up their environment, install dependencies, or prepare for contributing.
disable-model-invocation	true

Set up the local development environment for ADK Python 2.x.

Before selecting versions or commands, read ../../docs/python-adk-2.md.

Prerequisites

Check the following before proceeding:

1. Python 3.10+

   python3 --version
   

2. uv package manager (required — do not use pip/venv directly)

   uv --version
   

   If not installed:

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

Setup Steps

Run these commands from the project root:

3. Create and activate a virtual environment:

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

4. Install all dependencies for development:

   uv sync --all-extras
   

   For a new ADK app without a checked-in pyproject.toml, start from the current ADK 2.x package:

   uv add "google-adk>=2.3.0,<3"
   

5. Install development tools:

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

6. Install addlicense (requires Go):

   go version && go install github.com/google/addlicense@latest
   

   [!NOTE] If Go is not installed, tell the user: "Go is required for the addlicense tool. Please install Go from https://go.dev/dl/ and then re-run the adk-setup skill to complete the setup."

7. Set up pre-commit hooks:

   pre-commit install
   

8. Verify everything works by running tests locally:

   pytest tests/unittests -n auto
   

Key Commands Reference

Task	Command
Run unit tests (Fast)	pytest tests/unittests
Run tests across all Python versions	tox
Format codebase	pre-commit run --all-files
Run tests in parallel	pytest tests/unittests -n auto
Run specific test file	pytest tests/unittests/agents/test_llm_agent.py
Launch web UI	adk web path/to/agents_dir
Run agent via CLI	adk run path/to/my_agent
Build wheel	uv build