Skip to content

Commit bcfc876

Browse files
author
Peter Amstutz
committed
Improve README.rst
1 parent 6baa6d5 commit bcfc876

File tree

1 file changed

+51
-29
lines changed

1 file changed

+51
-29
lines changed

README.rst

Lines changed: 51 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,46 @@
1-
SALAD is Semantic Annotations for Linked Avro Data.
2-
---------------------------------------------------
3-
4-
Salad is a schema language for describing structured linked data documents in
5-
JSON or YAML documents. A Salad schema provides rules for preprocessing,
6-
structural validation, and link checking for documents described by a Salad
7-
schema. Salad builds on JSON-LD and the Apache Avro data serialization system,
8-
and extends Avro with features for rich data modeling such as inheritance,
9-
template specialization, object identifiers, and object references. Salad was
10-
developed to provide a bridge between the record oriented data modeling
11-
supported by Apache Avro and the Semantic Web.
1+
Schema Salad
2+
------------
3+
4+
Salad is a schema language for describing JSON or YAML structured linked data
5+
documents. Salad is based originally on JSON-LD_ and the Apache Avro_ data
6+
serialization system.
7+
8+
Salad schema describes rules for preprocessing, structural validation, and link
9+
checking for documents described by a Salad schema. Salad features for rich
10+
data modeling such as inheritance, template specialization, object identifiers,
11+
object references, documentation generation, and transformation to RDF_. Salad
12+
provides a bridge between document and record oriented data modeling and the
13+
Semantic Web.
14+
15+
Usage
16+
-----
17+
18+
::
19+
$ pip install schema_salad
20+
$ schema-salad-tool
21+
usage: schema-salad-tool [-h] [--rdf-serializer RDF_SERIALIZER]
22+
[--print-jsonld-context | --print-doc | --print-rdfs | --print-avro | --print-rdf | --print-pre | --print-index | --print-metadata | --version]
23+
[--strict | --non-strict]
24+
[--verbose | --quiet | --debug]
25+
schema [document]
26+
$ python
27+
>>> import schema_salad
28+
29+
Documentation
30+
-------------
31+
32+
See the specification_ and the metaschema_ (salad schema for itself). For an
33+
example application of Schema Salad see the Common Workflow Language_.
1234

1335
Rationale
1436
---------
1537

16-
The JSON data model is an extremely popular way to represent structured data.
17-
It is attractive because of it's relative simplicity and is a natural fit with
18-
the standard types of many programming languages. However, this simplicity
19-
means that basic JSON lacks expressive features useful for working with complex
20-
data structures and document formats, such as schemas, object references, and
21-
namespaces.
38+
The JSON data model is an popular way to represent structured data. It is
39+
attractive because of it's relative simplicity and is a natural fit with the
40+
standard types of many programming languages. However, this simplicity comes
41+
at the cost that basic JSON lacks expressive features useful for working with
42+
complex data structures and document formats, such as schemas, object
43+
references, and namespaces.
2244

2345
JSON-LD is a W3C standard providing a way to describe how to interpret a JSON
2446
document as Linked Data by means of a "context". JSON-LD provides a powerful
@@ -29,11 +51,12 @@ JSON-LD document as idiomatic JSON because there are many ways to express the
2951
same data that are logically equivalent but structurally distinct.
3052

3153
Several schema languages exist for describing and validating JSON data, such as
32-
the Apache Avro data serialization system, however none understand linked data.
33-
As a result, to fully take advantage of JSON-LD to build the next generation of
34-
linked data applications, one must maintain separate JSON schema, JSON-LD
35-
context, RDF schema, and human documentation, despite significant overlap of
36-
content and obvious need for these documents to stay synchronized.
54+
JSON Schema and Apache Avro data serialization system, however none
55+
understand linked data. As a result, to fully take advantage of JSON-LD to
56+
build the next generation of linked data applications, one must maintain
57+
separate JSON schema, JSON-LD context, RDF schema, and human documentation,
58+
despite significant overlap of content and obvious need for these documents to
59+
stay synchronized.
3760

3861
Schema Salad is designed to address this gap. It provides a schema language
3962
and processing rules for describing structured JSON content permitting URI
@@ -43,10 +66,9 @@ content, enables generation of JSON-LD context and RDF schema, and production
4366
of RDF triples by applying the JSON-LD context. The schema language also
4467
provides for robust support of inline documentation.
4568

46-
Learn more
47-
----------
48-
49-
Please note that Salad is still under development. Salad is specified by the
50-
metaschema_
51-
52-
.. _metaschema: schema_salad/metaschema.yml
69+
.. _JSON-LD: http://json-ld.org
70+
.. _Avro: http://avro.apache.org
71+
.. _metaschema: https://github.com/common-workflow-language/schema_salad/blob/master/schema_salad/metaschema/metaschema.yml
72+
.. _specification: https://common-workflow-language.github.io/draft-3/SchemaSalad.html
73+
.. _Language: https://github.com/common-workflow-language/common-workflow-language/blob/master/draft-3/CommandLineTool.yml
74+
.. _RDF: https://www.w3.org/RDF/

0 commit comments

Comments
 (0)