Skip to content

Add docs for case_validate #104

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ repos:
hooks:
- id: flake8
- repo: https://github.com/pycqa/isort
rev: 5.10.1
rev: 5.12.0
hooks:
- id: isort
name: isort (python)
27 changes: 25 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,31 @@ case_validate \

This tool uses the `--built-version` flag, described [below](#built-versions).

Other flags are reviewable with `case_validate --help`.

Other flags are reviewable with `case_validate --help` which are listed below:

```shell
positional arguments:
in_graph

optional arguments:
-h, --help show this help message and exit
-d, --debug Output additional runtime messages.
--built-version {none,case-0.5.0,case-0.6.0,case-0.7.0,case-0.7.1,case-1.0.0}
Monolithic aggregation of CASE ontology files at certain versions. Does not require networking to use. Default is most recent CASE release.
--ontology-graph ONTOLOGY_GRAPH
Combined ontology (i.e. subclass hierarchy) and shapes (SHACL) file, in any format accepted by rdflib recognized by file extension (e.g. .ttl). Will supplement ontology selected by
--built-version. Can be given multiple times.
--abort (As with pyshacl CLI) Abort on first invalid data.
-w, --allow-warnings (As with pyshacl CLI) Shapes marked with severity of Warning or Info will not cause result to be invalid.
-f {human,turtle,xml,json-ld,nt,n3}, --format {human,turtle,xml,json-ld,nt,n3}
(ALMOST as with pyshacl CLI) Choose an output format. Default is "human". Difference: 'table' not provided.
-im, --imports (As with pyshacl CLI) Allow import of sub-graphs defined in statements with owl:imports.
-i {none,rdfs,owlrl,both}, --inference {none,rdfs,owlrl,both}
(As with pyshacl CLI) Choose a type of inferencing to run against the Data Graph before validating. Default is "none".
-o [OUTPUT], --output [OUTPUT]
(ALMOST as with pyshacl CLI) Send output to a file. If absent, output will be written to stdout. Difference: If specified, file is expected not to exist. Clarification: Does NOT influence
--format flag's default value of "human". (I.e., any machine-readable serialization format must be specified with --format.)
```

### `case_file`

Expand Down