Antarys

|

Antarys

Python Client

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 antarys

That'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 the Package

Install the latest stable version from PyPI:

pip install antarys

Install Optional Dependencies

For enhanced performance, install optional dependencies:

pip install antarys
pip install numba lz4

Performance 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-env

Activate Virtual Environment

source antarys-env/bin/activate
antarys-env\Scripts\activate
source antarys-env/Scripts/activate

Install 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-env

Install Antarys

# Install via pip (recommended)
pip install antarys

# Or try conda-forge (if available)
conda install -c conda-forge antarys

Initialize Pipenv Project

# Create project directory
mkdir my-antarys-project
cd my-antarys-project

# Initialize pipenv
pipenv install antarys

Activate Shell

pipenv shell

Add Antarys to Project

poetry add antarys

Activate Environment

poetry shell

Build from Source

Prerequisites

Install required build tools:

# Install build essentials
pip install --upgrade pip setuptools wheel build
# Install Python build tools
pip install --upgrade pip setuptools wheel build

Clone Repository

# Clone the repository
git clone https://github.com/antarys-ai/antarys-python.git
cd antarys-python

Repository: The source code is available at github.com/antarys-ai/antarys-python

Create Virtual Environment

python3 -m venv myenv
source myenv/bin/activate

Install Dependencies

# Install development dependencies
pip install --upgrade pip
pip install -r requirements-dev.txt

Build Package

# Build source distribution and wheel
python3 setup.py sdist bdist_wheel --universal

Build Output: The built packages will be available in the dist/ directory.

Install Built Package

# Install the locally built package
pip install dist/antarys-*.whl

# Or install in development mode for active development
pip install -e .

Verify Installation

python -c "import antarys; print(f'Built Antarys {antarys.__version__} successfully!')"

Getting Help

🐛 Report Issues

Found a bug or need help with installation?

💬 Community Support

Join our discord community for questions and discussions

Reporting Issues

If you encounter problems with the Python client, please create an issue on GitHub:

Check Existing Issues

Visit the issues page to see if your problem has already been reported.

Create New Issue

Click "New Issue" and choose the appropriate template:

  • 🐛 Bug Report - For installation or runtime issues
  • 💡 Feature Request - For new functionality
  • 📖 Documentation - For documentation improvements
  • ❓ Question - For general questions

Provide Details

Include the following information:

# System information
python --version
pip --version

# Package information
pip show antarys

# Error logs (if any)
pip install antarys --verbose

Template: Use our issue templates to provide all necessary information for faster resolution.

Issue Template Example

**Environment:**
- OS: [e.g., Ubuntu 20.04, Windows 10, macOS 12]
- Python version: [e.g., 3.9.7]
- Antarys version: [e.g., 1.0.0]

**Installation method:** [pip, conda, source]

**Error message:**

[Paste the complete error message here]

**Steps to reproduce:**
1. Run command: `pip install antarys`
2. See error: ...

**Expected behavior:**
Package should install successfully.

Next Steps

Ready to code? Now that you have Antarys installed, check out the Samples to begin building your dream AI app!

Quick Start

Python client for Antarys vector database, optimized for large-scale vector operations with built-in caching, parallel processing, and dimension validation.

Vector Operations

Complete guide to vector CRUD operations in Antarys - Create, Read, Update, and Delete vectors with advanced querying capabilities.