Development Setup¶
This guide details local development environment setup.
Setup Process¶
1.) Setup the Rust & rusty-kaspa environment:
This SDK is built from Rust source code and leverages native rusty-kaspa. You'll need the full Rust/rusty-kaspa environment: rusty-kaspa installation guide.
2.) Ensure Python 3.10 - 3.14 is installed, as well as pip.
3.) Clone the repository:
4.) Install optional development & docs dependencies:
For development and testing, install the optional dependency groups:
# Activate the virtual environment first
source env/bin/activate
# Install dev dependencies (pytest, pytest-asyncio)
pip install -e ".[dev]"
# Install docs dependencies (mkdocs, mkdocstrings, etc.)
pip install -e ".[docs]"
# Or install both at once
pip install -e ".[dev,docs]"
Verify environment¶
The project includes a check script that automates various builds, lints, and tests to help the development process. It can be used to verify environment is working:
See building workflows - ./check for details.
The locally built kaspa module can then be imported and used from Python.