diff options
author | Julian Berman <Julian@GrayVines.com> | 2022-12-05 14:07:19 -0500 |
---|---|---|
committer | Julian Berman <Julian@GrayVines.com> | 2022-12-05 14:07:19 -0500 |
commit | 29fbba12934b77d707fe5a66d65ac60cb5cc1f27 (patch) | |
tree | e103c07d9040fae34e2aeeae380d0c794113b815 | |
parent | 1c60cc80126f6f35a60b4e9fb1a046d826bdc340 (diff) | |
download | jsonschema-29fbba12934b77d707fe5a66d65ac60cb5cc1f27.tar.gz |
Finish formatting the README via one sentence per line.
-rw-r--r-- | README.rst | 67 |
1 files changed, 22 insertions, 45 deletions
@@ -25,13 +25,13 @@ jsonschema :target: https://results.pre-commit.ci/latest/github/python-jsonschema/jsonschema/main .. |Zenodo| image:: https://zenodo.org/badge/3072629.svg + :alt: Zenodo DOI :target: https://zenodo.org/badge/latestdoi/3072629 -``jsonschema`` is an implementation of the `JSON Schema -<https://json-schema.org>`_ specification for Python. +``jsonschema`` is an implementation of the `JSON Schema <https://json-schema.org>`_ specification for Python. -.. code-block:: python +.. code:: python >>> from jsonschema import validate @@ -59,22 +59,12 @@ It can also be used from the command line by installing `check-jsonschema <https Features -------- -* Partial support for - `Draft 2020-12 <https://python-jsonschema.readthedocs.io/en/latest/api/jsonschema/validators/#jsonschema.validators.Draft202012Validator>`_ and - `Draft 2019-09 <https://python-jsonschema.readthedocs.io/en/latest/api/jsonschema/validators/#jsonschema.validators.Draft201909Validator>`_, - except for ``dynamicRef`` / ``recursiveRef`` and ``$vocabulary`` (in-progress). - Full support for - `Draft 7 <https://python-jsonschema.readthedocs.io/en/latest/api/jsonschema/validators/#jsonschema.validators.Draft7Validator>`_, - `Draft 6 <https://python-jsonschema.readthedocs.io/en/latest/api/jsonschema/validators/#jsonschema.validators.Draft6Validator>`_, - `Draft 4 <https://python-jsonschema.readthedocs.io/en/latest/api/jsonschema/validators/#jsonschema.validators.Draft4Validator>`_ - and - `Draft 3 <https://python-jsonschema.readthedocs.io/en/latest/api/jsonschema/validators/#jsonschema.validators.Draft3Validator>`_ +* Partial support for `Draft 2020-12 <https://python-jsonschema.readthedocs.io/en/latest/api/jsonschema/validators/#jsonschema.validators.Draft202012Validator>`_ and `Draft 2019-09 <https://python-jsonschema.readthedocs.io/en/latest/api/jsonschema/validators/#jsonschema.validators.Draft201909Validator>`_, except for ``dynamicRef`` / ``recursiveRef`` and ``$vocabulary`` (in-progress). + Full support for `Draft 7 <https://python-jsonschema.readthedocs.io/en/latest/api/jsonschema/validators/#jsonschema.validators.Draft7Validator>`_, `Draft 6 <https://python-jsonschema.readthedocs.io/en/latest/api/jsonschema/validators/#jsonschema.validators.Draft6Validator>`_, `Draft 4 <https://python-jsonschema.readthedocs.io/en/latest/api/jsonschema/validators/#jsonschema.validators.Draft4Validator>`_ and `Draft 3 <https://python-jsonschema.readthedocs.io/en/latest/api/jsonschema/validators/#jsonschema.validators.Draft3Validator>`_ -* `Lazy validation <https://python-jsonschema.readthedocs.io/en/latest/api/jsonschema/protocols/#jsonschema.protocols.Validator.iter_errors>`_ - that can iteratively report *all* validation errors. +* `Lazy validation <https://python-jsonschema.readthedocs.io/en/latest/api/jsonschema/protocols/#jsonschema.protocols.Validator.iter_errors>`_ that can iteratively report *all* validation errors. -* `Programmatic querying <https://python-jsonschema.readthedocs.io/en/latest/errors/>`_ - of which properties or items failed validation. +* `Programmatic querying <https://python-jsonschema.readthedocs.io/en/latest/errors/>`_ of which properties or items failed validation. Installation @@ -82,7 +72,7 @@ Installation ``jsonschema`` is available on `PyPI <https://pypi.org/project/jsonschema/>`_. You can install using `pip <https://pip.pypa.io/en/stable/>`_: -.. code-block:: bash +.. code:: bash $ pip install jsonschema @@ -97,7 +87,7 @@ Two extras are available when installing the package, both currently related to They can be used when installing in order to include additional dependencies, e.g.: -.. code-block:: bash +.. code:: bash $ pip install jsonschema'[format]' @@ -109,22 +99,18 @@ Please read the `format validation documentation <https://python-jsonschema.read Running the Test Suite ---------------------- -If you have ``tox`` installed (perhaps via ``pip install tox`` or your -package manager), running ``tox`` in the directory of your source -checkout will run ``jsonschema``'s test suite on all of the versions -of Python ``jsonschema`` supports. If you don't have all of the -versions that ``jsonschema`` is tested under, you'll likely want to run -using ``tox``'s ``--skip-missing-interpreters`` option. +If you have ``tox`` installed (perhaps via ``pip install tox`` or your package manager), running ``tox`` in the directory of your source checkout will run ``jsonschema``'s test suite on all of the versions of Python ``jsonschema`` supports. +If you don't have all of the versions that ``jsonschema`` is tested under, you'll likely want to run using ``tox``'s ``--skip-missing-interpreters`` option. -Of course you're also free to just run the tests on a single version with your -favorite test runner. The tests live in the ``jsonschema.tests`` package. +Of course you're also free to just run the tests on a single version with your favorite test runner. +The tests live in the ``jsonschema.tests`` package. Benchmarks ---------- -``jsonschema``'s benchmarks make use of `pyperf -<https://pyperf.readthedocs.io>`_. Running them can be done via:: +``jsonschema``'s benchmarks make use of `pyperf <https://pyperf.readthedocs.io>`_. +Running them can be done via:: $ tox -e perf @@ -132,13 +118,10 @@ Benchmarks Community --------- -The JSON Schema specification has `a Slack -<https://json-schema.slack.com>`_, with an `invite link on its home page -<https://json-schema.org/>`_. Many folks knowledgeable on authoring -schemas can be found there. +The JSON Schema specification has `a Slack <https://json-schema.slack.com>`_, with an `invite link on its home page <https://json-schema.org/>`_. +Many folks knowledgeable on authoring schemas can be found there. -Otherwise, asking questions on Stack Overflow is another means of -getting help if you're stuck. +Otherwise, opening a `GitHub discussion <https://github.com/python-jsonschema/jsonschema/discussions>`_ or asking questions on Stack Overflow are other means of getting help if you're stuck. .. end cut from PyPI @@ -150,16 +133,10 @@ I'm Julian Berman. ``jsonschema`` is on `GitHub <https://github.com/python-jsonschema/jsonschema>`_. -Get in touch, via GitHub or otherwise, if you've got something to contribute, -it'd be most welcome! +Get in touch, via GitHub or otherwise, if you've got something to contribute, it'd be most welcome! -You can also generally find me on Libera (nick: ``Julian``) in various -channels, including ``#python``. +You can also generally find me on Libera (nick: ``Julian``) in various channels, including ``#python``. -If you feel overwhelmingly grateful, you can also `sponsor me -<https://github.com/sponsors/Julian/>`_. +If you feel overwhelmingly grateful, you can also `sponsor me <https://github.com/sponsors/Julian/>`_. -And for companies who appreciate ``jsonschema`` and its continued support -and growth, ``jsonschema`` is also now supportable via `TideLift -<https://tidelift.com/subscription/pkg/pypi-jsonschema?utm_source=pypi-j -sonschema&utm_medium=referral&utm_campaign=readme>`_. +And for companies who appreciate ``jsonschema`` and its continued support and growth, ``jsonschema`` is also now supportable via `TideLift <https://tidelift.com/subscription/pkg/pypi-jsonschema?utm_source=pypi-jsonschema&utm_medium=referral&utm_campaign=readme>`_. |