Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/weso/shex-s
Scala implementation of ShEx
https://github.com/weso/shex-s
rdf-library scala shex wikidata
Last synced: about 2 months ago
JSON representation
Scala implementation of ShEx
- Host: GitHub
- URL: https://github.com/weso/shex-s
- Owner: weso
- License: mit
- Created: 2019-11-14T06:10:33.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-08-20T01:25:46.000Z (4 months ago)
- Last Synced: 2024-10-29T23:34:22.196Z (2 months ago)
- Topics: rdf-library, scala, shex, wikidata
- Language: Scala
- Homepage: http://www.weso.es/shex-s/
- Size: 13.3 MB
- Stars: 5
- Watchers: 4
- Forks: 6
- Open Issues: 84
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# ShEx-s
Scala implementation of SHEX.
This project contains an implementation of [Shape Expressions (ShEx)](http://www.shex.io).
[](https://github.com/weso/shex-s/actions/workflows/ci.yml)
[](https://www.codacy.com/gh/weso/shex-s?utm_source=github.com&utm_medium=referral&utm_content=weso/shex-s&utm_campaign=Badge_Grade)
[](https://codecov.io/gh/weso/shex-s)
[](https://maven-badges.herokuapp.com/maven-central/es.weso/shexs_2.13)
## Introduction
This project contains a Scala implementation of [ShEx](http://shex.io/).
The library handles RDF using a
[simple RDF library](https://github.com/weso/srdf), which at this moment has 2 implementations,
one using [Apache Jena](https://jena.apache.org/)
and another one using [RDF4j](http://rdf4j.org/).
This means that it is possible to use this library to validate RDF models from either Jena or RDF4J models,
as well as from external SPARQL endpoints.
## Installation and compilation
The project uses [sbt](http://www.scala-sbt.org/) for compilation as well as Java 1.8.
* `sbt test` compiles and runs the tests
## Command line usage
It is possible to run `shex-s` as a command line tool.
To create the executable you can use the following command:
```
sbt universal:packageBin
```
and it will generate a zip file in the folder: `target/universal` which contains an executable called `shexs`
```
Usage:
shexs mapping
shexs validate
shexs shapePath
shexs manifest
shexs wikibase
shexs schema
ShEx-Scala command line tool
Options and flags:
--help
Display this help text.
--version, -v
Print the version number and exit.
Subcommands:
mapping
Convert a schema through a mapping
validate
Validate RDF data using a schema and a shape map
shapePath
Validate a shape path
manifest
Run manifest file containing tests
wikibase
Validate RDF data from wikibase
schema
Schema processing actions
```
It is possible to create binaries for different platforms like Linux, Windows, MacOS, etc.
We would like to publish those binaries with each release as discribed [in this issue](https://github.com/weso/shex-s/issues/344).
### Validate option
You can run the following in the `examples` folder to validate the turtle file `user.ttl` according to the ShEx file `user.shex` and the shape map `user.sm`:
```
shexs validate --schema user.shex --data user.ttl --shapeMap user.sm
```
Other options for validation are available as:
```
Usage:
shexs validate --schema [--schemaFormat ] [--baseIRI ] --data [--dataFormat ] --shapeMap [--shapeMapFormat ] [--validator version ] [--showResultFormat ] [--output ] [--verbose ]
shexs validate --schema [--schemaFormat ] [--baseIRI ] --endpoint --shapeMap [--shapeMapFormat ] [--validator version ] [--showResultFormat ] [--output ] [--verbose ]
shexs validate --schemaURL [--baseIRI ] --data [--dataFormat ] --shapeMap [--shapeMapFormat ] [--validator version ] [--showResultFormat ] [--output ] [--verbose ]
shexs validate --schemaURL [--baseIRI ] --endpoint --shapeMap [--shapeMapFormat ] [--validator version ] [--showResultFormat ] [--output ] [--verbose ]
Validate RDF data using a schema and a shape map
Options and flags:
--help
Display this help text.
--schema , -s
Path to ShEx file.
--schemaFormat
Schema format, default = (ShExC). Possible values = (ShExC,ShExJ)
--baseIRI
base IRI
--schemaURL
URL of schema
--data , -d
Path to data file.
--dataFormat
Data format. Default=Turtle, available=Turtle,NTriples,RDF/XML,JSON-LD
--endpoint
endpoint URL
--shapeMap , -s , -m
Path to shapeMap file.
--shapeMapFormat
ShapeMap format, default=Compact, available formats=List(Compact, JSON)
--validator version , -e
version of validator. Default = 2.2. Other values = 2.1,ref
--showResultFormat
showResultFormat
--output
Output to file (default = console)
--verbose , -v
verbose level (0-nothing,1-basic,2-info,3-details,4-debug,5-step,6-all)
```
## Implementation details
* The engine is based on Monads using the [cats library](http://typelevel.org/cats/)
* The ShEx compact syntax parser
is implemented using the following [Antlr grammar](https://github.com/shexSpec/grammar/blob/master/ShExDoc.g4) (previous versions used Scala Parser Combinators)
which is based on this [grammar](https://github.com/shexSpec/shex.js/blob/master/doc/bnf)
* JSON encoding and decoding uses the Json structure [defined here](https://shexspec.github.io/spec/) and is implemented using [Circe](https://github.com/travisbrown/circe)
* It supports ShEx + extends
## Compatibility tests
We also pass the [ShEx test-suite](https://github.com/shexSpec/shexTest).
## Generating docs page
## Publishing to OSS-Sonatype
This project uses [the sbt ci release](https://github.com/olafurpg/sbt-ci-release) plugin for publishing to [OSS Sonatype](https://oss.sonatype.org/).
##### SNAPSHOT Releases
Open a PR and merge it to watch the CI release a -SNAPSHOT version
##### Full Library Releases
1. Push a tag and watch the CI do a regular release
2. `git tag -a v0.1.0 -m "v0.1.0"`
3. `git push origin v0.1.0`
_Note that the tag version MUST start with v._
## More information
* An online demo based on this library is available at [http://rdfshape.weso.es](http://rdfshape.weso.es).
* Another online demo based on this library customized for Wikidata is available at [http://wikishape.weso.es](http://wikishape.weso.es).
* This project was based on [ShExcala](http://labra.github.io/ShExcala/) which was focused on Shape Expressions only.
## Author & contributors
* Author: [Jose Emilio Labra Gayo](http://labra.weso.es)
Contributors:
* [Eric Prud'hommeaux](https://www.w3.org/People/Eric/)
* [Bogdan Roman](https://github.com/bogdanromanx)
* [Toni Cebrián](http://www.tonicebrian.com/)
* [Andrew Berezovskyi](https://github.com/berezovskyi)
## Adopters
* [RDFShape](http://rdfshape.weso.es): An online demo powered by this library.
* [Wikishape](http://wikishape.weso.es): An online demo powered by this library for Wikidata.
* [Eclipse lyo](http://www.eclipse.org/lyo/): An SDK and a modelling environment to design and develop linked data applications based on the [OSLC standards](http://open-services.net/). The validation library is [lyo-validation](https://github.com/eclipse/lyo-validation).
## Contribution
Contributions are greatly appreciated.
Please fork this repository and open a
pull request to add more features or [submit issues](https://github.com/labra/shaclex/issues)
