edit README

eccenca · Nov 13, 2024 · 66f91bc · 66f91bc
1 parent f73f2bb
commit 66f91bc
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 101 deletions.
diff --git a/.copier-answers.yml b/.copier-answers.yml
@@ -1,5 +1,5 @@
 # Changes here will be overwritten by Copier
-_commit: v6.0.0
+_commit: v7.0.0
 _src_path: gh:eccenca/cmem-plugin-template
 author_mail: [email protected]
 author_name: eccenca GmbH

diff --git a/README.md b/README.md
@@ -2,108 +2,24 @@
 
 Validate your Knowledge Graphs based on tests generated from SHACL shapes.
 
-[![eccenca Corporate Memory](https://img.shields.io/badge/eccenca-Corporate%20Memory-orange)](https://documentation.eccenca.com) [![workflow](https://github.com/eccenca/cmem-plugin-pyshacl/actions/workflows/check.yml/badge.svg)](https://github.com/eccenca/cmem-plugin-pyshacl/actions) [![pypi version](https://img.shields.io/pypi/v/cmem-plugin-pyshacl)](https://pypi.org/project/cmem-plugin-pyshacl/) [![license](https://img.shields.io/pypi/l/cmem-plugin-pyshacl)](https://pypi.org/project/cmem-plugin-pyshacl)
+[![eccenca Corporate Memory][cmem-shield]][cmem-link][![workflow](https://github.com/eccenca/cmem-plugin-pyshacl/actions/workflows/check.yml/badge.svg)](https://github.com/eccenca/cmem-plugin-pyshacl/actions) [![pypi version](https://img.shields.io/pypi/v/cmem-plugin-pyshacl)](https://pypi.org/project/cmem-plugin-pyshacl) [![license](https://img.shields.io/pypi/l/cmem-plugin-pyshacl)](https://pypi.org/project/cmem-plugin-pyshacl)
+[![poetry][poetry-shield]][poetry-link] [![ruff][ruff-shield]][ruff-link] [![mypy][mypy-shield]][mypy-link] [![copier][copier-shield]][copier] 
 
 ## Development
 
 - Run [task](https://taskfile.dev/) to see all major development tasks.
 - Use [pre-commit](https://pre-commit.com/) to avoid errors before commit.
 - This repository was created with [this copier template](https://github.com/eccenca/cmem-plugin-template).
 
-## Options
 
-### 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   |
+[cmem-link]: https://documentation.eccenca.com
+[cmem-shield]: https://img.shields.io/endpoint?url=https://dev.documentation.eccenca.com/badge.json
+[poetry-link]: https://python-poetry.org/
+[poetry-shield]: https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json
+[ruff-link]: https://docs.astral.sh/ruff/
+[ruff-shield]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json&label=Code%20Style
+[mypy-link]: https://mypy-lang.org/
+[mypy-shield]: https://www.mypy-lang.org/static/mypy_badge.svg
+[copier]: https://copier.readthedocs.io/
+[copier-shield]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border-purple.json
 
diff --git a/Taskfile.yaml b/Taskfile.yaml
@@ -123,23 +123,26 @@ tasks:
           poetry run pytest --junitxml={{.JUNIT_FILE}}
           --cov-report term  --cov-report xml:{{.COVERAGE_FILE}}
           --cov-report html:{{.COVERAGE_DIR}} --cov={{.PACKAGE}}
+          --html={{.HTML_FILE}} --self-contained-html
       - platforms: [darwin, linux]
         cmd: >
           poetry run pytest --memray --junitxml={{.JUNIT_FILE}}
           --cov-report term --cov-report xml:{{.COVERAGE_FILE}}
           --cov-report html:{{.COVERAGE_DIR}} --cov={{.PACKAGE}}
+          --html={{.HTML_FILE}} --self-contained-html
       - cmd: >
           poetry run genbadge coverage -l
           -i {{.COVERAGE_FILE}} -o {{.BADGE_COVERAGE}}
       - cmd: >
           poetry run genbadge tests -l
           -i {{.JUNIT_FILE}} -o {{.BADGE_TESTS}}
     vars:
-      JUNIT_FILE: ./{{.DIST_DIR}}/junit-pytest.xml
-      COVERAGE_FILE: ./{{.DIST_DIR}}/coverage.xml
-      COVERAGE_DIR: ./{{.DIST_DIR}}/coverage
       BADGE_COVERAGE: ./{{.DIST_DIR}}/badge-coverage.svg
       BADGE_TESTS: ./{{.DIST_DIR}}/badge-tests.svg
+      COVERAGE_DIR: ./{{.DIST_DIR}}/coverage
+      COVERAGE_FILE: ./{{.DIST_DIR}}/coverage.xml
+      HTML_FILE: ./{{.DIST_DIR}}/pytest.html
+      JUNIT_FILE: ./{{.DIST_DIR}}/junit-pytest.xml
 
   check:mypy:
     desc: Complain about typing errors
@@ -154,8 +157,9 @@ tasks:
     <<: *preparation
     cmds:
       # ignore 51358 safety - dev dependency only
+      # ignore 67599 pip - dev dependency only
       # ignore 70612 jinja2 - dev dependency only
-      - poetry run safety check -i 51358 -i 70612
+      - poetry run safety check -i 51358 -i 67599 -i 70612
 
   check:ruff:
     desc: Complain about everything else