django-json-schema-model 0.1.0

JSON schema model for django.

1 Welcome to django-json-schema-model’s documentation!

Version:

0.1.0

Source:

https://github.com/maykinmedia/django-json-schema-model

Keywords:

<keywords>

PythonVersion:

3.10

A reusable Django app to store JSON schemas.

Contents

• 1 Welcome to django-json-schema-model’s documentation!

• 2 Features

• 3 Installation

  • 3.1 Requirements

  • 3.2 Install

• 4 Usage

• 5 Local development

2 Features

• JsonSchemaModel consisting of

  • name CharField

  • schema JsonField

  • validate(json) method to validate JSON against the schema.

3 Installation

3.1 Requirements

• Python 3.10 or above

• Django 4.2 or newer

• A database supporting django.db.models.JSONField

3.2 Install

pip install django-json-schema-model

4 Usage

from django_json_schema_model.models import JsonSchema

class ProductType(models.Model):
    schema = models.ForeignKey(JsonSchema, on_delete=models.PROTECT)

class Product(models.Model):
    json = models.JsonField()
    type = models.ForeignKey(ProductType, on_delete=models.CASCADE)

    def clean(self):
        self.type.schema.validate(self.json)

5 Local development

To install and develop the library locally, use:

.. code-block:: bash

pip install -e .[tests,coverage,docs,release]

When running management commands via django-admin, make sure to add the root directory to the python path (or use python -m django <command>):

export PYTHONPATH=. DJANGO_SETTINGS_MODULE=testapp.settings
django-admin check
# or other commands like:
# django-admin makemessages -l nl