Skip to main content

OBA Sparql Manager

Project description

OBA Sparql Query Manager Build Status codecov

OBA Sparql Query Manager is a Python Module to translate CRUD requests to SPARQL queries. This module is used by OBA project to generate a REST API from OWL ontologies.

OBA sparql use JSON-LD contexts to translate RDF triples to JSON, and vice versa.

Quick Start

Generate the context files

Simply speaking, a context is used to map terms to IRIs. Terms are case sensitive and most valid strings that are not reserved JSON-LD keywords can be used as a term.

To generate the context files, we recommend to use:

  1. OBA
  2. owl2jsonld

TODO: Insert a good example.

from obasparql import QueryManager
from test.settings import dbpedia_queries, dbpedia_context, dbpedia_endpoint, dbpedia_prefix
from obasparql.static import * 
queries = "queries/"
contexts = "contexts/"
dbpedia_endpoint = "https://dbpedia.org/sparql"
dbpedia_prefix = "http://dbpedia.org/resource"
graph = None

query_manager = QueryManager(queries_dir=queries,
                                  context_dir=contexts,
                                  endpoint=dbpedia_endpoint,
                                  named_graph_base=graph,
                                  uri_prefix=dbpedia_prefix)

query_manager.get_one_resource()
query_manager.get_all_resource()

Supported features

OBA sparql supports two types of queries:

  • Default queries: queries related to the CRUD requests.
    • Get a resource and get all the resource by type.
  • Custom queries: In some cases, users need to implement custom queries that are not the default instances of a class of the ontology (e.g., get all instances of a class that comply with certain conditions)

Default queries

Custom queries

Testing

This repository is using pytest for the testing

$ pip install -r test-requirements.txt
$ pytest

For more information. You can inspect the file .travis.yaml

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

obasparql-4.0.8.tar.gz (40.0 kB view hashes)

Uploaded source

Built Distribution

obasparql-4.0.8-py3-none-any.whl (21.3 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page