Skip to content

development.md

Latest commit

 

History

History
71 lines (48 loc) · 1.74 KB

development.md

File metadata and controls

71 lines (48 loc) · 1.74 KB
Raw

Development Setup

Thank you for your interest in contributing to the Allos Agent SDK! This guide will help you set up a local development environment.

1. Prerequisites

  • Git
  • Python 3.9+
  • uv (our recommended package manager). If you don't have it, install it here.

2. Fork and Clone the Repository

First, fork the repository on GitHub. Then, clone your fork locally:

git clone https://github.com/YourUsername/allos-agent-sdk.git
cd allos-agent-sdk

3. Run the Setup Script

We provide a convenient script that automates the entire setup process.

# Make the script executable (if needed)
chmod +x scripts/setup_dev.sh

# Run the setup script
./scripts/setup_dev.sh

This script will:

  1. Check for uv.
  2. Create a virtual environment in .venv/, preferring Python 3.9 if available.
  3. Install all required and development dependencies using uv.
  4. Install pre-commit hooks for automated code formatting and linting.
  5. Create a .env file from the example for you to add your API keys.

4. Activate the Environment

Activate the virtual environment created by the script:

source .venv/bin/activate

5. Add API Keys

Open the newly created .env file and add your API keys for the providers you wish to test. This is required for running the integration tests.

# .env
OPENAI_API_KEY="your_openai_key"
ANTHROPIC_API_KEY="your_anthropic_key"

6. Run the Tests

To verify your setup is working correctly, run the test suite.

# Run all unit tests
./scripts/run_tests.sh

# Run unit and integration tests (requires API keys)
./scripts/run_tests.sh --run-integration

For more details, see the Testing Guide.

You are now ready to start developing!