Skip to content

Zelos SDK Installation

Choose your language to get started with the Zelos SDK for real-time data streaming.

Python

Requirements

Python Version

Python 3.10 or later is required. Check your version: 

python --version

Installation

Ensure uv is installed, or follow the Installing uv guide.

Virtual Environment Setup

# Create virtual environment
uv venv .venv

# Activate environment
source .venv/bin/activate  # (1)!

# Install Zelos SDK
uv pip install zelos-sdk

Adding to an existing project using uv

uv add zelos-sdk
  1. On Windows: .venv\Scripts\activate

Standard Installation

# Create virtual environment
python3 -m venv .venv --upgrade-deps

# Activate environment
source .venv/bin/activate  # (1)!

# Install Zelos SDK
pip install zelos-sdk
  1. On Windows: .venv\Scripts\activate

pytest Integration

Add to your conftest.py to enable Zelos pytest plugins: 

pytest_plugins = [
    "zelos_sdk.pytest.plugins",
]

Rust

Requirements

  • Rust toolchain from rustup.rs
  • Cargo (included with Rust)

Installation

Add to your Cargo.toml:

Cargo.toml
[dependencies]
zelos = "0.0.1"
tokio = { version = "1", features = ["full"] }
tokio-util = "0.7"

Go

Requirements

  • Go 1.23 or later
  • Check with: go version

Installation

go get github.com/zeloscloud/zelos/go@latest

Module Path

Due to Go module limitations with subdirectories, use the full import path: 

import "github.com/zeloscloud/zelos/go"

Connection Configuration

All SDKs connect to grpc://localhost:2300 by default. To use a different endpoint:

zelos_sdk.init(url="grpc://192.168.1.100:2300")

let config = TracePublishClientConfig {
    url: "grpc://192.168.1.100:2300".to_string(),
    ..Default::default()
};

config := zelos.DefaultTracePublishClientConfig()
config.URL = "grpc://192.168.1.100:2300"

Troubleshooting

No matching distribution found (Python)

Your Python version is too old. Update to Python 3.10+:

brew install [email protected]

sudo apt update
sudo apt install python3.11

Download from python.org

Connection refused

The SDK can't reach the Zelos App or Agent. Check:

  • Zelos App or Agent is running
  • Port 2300 is not blocked by firewall
  • Using correct URL if not localhost

Test connectivity: 

nc -zv localhost 2300
Module not found (Go)

Ensure you're using the full import path: 

import "github.com/zeloscloud/zelos/go"  // ✓ Correct
import "zelos"                            // ✗ Wrong

🚀 What's Next?