Maintenance (#36)

* Updated dependencies, added support for Python 3.11 and Django 4.1, dropped support for Django 2.

* Flake 8 doesn't support Python < 3.8.

* CI action to create GH release.

* Updated example app, docker-compose, Dockerfile, added black, some small fixes.

* Dropped Python 3.7 support.

Author: tyomo4ka

.github/workflows/ci.yml

@@ -15,12 +15,14 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python: [ "3.7", "3.8", "3.9", "3.10" ]
-        django: [ "2.2.26", "3.2.11", "4.0.1" ]
+        python: ["3.8", "3.9", "3.10", "3.11"]
+        django: ["3.2.16", "4.0.8", "4.1.4" ]
         exclude:
-        # excludes Django 4 on Python 3.7
-        - python: 3.7
-          django: 4.0.1
+        # Excludes Python 3.11 for Django < 4.1
+        - python: 3.11
+          django: 3.2.16
+        - python: 3.11
+          django: 4.0.8
 
     services:
       postgres:
@@ -58,7 +60,7 @@ jobs:
       - uses: actions/checkout@master
       - uses: actions/setup-python@v2
         with:
-          python-version: 3.9
+          python-version: 3.10
           architecture: x64
       - run: pip install --upgrade pip
       - run: pip install poetry
@@ -70,3 +72,15 @@ jobs:
       - uses: pypa/gh-action-pypi-publish@master
         with:
           password: ${{ secrets.pypi_password }}
+      - uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ github.ref }}
+          release_name: ${{ github.ref }}
+          body: |
+            Changes:
+            - ...
+            - ...
+          draft: true
+          prerelease: false

.gitignore

