Skip to main content

Build Status Build status

Schema Salad

Salad is a schema language for describing JSON or YAML structured linked data documents. Salad is based originally on JSON-LD and the Apache Avro data serialization system.

Salad schema describes rules for preprocessing, structural validation, and link checking for documents described by a Salad schema. Salad features for rich data modeling such as inheritance, template specialization, object identifiers, object references, documentation generation, and transformation to RDF. Salad provides a bridge between document and record oriented data modeling and the Semantic Web.

Usage

$ pip install schema_salad
$ schema-salad-tool
usage: schema-salad-tool [-h] [--rdf-serializer RDF_SERIALIZER]
                      [--print-jsonld-context | --print-doc | --print-rdfs | --print-avro | --print-rdf | --print-pre | --print-index | --print-metadata | --version]
                      [--strict | --non-strict]
                      [--verbose | --quiet | --debug]
                      schema [document]
$ python
>>> import schema_salad

To install from source:

git clone https://github.com/common-workflow-language/schema_salad
cd schema_salad
python setup.py install

Documentation

See the specification and the metaschema (salad schema for itself). For an example application of Schema Salad see the Common Workflow Language.

Rationale

The JSON data model is an popular way to represent structured data. It is attractive because of it’s relative simplicity and is a natural fit with the standard types of many programming languages. However, this simplicity comes at the cost that basic JSON lacks expressive features useful for working with complex data structures and document formats, such as schemas, object references, and namespaces.

JSON-LD is a W3C standard providing a way to describe how to interpret a JSON document as Linked Data by means of a “context”. JSON-LD provides a powerful solution for representing object references and namespaces in JSON based on standard web URIs, but is not itself a schema language. Without a schema providing a well defined structure, it is difficult to process an arbitrary JSON-LD document as idiomatic JSON because there are many ways to express the same data that are logically equivalent but structurally distinct.

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

Schema Salad is designed to address this gap. It provides a schema language and processing rules for describing structured JSON content permitting URI resolution and strict document validation. The schema language supports linked data through annotations that describe the linked data interpretation of the content, enables generation of JSON-LD context and RDF schema, and production of RDF triples by applying the JSON-LD context. The schema language also provides for robust support of inline documentation.

Metadata

Release files for schema-salad 2.7.20180611133406

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for schema-salad 2.7.20180611133406
File Size Uploaded
schema-salad-2.7.20180611133406.tar.gz 348.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for schema-salad 2.7.20180611133406
File Interpreter ABI Platform
schema_salad-2.7.20180611133406-py2.py3-none-any.whl Python 2, Python 3 none any Details

Total release size: 728.1 kB

Release files / schema-salad-2.7.20180611133406.tar.gz

Download URL schema-salad-2.7.20180611133406.tar.gz
Size 348.0 kB
Tags Source
SHA-256 checksum
How to use checksums
094e8d8dcf04ff695397d455e3f17cff37df15c36b1cdf5ce8974a42015f8b59
BLAKE2b-256 checksum
How to use checksums
affb645a2c7ad327cf6da550bcc5887cada6194c81b744737ab00e050ecb39a9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / schema_salad-2.7.20180611133406-py2.py3-none-any.whl

Download URL schema_salad-2.7.20180611133406-py2.py3-none-any.whl
Size 380.2 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
cc3e865dada234cab49fdff4fda0c8f71076d4dc864a499e86a73a2876319912
BLAKE2b-256 checksum
How to use checksums
37eb9ed3748d0cc19acb4ac4d17893a647d70103cb37668aa5182fe2ee3f54ba
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

8.3

12 release files

This release

2.7.20180611133406 This release

2 release files

1.7

2 release files

1.1.1

1 release file

1.1.0

1 release file

1.0.6

1 release file

1.0.5

2 release files

1.0.4

2 release files

1.0.3

2 release files

1.0.2

1 release file

1.0.1

2 release files

1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page