Installation Guide - AxiomTradeAPI-py

System Requirements

Python Version

Python 3.8 or higher

Recommended: 3.10+

Operating System

Windows 10+, macOS 10.15+, or Linux (Ubuntu 18.04+)

All platforms supported

Memory

At least 4GB RAM

8GB+ for trading bots

Internet Connection

Stable connection required

For real-time features

Quick Installation

Standard Installation (Recommended)

Development Installation

For Developers

Install with dev dependencies

pip install axiomtradeapi[dev]

Includes additional development tools for contributors and advanced users.

Testing frameworks (pytest, coverage)

Code formatting tools (black, isort)

Documentation generation

Virtual Environment Setup (Best Practice)

Why use virtual environments?

Virtual environments isolate your project dependencies, preventing conflicts between different projects and ensuring reproducible deployments.

1

Create Virtual Environment

Create new environment

python -m venv axiom_trading_env

2

Activate Environment

Windows activation

axiom_trading_env\Scripts\activate

macOS activation

source axiom_trading_env/bin/activate

Linux activation

source axiom_trading_env/bin/activate

3

Install AxiomTradeAPI-py

Install in virtual environment

pip install axiomtradeapi

Docker Installation

Perfect for production deployments, cloud environments, and containerized trading systems.

Simple Dockerfile

Dockerfile

FROM python:3.11-slim

WORKDIR /app

# Install AxiomTradeAPI-py
RUN pip install axiomtradeapi

# Copy your trading bot code
COPY . .

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

Build and Run

Docker commands

# Build your container
docker build -t my-solana-bot .

# Run your trading bot
docker run -d --name solana-bot my-solana-bot

# View logs
docker logs solana-bot

Installation Verification

Quick Test

Verify installation

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

Complete Test Script

test_installation.py

import sys

def test_installation():
    try:
        from axiomtradeapi import AxiomTradeClient
        print("✅ AxiomTradeAPI-py imported successfully")
        
        client = AxiomTradeClient()
        print("✅ Client created successfully")
        
        print(f"✅ Python version: {sys.version}")
        print("🎉 Installation verification complete!")
        
    except ImportError as e:
        print(f"❌ Import error: {e}")
        print("Please check your installation")
        
    except Exception as e:
        print(f"❌ Unexpected error: {e}")

if __name__ == "__main__":
    test_installation()

Common Issues & Solutions

"No module named 'axiomtradeapi'"

Problem: Python cannot find the installed package.

Solution 1: Verify Installation

pip list | grep axiomtradeapi

Solution 2: Reinstall Package

pip uninstall axiomtradeapi
pip install axiomtradeapi

Permission Denied Error

Problem: Insufficient permissions to install packages.

Solution: User Installation

pip install --user axiomtradeapi

Python Version Not Supported

Problem: Using Python version older than 3.8.

Solution: Update Python

Download and install Python 3.8+ from python.org

Next Steps

Getting Started Tutorial

Learn the basics and build your first trading bot

Authentication Setup

Configure API access and security tokens

API Reference

Complete documentation of all methods and classes