Skip to content

Installation

Sparkwheel requires Python 3.10 or higher.

Install from PyPI

The simplest way to install Sparkwheel:

pip install sparkwheel

Install from Source

For the latest development version:

git clone https://github.com/project-lighter/sparkwheel.git
cd sparkwheel
pip install -e .

Development Setup

If you want to contribute to Sparkwheel, we use uv and just for development:

Install uv

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

Install just

brew install just

apt install just

winget install --id Casey.Just --exact

Setup Development Environment

git clone https://github.com/project-lighter/sparkwheel.git
cd sparkwheel
just setup

Check out the justfile for other available commands.

This will:

  • Install all dependencies (including dev, test, and doc groups)
  • Set up pre-commit hooks
  • Configure your development environment

Verify Installation

Test that Sparkwheel is installed correctly:

import sparkwheel
print(sparkwheel.__version__)

Next Steps