Metadata-Version: 2.1
Name: drf-jsonschema-serializer
Version: 3.0.0
Summary: JSON Schema support for Django REST Framework
Author-email: Maykin Media <support@maykinmedia.nl>, ISProjects <support@isprojects.nl>
License: Copyright (c) 2017, ISProjects
        Copyright (c) 2023, Maykin Media
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
            * Redistributions of source code must retain the above copyright
              notice, this list of conditions and the following disclaimer.
            * Redistributions in binary form must reproduce the above copyright
              notice, this list of conditions and the following disclaimer in the
              documentation and/or other materials provided with the distribution.
            * Neither the name of the <organization> nor the
              names of its contributors may be used to endorse or promote products
              derived from this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
        ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
        WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL FANSTATIC DEVELOPERS BE LIABLE FOR ANY
        DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
        (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
        LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
        ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
        (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
        SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
        
Project-URL: Homepage, https://github.com/maykinmedia/drf-jsonschema-serializer
Project-URL: Documentation, https://drf-jsonschema.readthedocs.io/en/stable/
Project-URL: Bug Tracker, https://github.com/maykinmedia/drf-jsonschema-serializer/issues
Project-URL: Source Code, https://github.com/maykinmedia/drf-jsonschema-serializer
Project-URL: Changelog, https://github.com/maykinmedia/drf-jsonschema-serializer/blob/main/docs/changelog.rst
Keywords: django,rest,polymorphic
Classifier: Development Status :: 5 - Production/Stable
Classifier: Framework :: Django
Classifier: Framework :: Django :: 4.2
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: Unix
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.10
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: django >=4.2
Requires-Dist: djangorestframework >=3.13
Requires-Dist: jsonschema >=4.0.0
Provides-Extra: all-format-validators
Requires-Dist: fqdn ; extra == 'all-format-validators'
Requires-Dist: idna ; extra == 'all-format-validators'
Requires-Dist: rfc3987 ; extra == 'all-format-validators'
Requires-Dist: rfc3339-validator ; extra == 'all-format-validators'
Requires-Dist: webcolors ; extra == 'all-format-validators'
Requires-Dist: jsonpointer ; extra == 'all-format-validators'
Requires-Dist: uri-template ; extra == 'all-format-validators'
Requires-Dist: isoduration ; extra == 'all-format-validators'
Provides-Extra: coverage
Requires-Dist: pytest-cov ; extra == 'coverage'
Provides-Extra: docs
Requires-Dist: sphinx ; extra == 'docs'
Requires-Dist: sphinx-rtd-theme ; extra == 'docs'
Provides-Extra: release
Requires-Dist: bump-my-version ; extra == 'release'
Requires-Dist: twine ; extra == 'release'
Provides-Extra: tests
Requires-Dist: fqdn ; extra == 'tests'
Requires-Dist: idna ; extra == 'tests'
Requires-Dist: rfc3987 ; extra == 'tests'
Requires-Dist: rfc3339-validator ; extra == 'tests'
Requires-Dist: webcolors ; extra == 'tests'
Requires-Dist: jsonpointer ; extra == 'tests'
Requires-Dist: uri-template ; extra == 'tests'
Requires-Dist: isoduration ; extra == 'tests'
Requires-Dist: pytest ; extra == 'tests'
Requires-Dist: pytest-django ; extra == 'tests'
Requires-Dist: tox ; extra == 'tests'
Requires-Dist: isort ; extra == 'tests'
Requires-Dist: black ; extra == 'tests'
Requires-Dist: flake8 ; extra == 'tests'
Requires-Dist: mypy ; extra == 'tests'
Requires-Dist: django-stubs[compatible-mypy] ; extra == 'tests'
Requires-Dist: djangorestframework-stubs[compatible-mypy] ; extra == 'tests'
Requires-Dist: types-jsonschema ; extra == 'tests'

=========================================
Django REST Framework JSON Schema support
=========================================

:Version: 3.0.0
:Source: https://github.com/maykinmedia/drf-jsonschema-serializer
:Keywords: django, rest, jsonschema

|build-status| |coverage| |linting| |black| |docs|

|python-versions| |django-versions| |pypi-version|

JSON Schema support for Django REST Framework

Overview
========

drf-jsonschema-serializer is a library built around Django REST Framework. It does the
following:

* Convert a DRF serializer into a JSON Schema.

* Provides ``JSONSchemaField`` that can validate JSON data according to
  a JSON schema.

* Provides a ``SerializerJSONField`` that can validate JSON data according to
  a serializer for a field.

This lets you use client-side form libraries such as react-jsonschema-form to
generate a web form from a serializer. This way you can use the same schema for
client-side form generation and validation as you use for REST service input
validation.

See the documentation_ for getting started and usage examples.

Credits and roadmap
===================

Many thanks to https://github.com/isprojects for the initial work on this library.
As of September 2021, Maykin Media has taken up maintenance of this package after
transferring it from isprojects. See the issues on Github for the roadmap.

See also CREDITS.txt for a full history of authorship.

.. |build-status| image:: https://github.com/maykinmedia/drf-jsonschema-serializer/actions/workflows/ci.yml/badge.svg
    :target: https://github.com/maykinmedia/drf-jsonschema-serializer/actions/workflows/ci.yml
    :alt: Tests and PyPI publishing

.. |linting| image:: https://github.com/maykinmedia/drf-jsonschema-serializer/actions/workflows/code-quality.yml/badge.svg
    :target: https://github.com/maykinmedia/drf-jsonschema-serializer/actions/workflows/code-quality.yml
    :alt: Linting and code quality

.. |coverage| image:: https://codecov.io/gh/maykinmedia/drf-jsonschema-serializer/branch/main/graph/badge.svg
    :target: https://app.codecov.io/gh/maykinmedia/drf-jsonschema-serializer
    :alt: Coverage status

.. |python-versions| image:: https://img.shields.io/pypi/pyversions/drf-jsonschema-serializer.svg

.. |django-versions| image:: https://img.shields.io/pypi/frameworkversions/django/drf-jsonschema-serializer.svg

.. |pypi-version| image:: https://img.shields.io/pypi/v/drf-jsonschema-serializer.svg
    :target: https://pypi.org/project/drf-jsonschema-serializer/

.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :target: https://github.com/psf/black

.. |docs| image:: https://readthedocs.org/projects/drf-jsonschema-serializer/badge/?version=latest
    :target: https://drf-jsonschema-serializer.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status

.. _documentation: https://drf-jsonschema.readthedocs.io/
