Installation

Documentation Index

Fetch the complete documentation index at: https://docs.altrina.com/llms.txt

Use this file to discover all available pages before exploring further.

​

Requirements

• Python 3.8 or higher installed on your system
• pip package manager (comes with Python)
• A Altrina API key from app.altrina.com/settings

python --version
# or
python3 --version

​

Installation Methods

​

Method 1: Install from PyPI (Recommended)

pip install altrina_sdk

pip3 install altrina_sdk

​

Method 2: Install with Optional Dependencies

pip install altrina_sdk[async]

​

Method 3: Install from Source

git clone https://github.com/GeneralAgencyAI/altrina_sdk.git
cd altrina_sdk
pip install -e .

​

Method 4: Install in Virtual Environment (Recommended for Projects)

# Create virtual environment
python -m venv altrina-env

# Activate it
# On Windows:
altrina-env\Scripts\activate
# On macOS/Linux:
source altrina-env/bin/activate

# Install the SDK
pip install altrina_sdk

​

Configuration

​

Setting Your API Key

export ALTRINA_API_KEY="your-api-key-here"

set ALTRINA_API_KEY=your-api-key-here

$env:ALTRINA_API_KEY="your-api-key-here"

ALTRINA_API_KEY=your-api-key-here

from altrina_sdk import BrowserAgent

agent = BrowserAgent()  # Uses env var automatically

from altrina_sdk import BrowserAgent

agent = BrowserAgent(api_key="your-api-key-here")

import os
from dotenv import load_dotenv

# Load environment variables from .env file
load_dotenv()

# Configuration
ALTRINA_API_KEY = os.getenv("ALTRINA_API_KEY")

if not ALTRINA_API_KEY:
    raise ValueError("ALTRINA_API_KEY not found in environment")

from config import ALTRINA_API_KEY
from altrina_sdk import BrowserAgent

agent = BrowserAgent(api_key=ALTRINA_API_KEY)

​

Verify Installation

from altrina_sdk import BrowserAgent, __version__

print(f"Altrina SDK version: {__version__}")

# Test with a simple task
try:
    agent = BrowserAgent("YOUR_API_KEY")
    result = agent.run("Go to example.com and extract the title")
    print(f"✅ SDK is working! Result: {result.output}")
except Exception as e:
    print(f"❌ Error: {e}")

​

Dependencies

• httpx: Modern HTTP client with async support
• pydantic: Data validation using Python type annotations
• python-dotenv: Load environment variables from .env file (optional)

​

Upgrading

pip install --upgrade altrina_sdk

pip install altrina_sdk==0.2.0

​

Troubleshooting

​

Common Installation Issues

# Check installed packages
pip list | grep altrina_sdk

# If not found, install it
pip install altrina_sdk

# Update certificates
pip install --upgrade certifi

# Or install with trusted host
pip install --trusted-host pypi.org altrina_sdk

# Install for current user only
pip install --user altrina_sdk

# Or use virtual environment (recommended)
python -m venv myenv
source myenv/bin/activate  # On Windows: myenv\Scripts\activate
pip install altrina_sdk

# Create clean environment
python -m venv altrina-clean
source altrina-clean/bin/activate
pip install altrina_sdk

​

Platform-Specific Notes

pip3 install altrina_sdk
python3 your_script.py

brew install python
pip3 install altrina_sdk

python --version
pip install altrina_sdk

# Ubuntu/Debian
sudo apt update
sudo apt install python3-pip
pip3 install altrina_sdk

# Fedora
sudo dnf install python3-pip
pip3 install altrina_sdk

# Arch
sudo pacman -S python-pip
pip install altrina_sdk

​

Docker Installation

FROM python:3.8-slim

WORKDIR /app

# Install the SDK
RUN pip install altrina_sdk

# Copy your application
COPY . .

# Set environment variable
ENV ALTRINA_API_KEY=your-api-key-here

CMD ["python", "app.py"]

docker build -t altrina-app .
docker run -e ALTRINA_API_KEY=$ALTRINA_API_KEY altrina-app

​

Next Steps

​

Support

• Check our GitHub Issues
• Contact support at support@altrina.com