CONTRIBUTING.rst

Getting started

Using pip

Navigate to the project directory and run the following commands:

Create and activate a virtual environment

$ python -m venv .venv
$ source .venv/bin/activate

Install dependencies

$ pip install -r requirements/dev.txt
$ pip install -r requirements/docs.in

Install the package in editable mode

$ pip install -e .

Lint the code

$ ruff check --fix

Build updated documentation locally

$ cd docs
$ make html

or

$ sphinx-build -b html docs docs/_build

Run the tests together or individually, requires the docker containers to be up and running (see below)

$ pytest tests
$ pytest tests/test_basic.py

For easier startup and teardown of storage for testing you may use

$ docker-compose up -d
$ docker-compose down

Using rye

$ rye pin 3.11
$ rye sync

$ rye run python examples/hello.py

etc.

Pull requests

Please check previous pull requests before submitting a new one.

Please ensure your pull requests are to the development branch.