Metadata-Version: 2.1
Name: jsonschema-rs
Version: 0.6.1
Summary: Fast JSON Schema validation for Python implemented in Rust
Home-page: https://github.com/Stranger6667/jsonschema-rs/tree/master/python
Author: Dmitry Dygalo
Author-email: dadygalo@gmail.com
Maintainer: Dmitry Dygalo
Maintainer-email: dadygalo@gmail.com
License: MIT
Description: jsonschema-rs
        =============
        
        |Build| |Version| |Python versions| |License|
        
        Fast JSON Schema validation for Python implemented in Rust.
        
        Supported drafts:
        
        - Draft 7
        - Draft 6
        - Draft 4
        
        There are some notable restrictions at the moment:
        
        - The underlying crate doesn't support arbitrary precision integers yet, which may lead to ``SystemError`` when such value is used;
        - ``multipleOf`` keyword validation may produce false-negative results on some input. See `#84 <https://github.com/Stranger6667/jsonschema-rs/issues/84>`_ for more details
        
        Installation
        ------------
        
        To install ``jsonschema-rs`` via ``pip`` run the following command:
        
        .. code:: bash
        
            pip install jsonschema-rs
        
        Usage
        -----
        
        To check if the input document is valid:
        
        .. code:: python
        
            import jsonschema_rs
        
            validator = jsonschema_rs.JSONSchema({"minimum": 42})
            validator.is_valid(45)  # True
        
        or:
        
        .. code:: python
        
            import jsonschema_rs
        
            validator = jsonschema_rs.JSONSchema({"minimum": 42})
            validator.validate(41)  # raises ValidationError
        
        **NOTE**. This library is in early development.
        
        Performance
        -----------
        
        According to our benchmarks, ``jsonschema-rs`` is usually faster than existing alternatives in real-life scenarios.
        
        However, for single-keyword or boolean schemas it might be slower than ``fastjsonschema`` or ``jsonschema`` on PyPy.
        
        Schemas:
        
        - ``kubernetes-openapi`` is an Open API schema for `Kubernetes <https://raw.githubusercontent.com/APIs-guru/openapi-directory/master/APIs/kubernetes.io/v1.10.0/swagger.yaml>`_ which is ~3.15 MB JSON file.
        - ``small`` is taken from ``fastjsonschema`` benchmarks.
        
        Compiled validators (when the input schema is compiled once and reused later). ``jsonschema-rs`` comes in two variants in the table below:
        
        - ``validate``. This method raises ``ValidationError`` on errors or returns ``None`` on their absence.
        - ```is_valid``. A faster method that returns a boolean result whether the instance is valid.
        
        Ratios are given against the ``validate`` variant.
        
        +-------------------------+------------------------+-----------------------+----------------------------+---------------------------+
        | library                 | ``false``              |  ``{"minimum": 10}``  |  small                     |   kubernetes-openapi      |
        +=========================+========================+=======================+============================+===========================+
        | jsonschema-rs[validate] |              200.51 ns |             203.30 ns |                    1.09 us |                  14.97 ms |
        +-------------------------+------------------------+-----------------------+----------------------------+---------------------------+
        | jsonschema-rs[is_valid] |  186.00 ns (**x0.92**) | 186.79 ns (**x0.91**) |      884.40 ns (**x0.81**) |      13.94 ms (**x0.93**) |
        +-------------------------+------------------------+-----------------------+----------------------------+---------------------------+
        | fastjsonschema[CPython] |   58.57 ns (**x0.29**) | 109.10 ns (**x0.53**) |        4.21 us (**x3.86**) |      91.79 ms (**x6.13**) |
        +-------------------------+------------------------+-----------------------+----------------------------+---------------------------+
        | fastjsonschema[PyPy]    |   1.32 ns (**x0.006**) |  33.39 ns (**x0.16**) |        1.17 us (**x1.07**) |      44.27 ms (**x2.95**) |
        +-------------------------+------------------------+-----------------------+----------------------------+---------------------------+
        | jsonschema[CPython]     |  226.48 ns (**x1.12**) |   1.88 us (**x9.24**) |      58.14 us (**x53.33**) |       1.07 s (**x71.47**) |
        +-------------------------+------------------------+-----------------------+----------------------------+---------------------------+
        | jsonschema[PyPy]        |   41.18 ns (**x0.20**) | 224.94 ns (**x1.10**) |      25.97 us (**x23.82**) |    663.30 ms (**x44.30**) |
        +-------------------------+------------------------+-----------------------+----------------------------+---------------------------+
        
        The bigger the input is the bigger is performance win. You can take a look at benchmarks in ``benches/bench.py``.
        
        Package versions:
        
        - ``jsonschema-rs`` - latest version from the repository
        - ``jsonschema`` - ``3.2.0``
        - ``fastjsonschema`` - ``2.15.0``
        
        Measured with stable Rust 1.49, CPython 3.9.1 / PyPy3 7.3.3 on i8700K (12 cores), 32GB RAM, Arch Linux.
        
        Python support
        --------------
        
        ``jsonschema-rs`` supports CPython 3.6, 3.7, 3.8 and 3.9.
        
        License
        -------
        
        The code in this project is licensed under `MIT license`_.
        By contributing to ``jsonschema-rs``, you agree that your contributions
        will be licensed under its MIT license.
         
        .. |Build| image:: https://github.com/Stranger6667/jsonschema-rs/workflows/ci/badge.svg
           :target: https://github.com/Stranger6667/jsonschema-rs/actions
        .. |Version| image:: https://img.shields.io/pypi/v/jsonschema-rs.svg
           :target: https://pypi.org/project/jsonschema-rs/
        .. |Python versions| image:: https://img.shields.io/pypi/pyversions/jsonschema-rs.svg
           :target: https://pypi.org/project/jsonschema-rs/
        .. |License| image:: https://img.shields.io/pypi/l/jsonschema-rs.svg
           :target: https://opensource.org/licenses/MIT
        
        .. _MIT license: https://opensource.org/licenses/MIT
        
Keywords: jsonschema validation rust
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Rust
Requires-Python: >=3.6
Description-Content-Type: text/x-rst
