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.2.7a0.tar.gz (37.4 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.2.7a0-py3-none-any.whl (52.7 kB view details)

Uploaded Python 3

File details

Details for the file mustrd-0.2.7a0.tar.gz.

File metadata

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

File hashes

Hashes for mustrd-0.2.7a0.tar.gz
Algorithm Hash digest
SHA256 86f9021f7c4081d55112fa07b5884ab3f06fdf6f3f09b4e4902996aa6d675e4e
MD5 20741c2ff0ce812b7d788e032ae4f8c1
BLAKE2b-256 c5cec26f569c803c8d77b9dd7f720d7f787acfe2b427174d02050264d33043c3

See more details on using hashes here.

File details

Details for the file mustrd-0.2.7a0-py3-none-any.whl.

File metadata

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

File hashes

Hashes for mustrd-0.2.7a0-py3-none-any.whl
Algorithm Hash digest
SHA256 15823f5f51b7f9d69f3400c325c6c435c4fc16af82e9af583552dca078a141a7
MD5 226ef89df0cd1f23393a99e56f2da2bd
BLAKE2b-256 dfbd7a48cc94704a740b3054e80b48409f32d56cb4604d106a0f0297b70b3a12

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