Skip to content

Commit 29fbba1

Browse files
committed
Finish formatting the README via one sentence per line.
1 parent 1c60cc8 commit 29fbba1

File tree

1 file changed

+22
-45
lines changed

1 file changed

+22
-45
lines changed

README.rst

Lines changed: 22 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,13 @@ jsonschema
2525
:target: https://results.pre-commit.ci/latest/github/python-jsonschema/jsonschema/main
2626

2727
.. |Zenodo| image:: https://zenodo.org/badge/3072629.svg
28+
:alt: Zenodo DOI
2829
:target: https://zenodo.org/badge/latestdoi/3072629
2930

3031

31-
``jsonschema`` is an implementation of the `JSON Schema
32-
<https://json-schema.org>`_ specification for Python.
32+
``jsonschema`` is an implementation of the `JSON Schema <https://json-schema.org>`_ specification for Python.
3333

34-
.. code-block:: python
34+
.. code:: python
3535
3636
>>> from jsonschema import validate
3737
@@ -59,30 +59,20 @@ It can also be used from the command line by installing `check-jsonschema <https
5959
Features
6060
--------
6161

62-
* Partial support for
63-
`Draft 2020-12 <https://python-jsonschema.readthedocs.io/en/latest/api/jsonschema/validators/#jsonschema.validators.Draft202012Validator>`_ and
64-
`Draft 2019-09 <https://python-jsonschema.readthedocs.io/en/latest/api/jsonschema/validators/#jsonschema.validators.Draft201909Validator>`_,
65-
except for ``dynamicRef`` / ``recursiveRef`` and ``$vocabulary`` (in-progress).
66-
Full support for
67-
`Draft 7 <https://python-jsonschema.readthedocs.io/en/latest/api/jsonschema/validators/#jsonschema.validators.Draft7Validator>`_,
68-
`Draft 6 <https://python-jsonschema.readthedocs.io/en/latest/api/jsonschema/validators/#jsonschema.validators.Draft6Validator>`_,
69-
`Draft 4 <https://python-jsonschema.readthedocs.io/en/latest/api/jsonschema/validators/#jsonschema.validators.Draft4Validator>`_
70-
and
71-
`Draft 3 <https://python-jsonschema.readthedocs.io/en/latest/api/jsonschema/validators/#jsonschema.validators.Draft3Validator>`_
62+
* 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).
63+
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>`_
7264

73-
* `Lazy validation <https://python-jsonschema.readthedocs.io/en/latest/api/jsonschema/protocols/#jsonschema.protocols.Validator.iter_errors>`_
74-
that can iteratively report *all* validation errors.
65+
* `Lazy validation <https://python-jsonschema.readthedocs.io/en/latest/api/jsonschema/protocols/#jsonschema.protocols.Validator.iter_errors>`_ that can iteratively report *all* validation errors.
7566

76-
* `Programmatic querying <https://python-jsonschema.readthedocs.io/en/latest/errors/>`_
77-
of which properties or items failed validation.
67+
* `Programmatic querying <https://python-jsonschema.readthedocs.io/en/latest/errors/>`_ of which properties or items failed validation.
7868

7969

8070
Installation
8171
------------
8272

8373
``jsonschema`` is available on `PyPI <https://pypi.org/project/jsonschema/>`_. You can install using `pip <https://pip.pypa.io/en/stable/>`_:
8474

85-
.. code-block:: bash
75+
.. code:: bash
8676
8777
$ pip install jsonschema
8878
@@ -97,7 +87,7 @@ Two extras are available when installing the package, both currently related to
9787

9888
They can be used when installing in order to include additional dependencies, e.g.:
9989

100-
.. code-block:: bash
90+
.. code:: bash
10191
10292
$ pip install jsonschema'[format]'
10393
@@ -109,36 +99,29 @@ Please read the `format validation documentation <https://python-jsonschema.read
10999
Running the Test Suite
110100
----------------------
111101

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.
102+
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.
103+
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.
118104

119-
Of course you're also free to just run the tests on a single version with your
120-
favorite test runner. The tests live in the ``jsonschema.tests`` package.
105+
Of course you're also free to just run the tests on a single version with your favorite test runner.
106+
The tests live in the ``jsonschema.tests`` package.
121107

122108

123109
Benchmarks
124110
----------
125111

126-
``jsonschema``'s benchmarks make use of `pyperf
127-
<https://pyperf.readthedocs.io>`_. Running them can be done via::
112+
``jsonschema``'s benchmarks make use of `pyperf <https://pyperf.readthedocs.io>`_.
113+
Running them can be done via::
128114

129115
$ tox -e perf
130116

131117

132118
Community
133119
---------
134120

135-
The JSON Schema specification has `a Slack
136-
<https://json-schema.slack.com>`_, with an `invite link on its home page
137-
<https://json-schema.org/>`_. Many folks knowledgeable on authoring
138-
schemas can be found there.
121+
The JSON Schema specification has `a Slack <https://json-schema.slack.com>`_, with an `invite link on its home page <https://json-schema.org/>`_.
122+
Many folks knowledgeable on authoring schemas can be found there.
139123

140-
Otherwise, asking questions on Stack Overflow is another means of
141-
getting help if you're stuck.
124+
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.
142125

143126
.. end cut from PyPI
144127
@@ -150,16 +133,10 @@ I'm Julian Berman.
150133

151134
``jsonschema`` is on `GitHub <https://github.com/python-jsonschema/jsonschema>`_.
152135

153-
Get in touch, via GitHub or otherwise, if you've got something to contribute,
154-
it'd be most welcome!
136+
Get in touch, via GitHub or otherwise, if you've got something to contribute, it'd be most welcome!
155137

156-
You can also generally find me on Libera (nick: ``Julian``) in various
157-
channels, including ``#python``.
138+
You can also generally find me on Libera (nick: ``Julian``) in various channels, including ``#python``.
158139

159-
If you feel overwhelmingly grateful, you can also `sponsor me
160-
<https://github.com/sponsors/Julian/>`_.
140+
If you feel overwhelmingly grateful, you can also `sponsor me <https://github.com/sponsors/Julian/>`_.
161141

162-
And for companies who appreciate ``jsonschema`` and its continued support
163-
and growth, ``jsonschema`` is also now supportable via `TideLift
164-
<https://tidelift.com/subscription/pkg/pypi-jsonschema?utm_source=pypi-j
165-
sonschema&utm_medium=referral&utm_campaign=readme>`_.
142+
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>`_.

0 commit comments

Comments
 (0)