Skip to content

For developers

Adding new backends

See interface.py, which defines the interface of a backend and may serve as a template for creating new backends.

Developing the sparqlwrapper

Tripper comes with an inbuilt backend to the SPARQLWrapper. In order to test this properly a real triplestore is needed. This is not done in the automatic workflows on github. However, a local graphDB can be setup as described below and tested with test_sparqlwrapper_graphdb.py.

To create the local instance of graphdb: 

docker pull ontotext/graphdb:10.8.3 # latest tag 17.02.2025
docker run -d -p 7200:7200 --name graphdb ontotext/graphdb:10.8.3

Then go to http://localhost:7200/ in your browser. You can add a new repository by pressing create new reposotory in the bottom right corner. Choose GraphDB Reposotory and write "test_repo" as repository ID. Tick off Enable full-text search and leave the rest as predefined. Click Create.

Go to Setup and select Repositories. Activating "test_repo" by clicking the pin icon (Set as default repository) and then the restart icon (Restart repository test_repo).

You can now run the test test_sparqlwrapper_graphdb_fuseki.py with graphdb.

Note that if the graphdb instance is not found the test will just be skipped.

Similarly a jena-fuseki instance can be tested locally as follows:

docker pull stain/jena-fuseki
docker run -d --name fuseki -p 3030:3030 -e ADMIN_PASSWORD=admin0 -e=FUSEKI_DATASET_1=test_repo stain/jena-fuseki

You can now run the test test_sparqlwrapper_graphdb_fuseki.py with fuseki.

Note that if the fuseki instance is not found the test will just be skipped.

Creating new release

To create a new release, it is good to have a release summary.

To add this, create a milestone that matches the new version and tag, e.g., v1.0.8.

Then create a new issue, adding it to the milestone and add the release-summary label.

For the issue description, write the actual release summary. This will be included as part of the changelog as well as the release notes on GitHub.

Then, go to create a new GitHub releases and select the tag that matches the milestone (creating a new one). Add again the tag as the release title (optionally write something else that defines this release as a title).

Finally, press the "Publish release" button and ensure the release workflow succeeds (check the release workflow).

Testing documentation locally

To test the documentation locally, just install and run mkdocs:

pip install .[dev]
mkdocs build
mkdocs serve

Then open http://127.0.0.1:8000/tripper/ in your browser.