Ravenports generated: 06 Nov 2021 01:33
[ravenports.git] / bucket_F4 / python-jsonschema
1 # Buildsheet autogenerated by ravenadm tool -- Do not edit.
2
3 NAMEBASE=               python-jsonschema
4 VERSION=                4.2.1
5 KEYWORDS=               python
6 VARIANTS=               py38 py39
7 SDESC[py38]=            Alternate implementation of JSON Schema (PY38)
8 SDESC[py39]=            Alternate implementation of JSON Schema (PY39)
9 HOMEPAGE=               https://github.com/Julian/jsonschema
10 CONTACT=                Python_Automaton[python@ironwolf.systems]
11
12 DOWNLOAD_GROUPS=        main
13 SITES[main]=            PYPIWHL/3e/e9/e8eaf86cf7119e18d555413532b507b254454e0275645cbae11babaa2d20
14 DISTFILE[1]=            jsonschema-4.2.1-py3-none-any.whl:main
15 DF_INDEX=               1
16 SPKGS[py38]=            single
17 SPKGS[py39]=            single
18
19 OPTIONS_AVAILABLE=      PY38 PY39
20 OPTIONS_STANDARD=       none
21 VOPTS[py38]=            PY38=ON PY39=OFF
22 VOPTS[py39]=            PY38=OFF PY39=ON
23
24 DISTNAME=               jsonschema-4.2.1.dist-info
25
26 GENERATED=              yes
27
28 [PY38].RUN_DEPENDS_ON=                  python-attrs:single:py38
29                                         python-pyrsistent:single:py38
30                                         python-importlib-resources:single:py38
31 [PY38].USES_ON=                         python:py38,wheel
32
33 [PY39].RUN_DEPENDS_ON=                  python-attrs:single:py39
34                                         python-pyrsistent:single:py39
35 [PY39].USES_ON=                         python:py39,wheel
36
37 [FILE:2606:descriptions/desc.single]
38 ==========
39 jsonschema
40 ==========
41
42 |PyPI| |Pythons| |CI| |ReadTheDocs| |Precommit| |Zenodo|
43
44 jsonschema is an implementation of the [JSON Schema
45 ] specification for Python.
46
47 .. code-block:: python
48
49     >>> from jsonschema import validate
50
51     >>> # A sample schema, like what we'd get from json.load()
52     >>> schema = {
53     ...     "type" : "object",
54     ...     "properties" : {
55     ...         "price" : {"type" : "number"},
56     ...         "name" : {"type" : "string"},
57     ...     },
58     ... }
59
60     >>> # If no exception is raised by validate(), the instance is valid.
61     >>> validate(instance={"name" : "Eggs", "price" : 34.99},
62 schema=schema)
63
64     >>> validate(
65     ...     instance={"name" : "Eggs", "price" : "Invalid"}, schema=schema,
66     ... )                                   # doctest:
67 +IGNORE_EXCEPTION_DETAIL
68     Traceback (most recent call last):
69         ...
70     ValidationError: 'Invalid' is not of type 'number'
71
72 It can also be used from console:
73
74 .. code-block:: bash
75
76     $ jsonschema --instance sample.json sample.schema
77
78 Features
79 --------
80
81 * Partial support for
82   `Draft 2020-12
83 <https://python-jsonschema.readthedocs.io/en/latest/validate/#jsonschema.Draft202012Validator>`_
84 and
85   `Draft 2019-09
86 <https://python-jsonschema.readthedocs.io/en/latest/validate/#jsonschema.Draft201909Validator>`_,
87   except for dynamicRef / recursiveRef and ``$vocabulary`` (in-progress).
88   Full support for
89   [Draft 7],
90   [Draft 6],
91   [Draft 4]
92   and
93   [Draft 3]
94
95 * [Lazy validation]
96   that can iteratively report *all* validation errors.
97
98 * [Programmatic querying]
99   of which properties or items failed validation.
100
101 Installation
102 ------------
103
104 jsonschema is available on [PyPI]. You can install using [pip]:
105
106 .. code-block:: bash
107
108     $ pip install jsonschema
109
110 Running the Test Suite
111 ----------------------
112
113 If you have tox installed (perhaps via pip install tox or your
114 package manager), running tox in the directory of your source
115 checkout will run jsonschema's test suite on all of the versions
116 of Python jsonschema supports. If you don't have all of the
117 versions that jsonschema is tested under, you'll likely want to run
118 using tox's ``--skip-missing-interpreters`` option.
119
120 Of course you're also free to just run the tests on a single version with
121 your
122 favorite test runner. The tests live in the ``jsonschema.tests`` package.
123
124 Benchmarks
125 ----------
126
127 jsonschema's benchmarks make use of [pyperf
128 ]. Running them can be done via::
129
130       $ tox -e perf
131
132 Community
133 ---------
134
135 The JSON Schema specification has [a Slack
136 ], with an [invite link on its home page
137 ]. Many folks knowledgeable on authoring
138
139
140 [FILE:112:distinfo]
141 2a0f162822a64d95287990481b45d82f096e99721c86534f48201b64ebca6e8c        69377 jsonschema-4.2.1-py3-none-any.whl
142