adk-setup
Sets up a local ADK Python development environment in a git clone of the open-source adk-python repository: a uv virtual environment, all dependency extras, pre-commit hooks, and a first unit-test run. Runs only when explicitly requested, never on its own. Use when asked to set up, bootstrap, or repair a development checkout, install project dependencies, fix a missing or broken .venv, or prepare a machine for contributing a pull request. Don't use for debugging a running agent (use adk-debug), for commit and pull-request mechanics (use adk-git), or for re-running formatters on a checkout that is already set up (pre-commit run --all-files).
How do I install this agent skill?
npx skills add https://github.com/google/adk-python --skill adk-setupIs this agent skill safe to install?
- Gen Agent Trust Hubpass
This skill provides instructions for setting up a local development environment for the ADK Python project. It involves installing development tools like 'uv' and 'addlicense', as well as configuring a virtual environment and running initial tests. These actions are consistent with the skill's intended purpose of bootstrapping a developer workspace.
- Socketpass
No alerts
- Snykwarn
Risk: MEDIUM · 1 issue
What does this agent skill do?
ADK Python Development Setup
Set up a working adk-python checkout: a uv-managed virtual environment with
every dependency extra, pre-commit hooks, and a green unit-test run.
Prerequisites
-
Python. ADK supports 3.11 through 3.15 (
requires-python = ">=3.11"inpyproject.toml). These steps use 3.11, the version the repo's own tooling defaults to.python3 --version -
uv. Dependencies are declared in
pyproject.toml. Theuv syncstep below creates a localuv.lock, which this repository ignores. Run that step beforetox, whose lock runner requires the file.uv --versionInstall it if missing:
curl -LsSf https://astral.sh/uv/install.sh | sh
Setup
Run these from the repository root.
-
Create and activate the virtual environment:
uv venv --python "python3.11" ".venv" source .venv/bin/activate -
Install every dependency extra:
uv sync --all-extras--all-extrasis what pulls in thetestanddevextras. Syncing only the default dependencies leavespytestand the linters uninstalled. -
Install pre-commit and tox as standalone tools:
uv tool install pre-commit uv tool install tox --with tox-uvBoth are also in the
devextra; installing them as uv tools puts them on PATH so the git hook and multi-version test runs work without an activated venv. -
Install
addlicense(optional, requires Go):go install github.com/google/addlicense@latestWithout it the pre-commit hook prints
Warning: addlicense not installed, skippingand passes, so a missing Go toolchain does not block setup — CI catches missing license headers instead. -
Install the git hooks:
pre-commit installOn each commit the hooks auto-format with
isort,pyink, andmdformat, then runruff,addlicense,codespell, and the repo's own compliance checks. -
Verify the environment:
pytest tests/unittests -n autoA green run here is the success criterion for setup.
-n autoneedspytest-xdist, which arrives with thetestextra in step 2.
Key commands
| Task | Command |
|---|---|
| Run unit tests | pytest tests/unittests |
| Run unit tests in parallel | pytest tests/unittests -n auto |
| Run one test file | pytest tests/unittests/agents/test_base_agent.py |
| Run tests on every supported Python | tox (uv downloads any missing interpreters) |
| Format and lint everything | pre-commit run --all-files |
| Launch the web UI | adk web {agents_dir} |
| Run an agent from the CLI | adk run {agent_dir} |
| Build the wheel | uv build |
How can the creator link this skill?
Add the canonical catalog link to the repository README so users can inspect current installs and available audits. The publishing guide covers the complete discovery path.
<a href="https://skillzs.dev/skills/google/adk-python/adk-setup">View adk-setup on skillZs</a>