Skip to main content

A Python package of RDF data manipulation functions that can be called from the command line or other software

Project description

Kurra Python Library

A Python package of RDF data manipulation functions that can be called from the command line or other software.

This library uses the RDFLib under-the-hood to process RDF data. It supplies functions to:

  • manipulate local RDF files
  • send commands to RDF databases "triplestores"
  • SPARQL query files or databases

kurra is for convenience: the functions it provides are simple but kurra saves you having to reinvent wheels.

CLI app

kurra presents a Command Line Interface that can be used on Mac, Linux and Windows (WSL) command prompts.

The hierarchy of functions provided is:

  • db - run commands against RDF databases
    • list
    • create
    • upload
    • clear
    • delete
    • sparql
  • file - run commands on local RDF files
    • format
    • upload
    • quads
    • sparql
  • shacl
    • validate - SHACL validate a file
  • sparql - SPARQL query files or databases

Once you have installed kurra (see below), you can ask it to tell you what each command does and what inputs are needed by using the --help or just -h, command, e.g.:

kurra -h

which will return something like:

╭─ Options ─────────────────────────────────────────────────────────────────────────────────╮
│ --version             -v                                                                  │
│ --install-completion            Install completion for the current shell.                 │
│ --show-completion               Show completion for the current shell, to copy it or ...  │
│ --help                -h        Show this message and exit.                               │
╰───────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ────────────────────────────────────────────────────────────────────────────────╮
│ db       RDF database commands                                                            │
│ file     RDF file commands                                                                │
│ sparql   SPARQL queries to local RDF files or a database                                  │
╰───────────────────────────────────────────────────────────────────────────────────────────╯

To find out more about the specific options within db, file & sparql, run the help command at the lext level, like this:

kurra db -h

or

kurra file -h

etc. for shacl & sparql

To get further help for the particular commands. For db, you will see something like this:

Usage: kurra db [OPTIONS] COMMAND [ARGS]...                                                                                                                                 
 RDF database commands                                                                                                                                                      
╭─ Options ─────────────────────────────────────────────────────────────────────────────────────╮
│ --help  -h        Show this message and exit.                                                 │
╰───────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ────────────────────────────────────────────────────────────────────────────────────╮
│ list     Get the list of database repositories                                                │
│ create   Create a new database repository                                                     │
│ upload   Upload files to a database repository                                                │
│ clear    Clear a database repository                                                          │
│ delete   Delete a database repository                                                         │
│ sparql   Query a database repository                                                          │
╰───────────────────────────────────────────────────────────────────────────────────────────────╯

Installation

CLI App

The recommended way to manage and run Python CLI apps is to use the Python package uv which you will need to install first, see the uv installation instructions. then:

uv tool install kurra

Now you can invoke kurra anywhere in your terminal as long as ~/.local/bin is in your PATH.

See the uv documentation on installing tools for more information.

Library

You can also install kurra as a Python library for used of its functions in other applications

pip install kurra

Use the relevant command to add dependencies to your project if you are using a tool like uv, poetry, or conda.

Then import it and use in your code, e.g. for the format functions:

from kurra.file import format_file, make_dataset, export_quads

Development

Install the Poetry project and its dependencies:

task install

Format code:

task code

To build a new release:

  1. update the version in pyproject.toml
  2. commit & push all changes
  3. git tag with the same version number
  4. push the tag - git push --tags
  5. build the release - uv build
  6. publish the release on PyPI - uv publish - username __token__, pwd is an actual token
  7. make the release on GitHub - https://github.com/Kurrawong/kurra/releases
  • don't forget to add the dist zips & wheels to it
  1. update version number in pyproject.toml to next alpha & push

License

BSD-3-Clause license. See LICENSE.

Contact & Support

kurra is maintained by:

KurrawongAI
http://kurrawong.ai
info@kurrawong.ai

Please contact them for all use & support issues.

You can also log issues at the kurra issue tracker:

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

kurra-1.5.4.tar.gz (101.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

kurra-1.5.4-py3-none-any.whl (19.0 kB view details)

Uploaded Python 3

File details

Details for the file kurra-1.5.4.tar.gz.

File metadata

  • Download URL: kurra-1.5.4.tar.gz
  • Upload date:
  • Size: 101.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.5.15

File hashes

Hashes for kurra-1.5.4.tar.gz
Algorithm Hash digest
SHA256 1e7ba083a73033b795539943453219c98dcad60b9291bb6f360d87a53fee1dbf
MD5 1c573f12d6ce3e80f1d1c9213af847c5
BLAKE2b-256 04494ea60cdd40dc7fa55ad4320716244471b5f8da6cedda72745090a151ac31

See more details on using hashes here.

File details

Details for the file kurra-1.5.4-py3-none-any.whl.

File metadata

  • Download URL: kurra-1.5.4-py3-none-any.whl
  • Upload date:
  • Size: 19.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.5.15

File hashes

Hashes for kurra-1.5.4-py3-none-any.whl
Algorithm Hash digest
SHA256 1ac9750b6d09da3875f247340ca6c49a8d95c5a9c899fba344664c25b2c191a1
MD5 707178679fab0ca572bda0d65e3a5e7b
BLAKE2b-256 3d7ca2e7d30bd0709444e15459e5e2922dd0ee9081ee85b019405987fc65572c

See more details on using hashes here.

Supported by

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