Skip to main content

Use Stardog with Python!

Project description

pystardog

Python wrapper for communicating with the Stardog HTTP server.

What is it?

This framework wraps all the functionality of a client for the Stardog Knowledge Graph, and provides access to a full set of functions such as executing SPARQL queries, administrative tasks on Stardog, and the use of the Reasoning API.

The implementation uses the HTTP protocol, since most of Stardog functionality is available using this protocol. For more information, go to the Stardog's HTTP Programming documentation.

Installation

pystardog is on PyPI so all you need is: pip install pystardog

Documentation

Documentation is readable at Read the Docs or can be built using Sphinx:

pip install -r requirements.txt
cd docs
make html

Tests

To run the tests locally, a valid Stardog license is required and placed in the dockerfiles/stardog-license-key.bin. Docker and docker-compose are also required.

 docker-compose -f docker-compose.single-node.yml up --exit-code-from tests-single-node

 docker-compose -f docker-compose.cluster.yml up --exit-code-from tests

Format

To run a format of all the files

virtualenv -p $(which python3) venv
. venv/bin/activate
pip install -r test-requirements.txt

Quick Example

import stardog

conn_details = {
  'endpoint': 'http://localhost:5820',
  'username': 'admin',
  'password': 'admin'
}

with stardog.Admin(**conn_details) as admin:
  db = admin.new_database('db')

  with stardog.Connection('db', **conn_details) as conn:
    conn.begin()
    conn.add(stardog.content.File('./test/data/example.ttl'))
    conn.commit()
    results = conn.select('select * { ?a ?p ?o }')

  db.drop()

Interactive Tutorial

There is a Jupyter notebook and instructions in the notebooks directory of this repository.

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

pystardog-0.11.0-py3-none-any.whl (33.4 kB view details)

Uploaded Python 3

File details

Details for the file pystardog-0.11.0-py3-none-any.whl.

File metadata

  • Download URL: pystardog-0.11.0-py3-none-any.whl
  • Upload date:
  • Size: 33.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.7

File hashes

Hashes for pystardog-0.11.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4954aabb63a63c5bd4f5df4c12b0910a6f746d8a081b4b61ae8939d18a72ad7f
MD5 46a97b1e66f594be54e5b078de6f6a28
BLAKE2b-256 8e778c4e9fba1b35562c24a99d569461460bdf3e3ab09f41cac36b7f30ede589

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page