SuperAPI AI 工具集

adk-setup

编程与开发

查看项目

更新于 10-15 21:53

技能介绍

用途:在 adk-python 仓库的本地克隆中建立可直接开发的 ADK Python 环境,包含 uv 管理的虚拟环境、全部依赖 extra、pre-commit 钩子,以及通过的单元测试。

前提:Python 需 3.11–3.14(pyproject.toml 要求 >=3.11),步骤默认用 3.11。可用 python3 --version 检查。需要 uv,依赖声明在 pyproject.toml;uv sync 会生成本地 uv.lock,仓库忽略该文件,须在 tox 前执行,因为 tox 的 lock runner 需要它。缺失时安装:curl -LsSf https://astral.sh/uv/install.sh | sh。

安装步骤(在仓库根目录执行):

  1. 创建并激活虚拟环境:uv venv --python "python3.11" ".venv",随后 source .venv/bin/activate。
  2. 安装全部依赖 extra:uv sync --all-extras;仅同步默认依赖不会装上 pytest 与 linters。
  3. 以独立工具安装 pre-commit 与 tox:uv tool install pre-commit;uv tool install tox --with tox-uv。二者也在 dev extra 中,装为 uv 工具可放入 PATH,便于 git 钩子和多版本测试无需激活 venv 即可运行。
  4. 可选安装 addlicense(需 Go):go install github.com/google/addlicense@latest;未安装时钩子会输出 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,由测试 extra 提供。

常用命令:单元测试 pytest tests/unittests;并行 pytest tests/unittests -n auto;单个文件 pytest tests/unittests/agents/test_base_agent.py;全部受支持 Python 版本 tox(uv 自动下载缺失解释器);格式化与检查 pre-commit run --all-files;启动 Web UI adk web {agents_dir};CLI 运行智能体 adk run {agent_dir};构建 wheel uv build。

限制:本文仅涉及本地开发环境搭建,未提供目标平台、收费或托管服务信息。