Skip to main content

Validate your Knowledge Graphs based on tests generated from SHACL shapes.

Project description

cmem-plugin-pyshacl

Validate your Knowledge Graphs based on tests generated from SHACL shapes.

eccenca Corporate Memory

This is a plugin for eccenca Corporate Memory. You can install it with the cmemc command line clients like this:

cmemc admin workspace python install cmem-plugin-pyshacl

Parameters

Data graph URI

The URI of the data graph to be validated. The graph URI is selected from a list of graphs of types:

  • di:Dataset
  • dsm:ThesaurusProject
  • owl:Ontology
  • shui:ShapeCatalog
  • void:Dataset

SHACL graph URI

The URI of the graph containing the SHACL shapes to be validated against. The graph URI is selected from a list of graphs of type shui:ShapeCatalog

Generate validation graph

If enabled, the validation graph is posted to the CMEM instance with the graph URI specified with the validation graph URI option. Default value: false

Validation graph URI

If the generate validation graph option is enabled the validation graph is posted to the CMEM instance with this graph URI

Output entities

If enabled, the plugin outputs the validation results and can be connected to, for instance, a CSV dataset to produce a results table. Default value: false

Clear validation graph

If enabled, the validation graph is cleared before workflow execution. Default value: true.

Advanced Options

Resolve owl:imports

If enabled, the graph tree defined with owl:imports in the data graph is resolved. Default value: true

Blank node skolemization

If enabled, blank nodes in the validation graph are skolemized into URIs. Default value: true

Add labels

If enabled, rdfs:label triples are added to the validation graph for instances of sh:ValidationReport and sh:ValidationResult. Default value: true

Add labels from data and SHACL graphs

If enabled along with the add labels option, rdfs:label triples are added for the focus nodes, values and SHACL shapes in the validation graph. The labels are taken from the specified data and SHACL graphs. Default value: false

Add shui:conforms flag to focus node resources

If enabled, shui:conforms false triples are added to the focus nodes in the validation graph. Default value: false

Meta-SHACL

If enabled, the SHACL shapes graph is validated against the SHACL-SHACL shapes graph before validating the data graph. Default value: false

Ontology graph URI

The URI of a graph containing extra ontological information. RDFS and OWL definitions from this are used to inoculate the data graph. The graph URI is selected from a list of graphs of type owl:Ontology

Inference

If enabled, OWL inferencing expansion of the data graph is performed before validation. Options are RDFS, OWLRL, Both, None. Default value: None

Advanced

Enable SHACL Advanced Features. Default value: false.

Maximum evaluation depth

The maximum number of SHACL shapes "deep" that the validator can go before reaching an "endpoint" constraint (1-999). Default value: 15

Parameter Input

In order to set options via the input the following parameter names can be used:

Option Name
Data graph URI data_graph_uri
SHACL graph URI shacl_graph_uri
Generate validation graph generate_graph
Validation graph URI validation_graph_uri
Output entities output_entities
Clear validation graph clear_validation_graph
Resolve owl:imports owl_imports
Blank node skolemization skolemize
Add labels add_labels
Add labels from data and SHACL graphs include_graphs_labels
Add shui:conforms flag to focus node resources add_shui_conforms
Meta-SHACL meta_shacl
Ontology graph URI ontology_graph_uri
Inference inference
Advanced advanced
Maximum evaluation depth max_evaluation_depth

workflow pypi version license poetry ruff mypy copier

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

cmem_plugin_pyshacl-5.0.2.tar.gz (19.1 kB view details)

Uploaded Source

Built Distribution

cmem_plugin_pyshacl-5.0.2-py3-none-any.whl (17.3 kB view details)

Uploaded Python 3

File details

Details for the file cmem_plugin_pyshacl-5.0.2.tar.gz.

File metadata

  • Download URL: cmem_plugin_pyshacl-5.0.2.tar.gz
  • Upload date:
  • Size: 19.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.11.10 Linux/6.5.0-1025-azure

File hashes

Hashes for cmem_plugin_pyshacl-5.0.2.tar.gz
Algorithm Hash digest
SHA256 051150df569d69256f674874754ac670feb5c01b8d08a577bbc1b4a66140a9d5
MD5 7cffd9bfaaadd75274b727f52858f670
BLAKE2b-256 2ce6078d168de5f8df9327c4188977ce72751c431478127574527ffef616e452

See more details on using hashes here.

File details

Details for the file cmem_plugin_pyshacl-5.0.2-py3-none-any.whl.

File metadata

File hashes

Hashes for cmem_plugin_pyshacl-5.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 ec49498a2cc5ae02349215edc3ab4869a981256f11046445c3c2a8a3bf056a98
MD5 aec107bc5ba9447bc1a93c72d6c93a7f
BLAKE2b-256 c1327841916ed5fdb9fa61913a753a423474427f46252daa1f0756765736e136

See more details on using hashes here.

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