adk-setup

Set up an ADK Python development environment with uv, pre-commit, tox, and pytest.

21.1k|3.8k|Updated Apr 1, 2025
One-click install
npx skills add https://github.com/google/adk-python --skill adk-setup
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: adk-setup
Source: https://github.com/google/adk-python/tree/main/.agents/skills/adk-setup
Command: npx skills add https://github.com/google/adk-python --skill adk-setup

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

The adk-setup skill solves the problem of getting blocked during local development by missing prerequisites, unclear setup steps, or inconsistent tooling versions for the ADK Python project.

Core Features & Use Cases

  • Environment preparation: Verifies Python 3.11+ and the required uv package manager before installing anything.
  • Reproducible dependency installation: Creates a virtual environment and installs all development dependencies with uv sync.
  • Developer workflow enablement: Installs formatting/linting tooling (pre-commit), test runners (pytest/tox), and required auxiliary tooling (addlicense via Go) to support contribution-quality changes.

Use Case: Prepare a fresh machine or clean checkout for contributing to google-adk by setting up the virtual environment, installing dev dependencies and tools, and validating the setup by running unit tests.

Quick Start

Run the adk-setup skill to configure the ADK Python project’s local development environment from the repository root.

Frequently Asked Questions about adk-setup

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I set up a local development environment for the ADK Python project?

To set up the ADK local development environment, you need Python 3.11+ and the uv package manager to create a virtual environment and sync dependencies.

What tools are required for ADK contribution and testing?

ADK contribution requires installing pre-commit for formatting, tox and pytest for testing, and Go to install the addlicense prerequisite tool.

Can I use a Python version below 3.11 for ADK development setup?

No, the ADK development environment setup explicitly requires Python 3.11 or higher to validate and sync dependencies correctly using uv.

How do I validate my ADK development environment after installing dependencies?

You validate the ADK development environment by running unit tests with pytest after syncing all dev dependencies and installing required tools like tox.

Why does setting up the ADK dev environment require the uv package manager?

The uv package manager is required for reproducible dependency installation, creating the virtual environment and syncing all development dependencies efficiently.

What is the best way to unblock ADK contribution on a fresh machine?

The best way to unblock ADK contribution on a fresh machine is running an automated setup that verifies Python 3.11+, installs uv dependencies, configures pre-commit, and runs pytest validation.