Skip to content
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

README & guix-run container runner #391

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
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
18 changes: 18 additions & 0 deletions .guix-run
Original file line number Diff line number Diff line change
@@ -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).
Comment on lines +1 to +4
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool! Can you add a GitHub Action to test this?

#
# 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
#
24 changes: 15 additions & 9 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down