Installation

Get AA Kit up and running in your Python environment in minutes.

Requirements

Python 3.8 or higher
pip package manager
Virtual environment (recommended)

Installation Methods

Install via pip

bash

pip install aa-kit

Install with optional dependencies

bash

# Install with all optional dependencies
pip install aa-kit[all]

# Install with specific providers
pip install aa-kit[openai]      # OpenAI support
pip install aa-kit[anthropic]   # Anthropic support
pip install aa-kit[redis]       # Redis memory backend
pip install aa-kit[postgres]    # PostgreSQL backend

Install from source

bash

git clone https://github.com/josharsh/aa-kit.git
cd aa-kit
pip install -e .

Setting Up Your Environment

1. Create a Virtual Environment

bash

# Create virtual environment
python -m venv agentz-env

# Activate on macOS/Linux
source agentz-env/bin/activate

# Activate on Windows
agentz-env\Scripts\activate

2. Configure API Keys

AA Kit supports multiple LLM providers. Set up your API keys as environment variables:

bash

# For OpenAI models
export OPENAI_API_KEY="your-openai-api-key"

# For Anthropic models
export ANTHROPIC_API_KEY="your-anthropic-api-key"

# Or use a .env file
echo "OPENAI_API_KEY=your-api-key" >> .env
echo "ANTHROPIC_API_KEY=your-api-key" >> .env

Security Note

Never commit API keys to version control. Always use environment variables or secure key management systems.

Verify Installation

After installation, verify everything is working correctly:

python

# Verify installation
python -c "import aakit; print(aa-kit.__version__)"

# Test with a simple agent
python
>>> from aakit import Agent
>>> agent = Agent("test", "You are a test agent", "gpt-3.5-turbo")
>>> print("Agent created successfully!")

Optional Dependencies

Dependency	Purpose	Install Command
redis	Redis memory backend	`pip install aa-kit[redis]`
psycopg2	PostgreSQL memory backend	`pip install aa-kit[postgres]`
fastapi	MCP server functionality	`pip install aa-kit[server]`
all	All optional dependencies	`pip install aa-kit[all]`

Troubleshooting

Import Error: No module named 'aa-kit'

Make sure you've activated your virtual environment and installed AA Kit:

pip install aa-kit

API Key Error

Ensure your API keys are properly set as environment variables:

echo $OPENAI_API_KEY

SSL Certificate Error

If you encounter SSL errors, upgrade certifi:

pip install --upgrade certifi

Ready to Build!

You've successfully installed AA Kit. Now you're ready to create your first agent.

Continue to Quick Start →