Skip to content

Development Setup

How to set up your environment to contribute to Animus.

Prerequisites

  • Python 3.10+ (Core), 3.11+ (Bootstrap), or 3.12+ (Forge)
  • Git
  • Ollama for local LLM inference

Clone

git clone https://github.com/AreteDriver/animus.git
cd animus

Install Dependencies

# Install shared types first
pip install -e packages/types/

# Install the packages you want to work on
pip install -e "packages/core/[dev,api]"
pip install -e "packages/forge/[dev]"
pip install -e "packages/quorum/[dev]"
pip install -e "packages/bootstrap/[dev]"

Verify

# Run tests for the package you're working on
pytest packages/core/tests/ -v
pytest packages/forge/tests/ -v
pytest packages/quorum/tests/ -v
pytest packages/bootstrap/tests/ -v

# Check code style
ruff check packages/
ruff format --check packages/

Local LLM

Install Ollama and pull a model:

ollama pull qwen2.5:14b

Animus will auto-detect Ollama and use it as the default provider.

See Also