pyKwalify

![Gitter](https://badges.gitter.im/Join Chat.svg)

YAML/JSON validation library

This framework is a port with alot added functionality of the java version of the framework kwalify that can be found at: http://www.kuwata-lab.com/kwalify/

The source code can be found at: http://sourceforge.net/projects/kwalify/files/kwalify-java/0.5.1/

The schema this library is base and extended from: http://www.kuwata-lab.com/kwalify/ruby/users-guide.01.html#schema

Documentation

All documentation can be found at http://pykwalify.readthedocs.org/en/latest/

This readme contains a reduced version of the full documentation.

Installation

Latest stable release from pypi

pip install pykwalify

PyYaml and ruamel.yaml

In release 1.6.0 PyYaml will be deprecated in favor of ruamel.yaml.

PyYaml is still the default installed one but it will removed in release 1.7.0 and ruamel.yaml will be the new default yaml parser lib from that release and forward.

Install it for production:

pip install 'pykwalify[ruamel]'

or for development:

pip install -e '.[ruamel]'

This decision was based on the following thread in the PyYaml repo https://bitbucket.org/xi/pyyaml/issues/59/has-this-project-been-abandoned

Usage

Create a data file. Json and Yaml formats are both supported.

- foo
- bar

Create a schema file with validation rules.

type: seq
sequence:
  - type: str

Run validation from cli.

pykwalify -d data.yaml -s schema.yaml

Runtime dependencies

docopt >= 0.6.2
PyYaml >= 3.11
python-dateutil >= 2.4.2

Optional dependencies:

ruamel.yaml >= 0.11.0

Supported python version

Python 2.7
Python 3.3
Python 3.4
Python 3.5
Python 3.6 (Experimental, allowed to fail travis)

Licensing

MIT, See docs/License.txt for details

nowox/pykwalify