summaryrefslogtreecommitdiff
path: root/docs/basics.rst
blob: b2bd878a8a65141805644fcc47786a8b817da438 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
Basic Usage
===========

Create a data ``json`` or ``yaml`` file.

.. code-block:: yaml

    # Data file (data.yaml)
    - foo
    - bar

Create a schema file with validation rules.

.. code-block:: yaml

    # Schema file (schema.yaml)
    type: seq
    sequence:
      - type: str

Run validation from cli.

.. code-block:: bash

    pykwalify -d data.yaml -s schema.yaml

Or if you want to run the validation from inside your code directly.

.. code-block:: python

    from pykwalify.core import Core
    c = Core(source_file="data.yaml", schema_files=["schema.yaml"])
    c.validate(raise_exception=True)

If validation fails then exception will be raised.