Skip to content

Commit

Permalink
Added reference to PyBackTrip (#180)
Browse files Browse the repository at this point in the history
# Description:
Added a table with available backends to README file, including the
backends in PyBackTrip.

Closes #177
Closes #157 

## Type of change:
- [ ] Bug fix and code cleanup.
- [ ] New feature.
- [x] Documentation update.
- [ ] Testing.
  • Loading branch information
jesper-friis authored Mar 4, 2024
1 parent dac502c commit c18a9f1
Show file tree
Hide file tree
Showing 3 changed files with 75 additions and 1 deletion.
35 changes: 35 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,21 @@ Documentation
* [Reference manual]


Available backends
------------------
The following backends are currently available, either in Tripper or other packages.

| Backend name | Provided by | Requirements | Comment
| ------------ | ------------ | ----------------------- | -----------------
| rdflib | [tripper] | rdflib | In-memory [rdflib] triplestore supporting all features.
| ontopy | [tripper] | EMMOntoPy | Backend for [EMMOntoPy]. In-memory.
| sparqlwrapper | [tripper] | sparqlwrapper | Generic backend for all triplestores supported by [sparqlwrapper].
| collection | [tripper] | DLite-Python | Backend to a [DLite] collection.
| fuseki | [PyBackTrip] | sparqlwrapper | Backend to [fuseki].
| stardog | [PyBackTrip] | sparqlwrapper,pystardog | Backend to [StarDog].
| graphdb | [PyBackTrip] | sparqlwrapper | Backend to [GraphDB].


Installation
------------
Tripper has by itself no dependencies outside the standard library, but the triplestore backends may have specific dependencies.
Expand All @@ -57,6 +72,17 @@ The package can be installed from [PyPI] using `pip`:
pip install tripper
```

In addition you would need to install the requirements for one or more of the backends listed in the table above.
For mappings you would also need to install [Pint].
For example:

```shell
pip install rdflib pint
```




License and copyright
---------------------
All files in this repository are licensed under the [MIT license](LICENSE).
Expand All @@ -78,9 +104,18 @@ We gratefully acknowledge the following projects for supporting the development



[tripper]: https://emmc-asbl.github.io/tripper
[rdflib]: https://rdflib.readthedocs.io/en/stable/
[PyPI]: https://pypi.org/project/tripper
[PyBackTrip]: https://github.com/EMMC-ASBL/PyBackTrip/
[Reference manual]: https://emmc-asbl.github.io/tripper/latest/api_reference/triplestore/
[Literal]: https://emmc-asbl.github.io/tripper/latest/api_reference/triplestore/#tripper.triplestore.Literal
[Namespace]: https://emmc-asbl.github.io/tripper/latest/api_reference/triplestore/#tripper.triplestore.Namespace
[Triplestore]: https://emmc-asbl.github.io/tripper/latest/api_reference/triplestore/#tripper.triplestore.Triplestore
[EMMOntoPy]: https://emmo-repo.github.io/EMMOntoPy/stable/
[sparqlwrapper]: https://sparqlwrapper.readthedocs.io/en/latest/
[DLite]: https://sintef.github.io/dlite/
[fuseki]: https://jena.apache.org/documentation/fuseki2/
[StarDog]: https://www.stardog.com/
[GraphDB]: https://www.ontotext.com/products/graphdb/
[Pint]: https://pint.readthedocs.io/en/stable/
35 changes: 35 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,21 @@ Documentation
* [Reference manual]


Available backends
------------------
The following backends are currently available, either in Tripper or other packages.

| Backend name | Provided by | Requirements | Comment
| ------------ | ------------ | ----------------------- | -----------------
| rdflib | [tripper] | rdflib | In-memory [rdflib] triplestore supporting all features.
| ontopy | [tripper] | EMMOntoPy | Backend for [EMMOntoPy]. In-memory.
| sparqlwrapper | [tripper] | sparqlwrapper | Generic backend for all triplestores supported by [sparqlwrapper].
| collection | [tripper] | DLite-Python | Backend to a [DLite] collection.
| fuseki | [PyBackTrip] | sparqlwrapper | Backend to [fuseki].
| stardog | [PyBackTrip] | sparqlwrapper,pystardog | Backend to [StarDog].
| graphdb | [PyBackTrip] | sparqlwrapper | Backend to [GraphDB].


Installation
------------
Tripper has by itself no dependencies outside the standard library, but the triplestore backends may have specific dependencies.
Expand All @@ -57,6 +72,17 @@ The package can be installed from [PyPI] using `pip`:
pip install tripper
```

In addition you would need to install the requirements for one or more of the backends listed in the table above.
For mappings you would also need to install [Pint].
For example:

```shell
pip install rdflib pint
```




License and copyright
---------------------
All files in this repository are licensed under the [MIT license](LICENSE.md).
Expand All @@ -78,9 +104,18 @@ We gratefully acknowledge the following projects for supporting the development



[tripper]: https://emmc-asbl.github.io/tripper
[rdflib]: https://rdflib.readthedocs.io/en/stable/
[PyPI]: https://pypi.org/project/tripper
[PyBackTrip]: https://github.com/EMMC-ASBL/PyBackTrip/
[Reference manual]: https://emmc-asbl.github.io/tripper/latest/api_reference/triplestore/
[Literal]: https://emmc-asbl.github.io/tripper/latest/api_reference/triplestore/#tripper.triplestore.Literal
[Namespace]: https://emmc-asbl.github.io/tripper/latest/api_reference/triplestore/#tripper.triplestore.Namespace
[Triplestore]: https://emmc-asbl.github.io/tripper/latest/api_reference/triplestore/#tripper.triplestore.Triplestore
[EMMOntoPy]: https://emmo-repo.github.io/EMMOntoPy/stable/
[sparqlwrapper]: https://sparqlwrapper.readthedocs.io/en/latest/
[DLite]: https://sintef.github.io/dlite/
[fuseki]: https://jena.apache.org/documentation/fuseki2/
[StarDog]: https://www.stardog.com/
[GraphDB]: https://www.ontotext.com/products/graphdb/
[Pint]: https://pint.readthedocs.io/en/stable/
6 changes: 5 additions & 1 deletion tripper/triplestore.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
See
https://raw.githubusercontent.com/EMMC-ASBL/tripper/master/README.md
for an introduction.
for an introduction and for a table over available backends.
This module has no dependencies outside the standard library, but the
triplestore backends may have.
Expand Down Expand Up @@ -129,6 +129,10 @@ def __init__(
including the dots (ex:"mypackage.mybackend"). If `package`
is given, `backend` is interpreted relative to `package`
(ex: ..mybackend).
For a list over available backends, see
https://github.com/EMMC-ASBL/tripper#available-backends
base_iri: Base IRI used by the add_function() method when adding
new triples. May also be used by the backend.
database: Name of database to connect to (for backends that
Expand Down

0 comments on commit c18a9f1

Please # to comment.