Documentation/Installation

Installation Guide

Complete setup instructions for AxiomTradeAPI-py

Beginner10 minutes

System Requirements

Supported Python Versions

Python 3.8+
Python 3.9
Python 3.10 (recommended)
Python 3.11
Python 3.12

Operating Systems

Windows 10+
macOS 10.15+
Ubuntu 18.04+
Debian 10+

Quick Installation

Option 1: Install via pip (Recommended)

# Install the latest stable version
pip install axiomtradeapi

# Verify installation
python -c "from axiomtradeapi import AxiomTradeClient; print('Installation successful!')"

Option 2: Install with Development Dependencies

# For developers who want to contribute
pip install axiomtradeapi[dev]

# This includes additional tools for:
# - Testing frameworks (pytest)
# - Code formatting (black, isort)
# - Documentation generation (sphinx)

Virtual Environment Setup (Best Practice)

Why Use Virtual Environments?

Virtual environments isolate your project dependencies, preventing conflicts between different projects and keeping your system Python clean.

Windows Setup

# Create project directory
mkdir my-solana-bot
cd my-solana-bot

# Create virtual environment
python -m venv venv

# Activate virtual environment
venv\Scripts\activate

# Install AxiomTradeAPI-py
pip install axiomtradeapi

# Verify installation
python -c "from axiomtradeapi import AxiomTradeClient; print('Ready to build!')"

macOS/Linux Setup

# Create project directory
mkdir my-solana-bot
cd my-solana-bot

# Create virtual environment
python3 -m venv venv

# Activate virtual environment
source venv/bin/activate

# Install AxiomTradeAPI-py
pip install axiomtradeapi

# Verify installation
python -c "from axiomtradeapi import AxiomTradeClient; print('Ready to build!')"

Docker Installation (Enterprise)

Perfect for production deployments and containerized trading systems.

Dockerfile

# Dockerfile for Solana trading bot
FROM python:3.11-slim

WORKDIR /app

# Install AxiomTradeAPI-py
RUN pip install --no-cache-dir axiomtradeapi

# Copy your trading bot code
COPY . .

# Run your trading bot
CMD ["python", "your_trading_bot.py"]

Build and Run

# Build Docker image
docker build -t my-solana-bot .

# Run container
docker run -d --name solana-bot my-solana-bot

# View logs
docker logs -f solana-bot

# Stop container
docker stop solana-bot

Docker Compose (Recommended)

version: '3.8'

services:
  trading-bot:
    build: .
    environment:
      - AXIOM_AUTH_TOKEN=${AXIOM_AUTH_TOKEN}
      - AXIOM_REFRESH_TOKEN=${AXIOM_REFRESH_TOKEN}
    restart: unless-stopped
    volumes:
      - ./logs:/app/logs
    networks:
      - solana-network

networks:
  solana-network:
    driver: bridge

Troubleshooting

"pip: command not found"

Solution: Install or upgrade pip

# Download get-pip.py
curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py

# Install pip
python get-pip.py

"Permission denied" Error

Solution: Use --user flag or virtual environment

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

# OR: Use virtual environment (recommended)
python -m venv venv
source venv/bin/activate  # Windows: venv\Scripts\activate
pip install axiomtradeapi

"Module not found" Error

Solution: Ensure you're using the correct Python interpreter

# Check which Python is being used
which python  # macOS/Linux
where python  # Windows

# Install using the specific Python version
python3.11 -m pip install axiomtradeapi

SSL Certificate Error

Solution: Update certificates or use trusted host

# Update certificates (macOS)
/Applications/Python\ 3.x/Install\ Certificates.command

# Use trusted host (temporary workaround)
pip install --trusted-host pypi.org --trusted-host files.pythonhosted.org axiomtradeapi

Next Steps

Getting Started Tutorial

Build your first Solana trading bot

Authentication Setup

Configure API credentials

Need Help?

• Join our Discord community for installation support

• Check the troubleshooting guide for more solutions

• Report issues on GitHub