https://github.com/volcengine/veadk-python
An open-source kit for agent development, integrated the powerful capabilities of Volcengine.
https://github.com/volcengine/veadk-python
agent sdk volcengine
Last synced: about 1 month ago
JSON representation
An open-source kit for agent development, integrated the powerful capabilities of Volcengine.
- Host: GitHub
- URL: https://github.com/volcengine/veadk-python
- Owner: volcengine
- License: apache-2.0
- Created: 2025-08-01T22:21:20.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2026-02-03T13:50:42.000Z (5 months ago)
- Last Synced: 2026-02-03T16:36:33.487Z (5 months ago)
- Topics: agent, sdk, volcengine
- Language: Python
- Homepage: https://volcengine.github.io/veadk-python/
- Size: 65.2 MB
- Stars: 263
- Watchers: 1
- Forks: 47
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Volcengine Agent Development Kit
[](LICENSE)
[](https://deepwiki.com/volcengine/veadk-python)
An open-source kit for agent development, integrated the powerful capabilities of Volcengine.
For more details, see our [documents](https://volcengine.github.io/veadk-python/).
A [tutorial](https://github.com/volcengine/veadk-python/blob/main/veadk_tutorial.ipynb) is available by Jupyter Notebook, or open it in [Google Colab](https://colab.research.google.com/github/volcengine/veadk-python/blob/main/veadk_tutorial.ipynb) directly.
## Installation
### From PyPI
```python
pip install veadk-python
# install extensions
pip install veadk-python[extensions]
```
### Build from source
We use `uv` to build this project ([how-to-install-uv](https://docs.astral.sh/uv/getting-started/installation/)).
```bash
git clone ... # clone repo first
cd veadk-python
# create a virtual environment with python 3.12
uv venv --python 3.12
# only install necessary requirements
uv sync
# or, install extra requirements
# uv sync --extra database
# uv sync --extra eval
# uv sync --extra cli
# or, directly install all requirements
# uv sync --all-extras
# install veadk-python with editable mode
uv pip install -e .
```
## Configuration
We recommand you to create a `config.yaml` file in the root directory of your own project, `VeADK` is able to read it automatically. For running a minimal agent, you just need to set the following configs in your `config.yaml` file:
```yaml
model:
agent:
provider: openai
name: doubao-seed-1-6-250615
api_base: https://ark.cn-beijing.volces.com/api/v3/
api_key: # <-- set your Volcengine ARK api key here
```
You can refer to the [config instructions](https://volcengine.github.io/veadk-python/configuration/) for more details.
## Have a try
Enjoy a minimal agent from VeADK:
```python
from veadk import Agent
import asyncio
agent = Agent()
res = asyncio.run(agent.run("hello!"))
print(res)
```
## Command line tools
VeADK provides several useful command line tools for faster deployment and optimization, such as:
- `veadk deploy`: deploy your project to [Volcengine VeFaaS platform](https://www.volcengine.com/product/vefaas) (you can use `veadk init` to init a demo project first)
- `veadk prompt`: otpimize the system prompt of your agent by [PromptPilot](https://promptpilot.volcengine.com)
## Contribution
Before making your contribution to our repository, please install and config the `pre-commit` linter first.
```bash
pip install pre-commit
pre-commit install
```
Before commit or push your changes, please make sure the unittests are passed ,otherwise your PR will be rejected by CI/CD workflow. Running the unittests by:
```bash
pytest -n 16
```
## Contact with us
Join our discussion group by scanning the QR code below:
## License
This project is licensed under the [Apache 2.0 License](./LICENSE).