Metadata-Version: 2.1
Name: drf-jsonschema-serializer
Version: 2.0.0
Summary: JSON Schema support for Django REST Framework
Home-page: https://github.com/maykinmedia/drf-jsonschema-serializer
Author: ISProjects, Maykin Media
Author-email: support@maykinmedia.nl
License: BSD
Project-URL: Documentation, http://drf-jsonschema-serializer.readthedocs.io/en/latest/
Project-URL: Changelog, https://github.com/maykinmedia/drf-jsonschema-serializer/blob/main/docs/changelog.rst
Project-URL: Bug Tracker, https://github.com/maykinmedia/drf-jsonschema-serializer/issues
Project-URL: Source Code, https://github.com/maykinmedia/drf-jsonschema-serializer
Keywords: django,rest,polymorphic
Classifier: Development Status :: 5 - Production/Stable
Classifier: Framework :: Django
Classifier: Framework :: Django :: 3.2
Classifier: Framework :: Django :: 4.1
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.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Provides-Extra: all-format-validators
Provides-Extra: tests
Provides-Extra: coverage
Provides-Extra: docs
Provides-Extra: release
License-File: LICENSE

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

:Version: 2.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/
