> ## Documentation Index
> Fetch the complete documentation index at: https://docs.veadk.xyz/llms.txt
> Use this file to discover all available pages before exploring further.

# Installation

## Prerequisites

* Python 3.10 or later.
* A Volcengine Ark API key for model calls, available from the [Volcengine Ark console](https://console.volcengine.com/ark).

## Install from PyPI

Install the VeADK version that matches this documentation:

```bash lines theme={null}
pip install "veadk-python==1.0.0"
```

## Optional dependency groups

Install only the groups required by your application. Multiple groups can share one pair of brackets, for example `veadk-python[extensions,eval]==1.0.0`.

| Group | Included capabilities |
| - | - |
| `extensions` | Redis, Cozeloop, LlamaIndex, OpenSearch, and Feishu integrations. |
| `database` | Redis, MySQL, VikingDB, and mem0 storage backends. |
| `eval` | DeepEval and Google ADK evaluation dependencies. |
| `a2ui` | A2UI support. |
| `pdf` | PDF page rendering and PNG encoding. |

For example, install the integrations group:

```bash lines theme={null}
pip install "veadk-python[extensions]==1.0.0"
```

The `speech` and `cli` groups are compatibility placeholders in 1.0.0 and do not add dependencies.

## Install from source

To develop against the 1.0.0 source, create an environment and install with [uv](https://docs.astral.sh/uv/):

```bash lines theme={null}
git clone https://github.com/volcengine/veadk-python.git
cd veadk-python
git checkout 1.0.0

uv venv --python 3.12
uv sync
uv pip install -e .
```

Add `--extra <name>` to `uv sync` for a specific optional group, or use `--all-extras` for every group.

After installation, follow the [quickstart](/productions/veadk/archives/1.0.0/en/get-started/quickstart) to run your first agent.
