🛠️ Contributing

This section is for if you want to run the package in development, and get involved by making a code contribution.

Requirements: uv to easily handle scripts and virtual environments.

📥️ Clone

Clone the repository:

git clone https://github.com/vemonet/rdflib-endpoint
cd rdflib-endpoint

🪝 Install pre-commit hooks

uv run --all-extras pre-commit install

🚀 Run example API

Run the example SPARQL endpoint with YASGUI on http://localhost:8000, it will be automatically reloaded when the code is changed:

./scripts/dev.sh

☑️ Run tests

Make sure the existing tests still work by running the test suite and linting checks. Note that any pull requests to the fairworkflows repository on github will automatically trigger running of the test suite:

uv run --all-extras pytest

To display all print():

uv run --all-extras pytest -s

export DOCKER_HOST=unix:///Users/$(whoami)/.orbstack/run/docker.sock

docker stop $(docker ps -a -q) && docker rm $(docker ps -a -q)

🧹 Code formatting

The code will be automatically formatted when you commit your changes using pre-commit. But you can also run the script to format the code yourself:

./scripts/fmt.sh

♻️ Reset the environment

Upgrade dependencies in lock file:

uv sync --all-extras --upgrade

Upgrade uv:

uv self update

Clean uv cache:

uv cache clean

🏷️ Release process

Run the release script providing the version bump: fix, minor, or major

./scripts/release.sh fix