Skip to content

Installation Guide

System Requirements

  • Python 3.9+
  • For better performance: Linux or macOS (uvloop support)

Installation Methods

Using pip

pip install zeroapi

From Source

git clone https://github.com/Ananto30/zero.git
cd zero
pip install -e .

Optional Dependencies

Zero includes several optional dependencies for specific use cases:

uvloop - Better Async Performance

Improves async performance on Linux and macOS (no effect on Windows):

pip install "zeroapi[uvloop]"

When to use: If you're building async-heavy services on Unix systems.

Pydantic Support

Enable full Pydantic model support for complex data validation:

pip install "zeroapi[pydantic]"

When to use: When you need data validation and schema generation.

Tornado - Windows Async Support

Windows-specific async runtime support:

pip install "zeroapi[tornado]"

When to use: If you're running async services on Windows.

Everything

Install all optional dependencies at once:

pip install "zeroapi[all]"

Verify Installation

python -c "from zero import ZeroServer, ZeroClient; print('✓ Zero is installed!')"

Virtual Environment Setup

Recommended: Always use a virtual environment:

# Create virtual environment
python -m venv venv

# Activate it
source venv/bin/activate  # On Windows: venv\Scripts\activate

# Install zero
pip install zeroapi

Next Steps