Get started / Installation (Python)
Installation
Install the zeli-avatar package and its small, well-established
async runtime stack.
This page is the Python SDK. The JavaScript and TypeScript SDK is
@zeligate/zeli-avatar, it has zero runtime dependencies, and it
installs in one line. See
Installation (JavaScript).
Requirements
- Python 3.10+
- A running Zeli avatar server and its base URL (for example
http://your-server:8080). - Network access to the server for both HTTP signalling and the WebRTC media connection.
Install
pip install zeli-avatarThe package is zeli-avatar on PyPI,
where you can see the released versions and what each one shipped. It is
published straight from this repository's release workflow using PyPI's trusted
publishing, so no API token exists anywhere to be leaked or rotated, and the
files on PyPI are the ones the tagged build produced.
The display extra adds OpenCV and sounddevice, used by some examples to show
video or play audio locally:
pip install "zeli-avatar[display]"Core dependencies
The SDK builds on a small, well-established async stack:
| Package | Role |
|---|---|
aiortc | WebRTC transport (audio + video). |
aiohttp | HTTP signalling and the control WebSocket. |
av (PyAV) | Decoded audio/video frames. |
numpy | Array conversion for frames. |
aiortc pulls in native components (via PyAV/ffmpeg). Prebuilt
wheels cover most platforms; if a build is triggered, ensure a recent
pip and, on Linux, the usual ffmpeg build headers.
Verify
import zeli
print(zeli.__version__)You're ready. Head to the Quickstart.