Skip to content

Installation

Prerequisites

Install uv

uv is a fast Python package installer and resolver written in Rust. It's required for this project.

curl -LsSf https://astral.sh/uv/install.sh | sh

powershell -c "irm https://astral.sh/uv/install.ps1 | iex"

pip install uv

Python Version

This project requires Python 3.10 or higher. Check your version:

python --version

Installation Steps

1. Clone the Repository

git clone https://github.com/Strategic-Automation/dspy-compounding-engineering.git
cd dspy-compounding-engineering

2. Install Dependencies

Using uv, dependencies are automatically managed:

uv sync

This will:

  • Create a virtual environment in .venv/
  • Install all required dependencies from pyproject.toml
  • Lock dependencies in uv.lock

3. Install Development Dependencies (Optional)

For documentation and testing:

uv sync --group dev

This adds:

  • MkDocs and Material theme for documentation
  • pytest and coverage tools
  • Ruff for linting

Next Steps

Installation Complete!

You're ready to configure your environment and start using the tool.

Continue to:

Troubleshooting

uv Command Not Found

After installation, you may need to restart your shell or source your profile:

# Bash/Zsh
source ~/.bashrc  # or ~/.zshrc

# Fish
source ~/.config/fish/config.fish

Python Version Issues

If uv sync fails due to Python version, install Python 3.10+:

sudo apt update
sudo apt install python3.10

brew install python@3.10

Download from python.org

Dependency Conflicts

If you encounter dependency resolution issues:

# Clear the uv cache
uv cache clean

# Retry sync
uv sync --refresh

Verifying Installation

Test that everything is installed correctly:

uv run python cli.py --help

You should see the CLI help output with available commands.