@@ -25,9 +25,6 @@ output/*/index.html
 # Sphinx
 docs/_build
 
-# Docker-compose
-/data
-
 # Poetry
 poetry.lock
 /dist

Dockerfile

@@ -1,10 +1,9 @@
-FROM python:3.7
+FROM python:3.10
 
 ENV PYTHONUNBUFFERED 1
 
 RUN mkdir /code
 WORKDIR /code
-COPY . /code/
 
 RUN pip install poetry
 RUN poetry config virtualenvs.create false

README.rst

@@ -17,24 +17,25 @@ in Django projects.
 Motivation
 ----------
 
-`JSON types <https://www.postgresql.org/docs/10/datatype-json.html>`_ is a cool feature of
-Postgres that allows combining both relational and non-relational approaches to storing data. In most cases
-it leads to a simpler database design.
-
-The `JSONField <https://docs.djangoproject.com/en/3.1/ref/contrib/postgres/fields/#jsonfield>`_ in Django provides a
-nice way of using **json** and **jsonb** Postgres types in the model classes. ORM can even allow you to perform queries
-against the data stored inside the JSON structure. Moreover, it is possible to use
-`GIN indexes <https://www.postgresql.org/docs/12/datatype-json.html#JSON-INDEXING>`_ with **jsonb** types in Postgres, what
-makes it a useful tool in the application design and opens a wide range of possibilities such as polymorphic behaviour,
-storing complex hierarchies and lists of related entities, etc.
-
-However, the main limitation of JSONField in Django is a lack of good support of UI for JSON structures as defining JSON objects
+`JSON types <https://www.postgresql.org/docs/10/datatype-json.html>`_ in Postgres allow combining both relational
+and non-relational approaches to storing data. That can lead to a simpler database design in the most cases.
+
+Django provides ORM support for JSON types in Postgres and other databases via the
+`JSONField model field <https://docs.djangoproject.com/en/4.1/ref/models/fields/#django.db.models.JSONField>`_. Also the
+`JSONField form field <https://docs.djangoproject.com/en/4.1/ref/forms/fields/#jsonfield>`_ allows basic support of JSON in forms.
+Django ORM even `allows querying <https://docs.djangoproject.com/en/4.1/topics/db/queries/#querying-jsonfield>`_ against the data stored
+inside the JSON structures. Moreover, it is possible to improve performance of these queries using
+`GIN indexes <https://www.postgresql.org/docs/15/datatype-json.html#JSON-INDEXING>`_ with **jsonb** types
+`in Django <https://docs.djangoproject.com/en/4.1/ref/contrib/postgres/indexes/#ginindex>`_, which
+makes opens up a wide range of possibilities for simplifying application design, such as polymorphic collections, storing complex hierarchies in JSON, lists of related entities, etc.
+
+However, the main limitation of JSONField in Django is the lack of good support of UI for JSON structures as defining JSON objects
 inside the textarea inputs is not practical for most use cases. django-reactive tries to address this problem by offering an
 integration between JSONField and the awesome `react-jsonschema-form <https://github.com/mozilla-services/react-jsonschema-form>`_
 (RJSF) JavaScript library.
 
 django-reactive also uses Python `jsonschema <https://github.com/Julian/jsonschema>` library for backend validation. Such integration
-can significantly reduce the amount of work you need to contribute into building custom forms for JSONField types.
+can significantly reduce the amount of work needed for building custom forms for JSONField types.
 
 In most cases it only requires a JSON schema configuration for such field and optionally a UI schema
 to modify some representation parameters.
@@ -142,7 +143,7 @@ Running the example
 
 Build the docker image for the Django application in `example/`:
 
-* Run `docker-compose up -d`
+* Run `docker compose up -d`
 
 This will automatically create the database, run migrations, import the default superuser, and run the Django development server on `http://127.0.0.1:8000`.
 
@@ -254,19 +255,21 @@ Features
 * React, RJSF and other JS assets are bundled with the package.
 * Integration with default Django admin theme.
 * Backend and frontend validation.
-* Configurable static media assets
-* Dynamic schema mutation in widget renders
+* Configurable static media assets.
+* Dynamic schema mutation in widget renders.
 
 Limitations
 -----------
 
 * `Additional properties <https://github.com/mozilla-services/react-jsonschema-form#expandable-option>`_ ( a feature of RJSF) is not supported.
 
-To implement this behaviour you can define an array schema with one property serving as a key of the object and do
-transformation in your JSON class. An example will be provided later.
+To implement this behavior you can define an array schema with one property serving as a key of the object and do
+transformation in the Django form.
+
+* An outdated version (1.8) of RJSF is used in this project.  Not all features of RJSF 1.8 are compatible with JSON Schema 4.0. Please, refer to the documentation if any issues.
 
 Future development
 ------------------
 
-* Display description as tooltips
-* Polish styles and HTML generated by **RJSF**
+* At the moment there is no plans to add new features or support a newer version of RJSF.
+* Probably, it is a good idea to replace RJSF with a more Django-friendly solution. It would require significant development effort though, that's why the idea is put on back burner at the moment.

bin/wait-for

@@ -0,0 +1,82 @@
+#!/bin/usr/env python
+
+from optparse import OptionParser
+import socket
+import time
+import sys
+
+
+class OptionException(Exception):
+    def __init__(self, value):
+        self.value = value
+
+
+class wait_for_app:
+    def log(self, loginfo):
+        if self.options.quiet is not False:
+            print(loginfo)
+
+    def build_log(self, type, app, time=0):
+        # 1=enable_timeout,2=disable_timeout,3=success_msg,4=unavailable,5=timeout_msg
+        loginfo = {
+            1: "%s: waiting %d seconds for %s" % (sys.argv[0], time, app),
+            2: "%s: waiting for %s without a timeout" % (sys.argv[0], app),
+            3: "%s: %s is available after %d seconds" % (sys.argv[0], app, time),
+            4: "%s: %s is unavailable" % (sys.argv[0], app),
+            5: "%s: timeout occurred after waiting %d seconds for %s" % (sys.argv[0], time, app),
+        }.get(type)
+        return loginfo
+
+    def wait_for(self, host, port, timeout):
+        self.app = ("%s:%d") % (host, port)
+        sk = socket.socket()
+        logmsg = self.build_log(2, self.app, timeout)
+        if timeout != 0:
+            logmsg = self.build_log(1, self.app, timeout)
+            sk.settimeout(timeout)
+        self.log(logmsg)
+        start_ts = int(time.time())
+        sk.connect((host, port))
+        end_ts = int(time.time())
+        diff_ts = end_ts - start_ts
+        logmsg = self.build_log(3, self.app, diff_ts)
+        self.log(logmsg)
+
+    def get_parser(self):
+        parser = OptionParser()
+        parser.add_option("-a", "--address", dest="address", help="Host or IP under test")
+        parser.add_option("-p", "--port", dest="port", help="TCP port under test")
+        parser.add_option(
+            "-t", "--timeout", dest="timeout", default="15", help="Timeout in seconds, zero for no timeout"
+        )
+        parser.add_option("-q", "--quiet", dest="quiet", action="store_false", help="Don't output any status messages")
+        return parser
+
+    def verify_options(self):
+        if self.options.address is None:
+            raise OptionException("The address must be set!")
+        elif self.options.port is None:
+            raise OptionException("The port must be set!")
+        elif str(self.options.port).isnumeric() is False:
+            raise OptionException("The value of port must be number!")
+
+    def start_up(self):
+        try:
+            parser = self.get_parser()
+            self.options, self.args = parser.parse_args()
+            self.verify_options()
+            self.wait_for(self.options.address, int(self.options.port), int(self.options.timeout))
+        except OptionException as err:
+            print(err)
+            parser.print_help()
+        except socket.timeout as err:
+            logmsg = self.build_log(5, self.app, int(self.options.timeout))
+            self.log(logmsg)
+        except ConnectionRefusedError as err:
+            logmsg = self.build_log(4, self.app)
+            self.log(logmsg)
+
+
+if __name__ == "__main__":
+    w = wait_for_app()
+    w.start_up()

bin/wait_for_it.py

@@ -1 +1 @@
-default_app_config = 'django_reactive.apps.DjangoReactJsonSchemaFormConfig'
+default_app_config = "django_reactive.apps.DjangoReactJsonSchemaFormConfig"

django_reactive/__init__.py

@@ -3,4 +3,4 @@
 
 
 class DjangoReactJsonSchemaFormConfig(AppConfig):
-    name = 'django_reactive'
+    name = "django_reactive"

django_reactive/apps.py

@@ -12,15 +12,7 @@
 
 
 class ReactJSONSchemaField(BaseJSONField):
-    def __init__(
-        self,
-        schema=None,
-        ui_schema=None,
-        on_render=None,
-        extra_css=None,
-        extra_js=None,
-        **kwargs
-    ):
+    def __init__(self, schema=None, ui_schema=None, on_render=None, extra_css=None, extra_js=None, **kwargs):
         kwargs.setdefault("default", dict)
         super(ReactJSONSchemaField, self).__init__(**kwargs)
         self.schema = schema

django_reactive/fields.py

@@ -3,10 +3,10 @@ version: "3.5"
 services:
 
   db:
-    image: postgres:12-alpine
+    image: postgres:15-alpine
     restart: always
     volumes:
-      - "./data/pgdata:/var/lib/postgresql/data"
+      - db_vol:/var/lib/postgresql/data
     ports:
       - 5432:5432
     environment:
@@ -24,7 +24,7 @@ services:
   web:
     build: .
     command: >
-      sh -c './wait-for db:5432 --
+      sh -c 'python /code/bin/wait_for_it.py -a db -p 5432 --
           python example/manage.py makemigrations &&
           python example/manage.py migrate &&
           python example/manage.py loaddata admin &&
@@ -35,3 +35,6 @@ services:
       - "8000:8000"
     depends_on:
       - db
+
+volumes:
+  db_vol: ~