Installation
Complete installation guide for the Antarys Python client with pip, virtual environments, and building from source.
Installing Antarys Python Client
Learn how to install the Antarys Python client for your vector database operations.
Requirements: Python 3.7+ is required. We recommend using Python 3.8 or higher for optimal performance.
Quick Installation
The fastest way to get started is with pip:
pip install antarysThat's it! You can now start using Antarys in your Python projects.
Installation Methods
📦 Via pip
Install directly from PyPI (recommended)
🐍 With Virtual Environment
Install in an isolated environment (best practice)
🔨 Build from Source
Build the latest development version
pip Installation
Install Optional Dependencies
For enhanced performance, install optional dependencies:
pip install antarys
pip install numba lz4Performance Boost: These dependencies can significantly improve performance for large-scale operations.
Verify Installation
Test your installation:
import antarys
print(f"Antarys version: {antarys.__version__}")Virtual Environment Installation
Best Practice: Always use virtual environments to avoid package conflicts and maintain clean project dependencies.
Create Virtual Environment
# Create a new virtual environment
python3 -m venv antarys-env
# Alternative: specify Python version
python3.9 -m venv antarys-envActivate Virtual Environment
source antarys-env/bin/activateantarys-env\Scripts\activatesource antarys-env/Scripts/activateInstall Antarys
# Upgrade pip first (recommended)
pip install --upgrade pip
# Install Antarys
pip install antarys
# Install with performance dependencies
pip install antarys[performance]Verify Installation
python -c "import antarys; print(f'Antarys {antarys.__version__} installed successfully!')"Success! Your virtual environment is ready with Antarys installed.
Create Conda Environment
# Create environment with specific Python version
conda create -n antarys-env python=3.9
# Activate environment
conda activate antarys-envInstall Antarys
# Install via pip (recommended)
pip install antarys
# Or try conda-forge (if available)
conda install -c conda-forge antarys