Skip to main content

Parsing and Validation library for PRISMH Files

Project description

Build Status Documentation Status https://img.shields.io/pypi/v/prismh.core.svg https://img.shields.io/pypi/l/prismh.core.svg

Caution!

This package has been retired in favor of rios.core. Please upgrade ASAP.

PRISMH.CORE Overview

PRISMH.CORE is a Python package that provides basic validation and formatting functionality for data structures that adhere to the PRISMH specifications.

Example Usage

This package exposes a handful of simple functions for validating and formatting the standard PRISMH data structures:

>>> from prismh.core import validate_instrument, get_instrument_json

>>> instrument = {"foo": "bar", "id": "urn:my-instrument", "title": "An Instrument Title", "record": [{"id": "field1","type": "text"}], "version": "1.0"}
>>> validate_instrument(instrument)
Traceback (most recent call last):
    ...
colander.Invalid: {'': u'Unrecognized keys in mapping: "{\'foo\': \'bar\'}"'}

>>> del instrument['foo']
>>> validate_instrument(instrument)

>>> print get_instrument_json(instrument)
{
  "id": "urn:my-instrument",
  "version": "1.0",
  "title": "An Instrument Title",
  "record": [
    {
      "id": "field1",
      "type": "text"
    }
  ]
}

For more information on the available functionality, please read the API documentation.

Contributing

Contributions and/or fixes to this package are more than welcome. Please submit them by forking this repository and creating a Pull Request that includes your changes. We ask that you please include unit tests and any appropriate documentation updates along with your code changes.

This project will adhere to the Semantic Versioning methodology as much as possible, so when building dependent projects, please use appropriate version restrictions.

A development environment can be set up to work on this package by doing the following:

$ virtualenv prismh
$ cd prismh
$ . bin/activate
$ hg clone ssh://hg@bitbucket.org/prometheus/prismh.core
$ pip install -e ./prismh.core[dev]

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for prismh.core, version 0.4.0
Filename, size File type Python version Upload date Hashes
Filename, size prismh.core-0.4.0-py2.py3-none-any.whl (30.0 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size prismh.core-0.4.0.tar.gz (32.9 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page