Skip to main content
AI/MLgoogle

adk-setup

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.

Stars
19,929
Source
google/adk-python
Updated
2026-05-30
Slug
google--adk-python--adk-setup
View on GitHubRaw SKILL.md

// install — copy + paste into any project

mkdir -p .claude/skills && curl -fsSL https://raw.githubusercontent.com/google/adk-python/HEAD/.agents/skills/adk-setup/SKILL.md -o .claude/skills/adk-setup.md

Drops the SKILL.md into .claude/skills/adk-setup.md. Works with Claude Code, Cursor, and any agent that loads SKILL.md files from .claude/skills/.

Set up the local development environment for ADK Python.

Prerequisites

Check the following before proceeding:

  1. Python 3.11+

    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:

  1. Create and activate a virtual environment:

    uv venv --python "python3.11" ".venv"
    source .venv/bin/activate
    
  2. Install all dependencies for development:

    uv sync --all-extras
    
  3. Install development tools:

    uv tool install pre-commit
    uv tool install tox --with tox-uv
    
  4. 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."

  5. Set up pre-commit hooks:

    pre-commit install
    
  6. 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