Skip to content

SETUP.md

Latest commit

 

History

History
87 lines (62 loc) · 2.17 KB

SETUP.md

File metadata and controls

87 lines (62 loc) · 2.17 KB

Development Setup

Quick Start

  1. Install uv (if not already installed):

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

  2. Set up the project:

    Recommended: For active development

    make dev-install

    This installs the package and all dependencies. Use this for normal development.

    Alternative: Dependencies only (for CI/CD or tools)

    make setup-venv

    This only installs dependencies, not the package. Useful for CI/CD or when you only need tools.

  3. Run tests:

    make test

That's it! The Makefile automatically uses uv if available, otherwise falls back to pip.

What is uv?

uv is an extremely fast Python package installer and resolver written in Rust. It's designed to be a drop-in replacement for pip, pip-tools, virtualenv, and pipx.

Benefits

  • ⚡ Faster: 10-100x faster than pip/conda
  • 🔒 Reproducible: uv.lock ensures consistent builds
  • 🎯 Simple: One tool for virtualenv, pip, and dependency management
  • 🔄 Compatible: Works with existing pyproject.toml

Common Commands

make dev-install    # Install all dependencies
make test           # Run tests
make lint           # Run linting
make format         # Format code
make docs           # Build documentation
make check          # Run all checks

Understanding Dependency Groups vs Extras

This project uses both dependency groups and extras:

  • Dependency groups (dev, docs): Development dependencies that are not published to PyPI. The dev group is installed by default with uv sync.
  • Extras (tokenizer, token): Optional runtime features for tokenizer support - install with --extra tokenizer or --all-extras.

Troubleshooting

uv command not found

Make sure ~/.local/bin is in your PATH:

export PATH="$HOME/.local/bin:$PATH"

Virtual environment issues

Clear and recreate:

rm -rf .venv
uv sync --group docs --all-extras

Lock file conflicts

Regenerate the lock file:

rm uv.lock
uv lock
uv sync --group docs --all-extras

For more details, see CONTRIBUTING.md.