Local development

The project is managed using uv. Make sure to have it installed first.

Then install the dependencies

uv sync --all-packages

Generating protobuf

To generate Python protobuf definitions run

uv run ./compile_proto.sh

You can test the SDK by running. Remember to pass the testing credentials in .env file.

uv run test

You can format code by running

uv run format

You can check linter by running

uv run lint

Documentation is generated via openapi-python-client.

To update documentation you need to:

Go to https://github.com/fishjam-cloud/fishjam/blob/main/openapi.yaml and open the raw file.
Copy the URL.
Run uv run update_client <copied-url>