diff --git a/.guix-run b/.guix-run new file mode 100644 index 000000000..e95ff3cbf --- /dev/null +++ b/.guix-run @@ -0,0 +1,18 @@ +#! /bin/sh +# +# This script sets up a Guix container. Make sure guix is in the path +# - after installing Guix (on Debian). +# +# Note that pyshex etc are part of the guix-bioinformatics channel at +# +# https://git.genenetwork.org/guix-bioinformatics/guix-bioinformatics + +env GUIX_PACKAGE_PATH=~/guix-bioinformatics/ guix environment -C guix --ad-hoc git python python-pyyaml python-pycurl python-magic nss-certs python-pyshex --network openssl python-schema-salad python-pytest which less vim python-toml python-iniconfig python-tox python-mypy python-pylint + +# Once in the shell you can do +# --- run tests (takes 1 minute, skips lint and mypy) +# tox +# --- install and run +# python3 setup.py install --user +# ~/.local/bin/schema-salad-tool --help +# diff --git a/README.rst b/README.rst index e1a17d890..595236fdc 100644 --- a/README.rst +++ b/README.rst @@ -12,15 +12,21 @@ Schema Salad ------------ -Salad is a schema language for describing JSON or YAML structured -linked data documents. Salad schema describes rules for -preprocessing, structural validation, and hyperlink checking for -documents described by a Salad schema. Salad supports rich data -modeling with inheritance, template specialization, object -identifiers, object references, documentation generation, code -generation, and transformation to RDF_. Salad provides a bridge -between document and record oriented data modeling and the Semantic -Web. +Schema Salad is a schema language for YAML (or JSON) that also lets +you map your YAML data structures into RDF structured linked data +documents via JSON-LD. In other words, a schema validates and +transforms YAML or JSON documents into structured linked data +documents - the missing link between a NoSQL JSON document and a +linked data document that can be reasoned about, e.g. for human and +machine processing. + +Salad schema describes rules for preprocessing, structural validation, +and hyperlink checking for documents described by a Salad +schema. Salad supports rich data modeling with inheritance, template +specialization, object identifiers, object references, documentation +generation, code generation, and transformation to RDF_. Salad +provides a bridge between document and record oriented data modeling +and the Semantic Web. The Schema Salad library is Python 3.6+ only.