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