Contributing

Before you begin

Make sure you have a supported version of Python installed (>3.10), and that you’re working in the directory where kiurui is located.

Getting your environment ready

Create a virtual environment

Create a new virtual environment (replace /path/to/new/virtual/environment with your preferred location):

python3 -m venv /path/to/new/virtual/environment

For example:

python3 -m venv .venv

Activate it

Activation steps depend on your operating system.

Install dependencies

Make sure you use latest pip:

pip install --upgrade pip

Install uv:

pip install uv

Install the development dependencies:

uv sync --extra dev

Set up pre-commit hooks

pre-commit install

Build the project

uv build

Before you commit

Useful tools that this project uses.

Lint and format with Ruff

Ruff is a fast Python linter and formatter written in Rust:

ruff check
ruff format

Check licensing with Reuse

Reuse ensures licensing your project is easy, comprehensive, unambiguous, and machine-readable:

reuse lint