Fork of https://github.com/oxigraph/oxigraph.git for the purpose of NextGraph project

History

Tpt 17731d10ab Auto generates pyoxigraph type stubs Uses a Python script to auto generate python stubs from the module code and doc strings. Relies heavily on the inspect module.		2 years ago
..
docs	Uses readthedocs as canonical Python documentation	2 years ago
src	Fixes pyoxigraph type documentation	2 years ago
tests	Uses black for code formatting	2 years ago
Cargo.lock	Python: Adds lockfile to source archive	3 years ago
Cargo.toml	Uses readthedocs as canonical Python documentation	2 years ago
README.md	Uses readthedocs as canonical Python documentation	2 years ago
generate_stubs.py	Auto generates pyoxigraph type stubs	2 years ago
mypy_allowlist.txt	Auto generates pyoxigraph type stubs	2 years ago
pyproject.toml	Uses black for code formatting	2 years ago
requirements.dev.txt	Auto generates pyoxigraph type stubs	2 years ago

README.md

Pyoxigraph (Oxigraph for Python)

Pyoxigraph is a graph database library implementing the SPARQL standard. It is a Python library written on top of Oxigraph.

Pyoxigraph offers two stores with SPARQL 1.1 capabilities. One of the store is in-memory, and the other one is disk based.

It also provides a set of utility functions for reading, writing and processing RDF files in Turtle, TriG, N-Triples, N-Quads and RDF/XML.

Pyoxigraph is distributed on Pypi. Run pip install pyoxigraph to install it.

There exists also a small library providing rdflib stores using pyoxigraph: oxrdflib.

Pyoxigraph documentation is available on the Oxigraph website.

Build the development version

To build and install the development version of pyoxigraph you need to clone this git repository including submodules (git clone --recursive https://github.com/oxigraph/oxigraph.git) and to run pip install . in the python directory (the one this README is in).

Help

Feel free to use GitHub discussions or the Gitter chat to ask questions or talk about Oxigraph. Bug reports are also very welcome.

If you need advanced support or are willing to pay to get some extra features, feel free to reach out to Tpt.

How to contribute

Pyoxigraph is written in Rust using PyO3.

Pyoxigraph is built using Maturin. Maturin could be installed using the pip install 'maturin>=0.9,<0.10'. To install a development version of Oxigraph just run maturin develop in this README directory.

Tests

The Python bindings tests are written in Python. To run them use python -m unittest in the tests directory.

Docs

The Sphinx documentation can be generated and viewed in the browser using the following command:

sphinx-autobuild docs docs/_build/html

Note that you will need to have sphinx-autobuild installed. This should be installed already if you are using this repository's development container.

Alternatively, you can use sphinx-build with Python's http.server to achieve the same thing.

License

This project is licensed under either of

Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in Oxigraph by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.