Skip to main content

A Spec By Example framework for RDF and SPARQL, Inspired by Cucumber.

Project description

mustrd

coverage badge

Why?

How do you know your SPARQL, whether it's in a pipeline, or a query, is doing what you intend?

As much as we love RDF and SPARQL and Semantic Tech in general, we found a small gap in tooling to give us that certainty.

We missed the powerful testing frameworks that have evolved in imperative languages that help ensure you've written code that does what you think it should.

We wanted to be able to

  • setup data scenarios and ensure queries worked as expected
  • setup edge cases for queries and ensure they still work
  • isolate small sparql enrichment / transformation steps and know we're only INSERTing what we intend

Enter MustRD.

What?

MustRD is a Spec-By-Example ontology, with a reference python implementation, inspired by the likes of Cucumber.

It's designed to be triplestore/SPARQL engine agnostic (aren't open standards wonderful!).

What it is NOT

MustRD is nothing to do with SHACL, or an alternative to it. In fact, we use SHACL for some of our features.

SHACL provides validation around data.

MustRD provides validation around data transformations.

How?

You define your specs in ttl, or trig files. We use the SBE approach of Given, When, Then to define starting dataset, an action, and a set of expectations. We build up a set of data. Then, depending on whether your SPARQL is a CONSTRUCT, SELECT or a INSERT/DELETE, we run it, and compare results against a set of expectations (Then) that are defined in the same way as a Given . Alternatively, you could define your Then

  • as an explicit ASK, or
  • select; or
  • in a higher-order expectation language like you will be used to in various platforms, a set of expectations.

When?

Soon. It's a work in progress, and we're building the things we need for the projects we work on at multiple clients, with multiple vendor stacks. We already think it's useful, but it might not meet your needs, out of the box.

We invite you to try it, see where it doesn't fit, and raise an issue, or even better, a PR! If you need something custom, please check out our consultancy rates, and we might be able to prioritise a new feature for you.

Support

We're a specialist consultancy in Semantic Tech, we're putting this out in case it's useful, but if you need more support, kindly contact our business team on info@semanticpartners.com, or mustrd@semanticpartners.com

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

mustrd-0.3.0.0.tar.gz (39.6 kB view details)

Uploaded Source

Built Distribution

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

mustrd-0.3.0.0-py3-none-any.whl (54.1 kB view details)

Uploaded Python 3

File details

Details for the file mustrd-0.3.0.0.tar.gz.

File metadata

  • Download URL: mustrd-0.3.0.0.tar.gz
  • Upload date:
  • Size: 39.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.1 CPython/3.13.2 Darwin/24.5.0

File hashes

Hashes for mustrd-0.3.0.0.tar.gz
Algorithm Hash digest
SHA256 dc26e283b607c15e41920acb2ba84b9b718eac3f31a6e62fd4e907ee3d907c8c
MD5 d915857fa9a1dd59a7bc3216388b03be
BLAKE2b-256 6c5260e94445d4950bbf5dc5c9174f2c96cbe02f7b92980ab8bac284d6e3796f

See more details on using hashes here.

File details

Details for the file mustrd-0.3.0.0-py3-none-any.whl.

File metadata

  • Download URL: mustrd-0.3.0.0-py3-none-any.whl
  • Upload date:
  • Size: 54.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.1 CPython/3.13.2 Darwin/24.5.0

File hashes

Hashes for mustrd-0.3.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c1c64b0ba419605442f965a562cfcf82d4593e7052323428f1f9817f65292d5f
MD5 ec7ddd20e3d16e5ae29ed6e39d9d240b
BLAKE2b-256 51dfebd42b743a6b66023566e641b27d88f96a8f8c1a73bd539fae49f31436c3

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