dynamicforms 0.76.14__tar.gz

dynamicforms-0.76.14/.actrc

@@ -0,0 +1,2 @@
+# sample .actrc file
+-P ubuntu-latest=nektos/act-environments-ubuntu:18.04

dynamicforms-0.76.14/.coveragerc

@@ -0,0 +1,15 @@
+[run]
+plugins =
+    django_coverage_plugin
+
+source = dynamicforms
+
+omit =
+    doc/*
+    tests/*
+    setup/wsgi.py
+    rest_framework/*
+
+[report]
+show_missing = true
+precision = 2

dynamicforms-0.76.14/.github/workflows/Python tests.yml

@@ -0,0 +1,183 @@
+name: Python tests
+on: [push]
+env:
+  GITHUB_ACTIONS: 1
+
+jobs:
+  ubuntu_firefox:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python: [3.9, "3.10"]
+      fail-fast: false
+
+    env:
+      BROWSER_SELENIUM: 'FIREFOX;{"headless": true, "binary_location": "/usr/bin/firefox"}'
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Prepare Selenium enviroment
+        run: |
+          #Download geckodriver
+          wget https://github.com/mozilla/geckodriver/releases/download/v0.30.0/geckodriver-v0.30.0-linux64.tar.gz
+          #Extract geckodriver
+          tar -xvzf geckodriver*
+          #Make geckodriver executable
+          chmod +x geckodriver
+          #Move geckodriver
+          sudo mv geckodriver /usr/local/bin/
+
+      - name: Setup Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python }}
+      - name: Install Tox and any other packages
+        run: |
+          pip install versio
+          pip install tox
+
+      - name: Run Tox py-django3
+        if: (success() || failure())
+        run: tox -e py-django32-drf314
+
+      - name: Run Tox py-django4
+        if: (success() || failure())
+        run: tox -e py-django42-drf314,py-django42-drftip
+
+      - name: Run Tox py-djangotip-drftip
+        if: (success() || failure())
+        continue-on-error: true
+        run: tox -e py-djangotip-drftip
+
+# TODO: uncomment tests when JSON field is supported for older versions and other browsers tested
+
+#  ubuntu_chrome:
+#    runs-on: ubuntu-latest
+#    strategy:
+#      matrix:
+#        python: [3.8, 3.9]
+#      fail-fast: false
+#
+#    env:
+#      BROWSER_SELENIUM: 'CHROME;{"no-sandbox": true, "window-size": "1420,1080", "headless": true, "disable-gpu": true}'
+#
+#    steps:
+#      - uses: actions/checkout@v1
+#      - uses: nanasess/setup-chromedriver@master
+#      - run: |
+#          export DISPLAY=:99
+#          chromedriver --url-base=/wd/hub &
+#          sudo Xvfb -ac :99 -screen 0 1280x1024x24 > /dev/null 2>&1 & # optional
+#
+#      - name: Setup Python
+#        uses: actions/setup-python@v1
+#        with:
+#          python-version: ${{ matrix.python }}
+#      - name: Install Tox and any other packages
+#        run: |
+#          pip install tox
+#
+#      - name: Run Tox py-django22
+#        if: success() || failure()
+#        continue-on-error: true
+#        run: tox -e py-django22-drf310,py-django22-drf311,py-django22-drf312,py-django22-drftip
+#
+#      - name: Run Tox py-django30
+#        if: success() || failure()
+#        continue-on-error: true
+#        run: tox -e py-django30-drf310,py-django30-drf311,py-django30-drf312,py-django30-drftip
+#
+#      - name: Run Tox py-django31
+#        if: (success() || failure())
+#        continue-on-error: true
+#        run: tox -e py-django31-drf311,py-django31-drf312,py-django31-drftip
+#
+#      - name: Run Tox py-djangotip-drftip
+#        if: (success() || failure())
+#        continue-on-error: true
+#        run: tox -e py-djangotip-drftip
+#
+#  macos_safari:
+#    runs-on: macos-latest
+#    strategy:
+#      matrix:
+#        python: [3.8, 3.9]
+#      fail-fast: false
+#      max-parallel: 1
+#
+#    # Da bodo delali fukcionalni testi v Safariju morajo najprej urediti issue https://github.com/actions/virtual-environments/issues/91
+#    env:
+#      BROWSER_SELENIUM: 'SAFARI'
+#
+#    steps:
+#      - uses: actions/checkout@v1
+#      - run: sudo safaridriver --enable
+#
+#      - name: Setup Python
+#        uses: actions/setup-python@v1
+#        with:
+#          python-version: ${{ matrix.python }}
+#
+#      - name: Install Tox and any other packages
+#        run: |
+#          pip install versio
+#          pip install tox
+#
+#      - name: Run Tox py-django22
+#        if: success() || failure()
+#        continue-on-error: true
+#        run: tox -e py-django22-drf310,py-django22-drf311,py-django22-drf312,py-django22-drftip
+#
+#      - name: Run Tox py-django30
+#        if: success() || failure()
+#        continue-on-error: true
+#        run: tox -e py-django30-drf310,py-django30-drf311,py-django30-drf312,py-django30-drftip
+#
+#      - name: Run Tox py-django31
+#        if: (success() || failure())
+#        continue-on-error: true
+#        run: tox -e py-django31-drf311,py-django31-drf312,py-django31-drftip
+#
+#      - name: Run Tox py-djangotip-drftip
+#        if: (success() || failure())
+#        continue-on-error: true
+#        run: tox -e py-djangotip-drftip
+
+#  win_edge:
+#    runs-on: windows-latest
+#    strategy:
+#      matrix:
+#        python: [3.8, 3.9]
+#      fail-fast: false
+#
+#    # Da bodo delali fukcionalni testi v Edge-ju morajo najprej urediti issue https://github.com/actions/virtual-environments/issues/99
+#    env:
+#      BROWSER_SELENIUM: 'EDGE'
+#
+#    steps:
+#      - uses: actions/checkout@v1
+#      - name: Setup Python
+#        uses: actions/setup-python@v1
+#        with:
+#          python-version: ${{ matrix.python }}
+#      - name: Install Tox and any other packages
+#        run: |
+#          pip install versio
+#          pip install tox
+#
+#      - name: Run Tox py-django22
+#        if: success() || failure()
+#        run: tox -e py-django22-drf310,py-django22-drf311,py-django22-drf312,py-django22-drftip
+#
+#      - name: Run Tox py-django30
+#        if: success() || failure()
+#        run: tox -e py-django30-drf310,py-django30-drf311,py-django30-drf312,py-django30-drftip
+#
+#      - name: Run Tox py-django31
+#        if: (success() || failure())
+#        run: tox -e py-django31-drf311,py-django31-drf312,py-django31-drftip
+#
+#      - name: Run Tox py-djangotip-drftip
+#        if: (success() || failure())
+#        continue-on-error: true
+#        run: tox -e py-djangotip-drftip

dynamicforms-0.76.14/.github/workflows/check_code.yml

@@ -0,0 +1,12 @@
+name: Code check
+
+on: [push, pull_request]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: chartboost/ruff-action@v1
+        with:
+          args: "check --diff"

dynamicforms-0.76.14/.github/workflows/check_doc.yml

@@ -0,0 +1,23 @@
+name: Python check documentation
+
+on: [push]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python: [3.9]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Setup Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python }}
+      - name: Install Tox and any other packages
+        run: |
+          pip install tox
+      - name: Run Tox
+        run: tox -e doc

dynamicforms-0.76.14/.github/workflows/incremental-cover-check.yml

@@ -0,0 +1,73 @@
+name: Coverage check
+on: [push, pull_request]
+env:
+  UNITTEST: 1
+jobs:
+  lint:
+    name: Code coverage
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 2
+      - name: Setup PostgreSQL With Init Scripts
+        uses: m4nu56/postgresql-action@1.0
+        with:
+          postgresql db: scantron
+          postgresql user: scantron
+          postgresql password: scantron
+      - name: Use Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '18.13.0'
+      - name: Install Dependencies
+        run: npm ci
+      - name: Test build
+        run: npm run build-no-tsc --if-present
+      - name: Run tests
+        run: npm test
+      - name: Set up Python 3.9
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.9"
+      - name: PIP install
+        run: |
+          pip3 install -r requirements.txt
+          pip3 install -r requirements_test_functional.txt
+      - name: Python unittest
+        continue-on-error: true
+        run: |
+          python -m coverage run manage.py test
+      - name: Generate coverage report
+        continue-on-error: true
+        run: |
+          coverage report -m
+          coverage json
+
+      - name: Coverage check on pull_request
+        uses: velis74/incremental-coverage-check@main
+        with:
+          clover_coverage_json: vue/dynamicforms/coverage/coverage-final.json
+          py_coverage_json: coverage.json
+          logging_level: INFO
+          base_ref: ${{ github.base_ref }}
+          head_ref: HEAD
+          rep_ref: main
+          gh_token: ${{ secrets.GITHUB_TOKEN }}
+          pr_number: ${{github.event.pull_request.number}}
+        if: github.event_name == 'pull_request'
+
+      - name: Coverage check on push
+        uses: velis74/incremental-coverage-check@main
+        with:
+          clover_coverage_json: vue/dynamicforms/coverage/coverage-final.json
+          py_coverage_json: coverage.json
+          logging_level: INFO
+          base_ref: ${{ github.event.before }}
+          head_ref: HEAD
+          rep_ref: main
+        if: github.event_name == 'push'
+
+      - name: The job has failed
+        run: exit 1
+        if: ${{ failure() }}

dynamicforms-0.76.14/.github/workflows/vitest_tests.yml

@@ -0,0 +1,20 @@
+name: Vitest Tests
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '18.13.0'
+      - name: Install Dependencies
+        run: npm ci
+      - name: Test build
+        run: npm run build-no-tsc --if-present
+      - name: Run tests
+        run: npm test

dynamicforms-0.76.14/.gitignore

@@ -0,0 +1,39 @@
+/DynamicForms.egg-info
+*.pyc
+*~
+.idea
+*.bak
+.#*
+\#*
+*.db
+*.tmp
+*.mo
+.tox
+rest_framework
+db.sqlite3
+/docs/_build/
+/docs/.vitepress/cache/**/*
+/geckodriver.log
+venv/
+.venv/
+media
+/node_modules
+/coverage
+/dynamicforms/static/ckeditor5/
+/dynamicforms/vue/node_modules/
+/dynamicforms/vue/package-lock.json
+/vue/dynamicforms/README.md
+/dist/
+setup/env.py
+
+# Local configuration
+.env.local
+
+# Make sure to add .vitepress/dist and .vitepress/cache to your .gitignore file.
+.vitepress/dist
+.vitepress/cache
+
+# Coverage generated files
+coverage/
+.coverage
+.coverage.json

dynamicforms-0.76.14/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright © 2017-present, Jure Erznožnik.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

dynamicforms-0.76.14/MANIFEST.in

@@ -0,0 +1,8 @@
+include README.rst
+include LICENSE.rst
+include requirements.txt
+include requirements_test_functional.txt
+recursive-include dynamicforms *
+recursive-include dynamicforms_legacy *
+global-exclude __pycache__
+global-exclude *.py[co]

dynamicforms-0.76.14/PKG-INFO

@@ -0,0 +1,129 @@
+Metadata-Version: 2.3
+Name: dynamicforms
+Version: 0.76.14
+Summary: DynamicForms performs all the visualisation & data entry of your DRF Serializers & ViewSets and adds some candy of its own
+Project-URL: Homepage, https://github.com/velis74/DynamicForms
+Project-URL: Repository, https://github.com/velis74/DynamicForms
+Project-URL: Bug Tracker, https://github.com/velis74/DynamicForms/issues
+Author-email: Jure Erznožnik <jure@velis.si>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: Django
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.8
+Requires-Dist: coreapi>=1.32
+Requires-Dist: django-cors-headers
+Requires-Dist: django-enumfields>=2.1.1
+Requires-Dist: django-filter
+Requires-Dist: django>=2
+Requires-Dist: djangorestframework>=3.14
+Requires-Dist: jsonschema
+Requires-Dist: pillow
+Requires-Dist: pytz
+Requires-Dist: ruff
+Requires-Dist: ruff-lsp
+Requires-Dist: versio
+Description-Content-Type: text/markdown
+
+# Notice to users of this library
+
+Releases 0.50.x and 0.70.x are interim releases with which we prepare the stage for 1.x release.
+
+0.50.x moves all "existing" code to `dynamicforms_legacy` module. If you weren't following vue
+development branches, you will need to change all imports in python to this "new" module.
+
+This is done to keep legacy code still running as existing code is transitioned to vue-based approach. Unless there is
+significant interest, we will remove this module with 1.x release.
+
+0.70.x re-introduces `dynamicforms` module, but this time refactored to only provide .componentdef OPTIONS +
+payload data responses needed by the vue front-end library. This will hopefully be refactored to be more OpenAPI
+compatible. The new primary branch is now `main`.
+
+HTML renderers will no longer be supported and have been removed from the "new" dynamicforms module. It was too slow
+and required too many hacks to remain viable. So we moved to Vue. The components in 0.70 will be vue3, vuetify3, vite
+and typescript-compatible. We're in final stages of adapting to the new stack. Some inputs and some table functionality
+isn't working yet.
+
+We're keeping the Bootstrap stubs too, but not actively developing to support seamless selection of the two frameworks.
+If there is interest to support CSS frameworks other than Vuetify, pull requests welcome. Hopefully the stubs should
+point the way on how to do it.
+
+Migration path is thus:
+
+- Upgrade to dynamicforms \>= 0.50.3
+- replace all dynamicforms imports with dynamicforms_legacy
+- because of the rename, there is a bit of work required in settings.py so that Django can find the templates and
+  filters:
+
+      ``` python
+      from dynamicforms_legacy import __file__ as DYNAMICFORMS_BASEDIR_FILE
+      DYNAMICFORMS_BASEDIR = os.path.dirname(DYNAMICFORMS_BASEDIR_FILE)
+      ...
+      INSTALLED_APPS = [
+        ...
+        'dynamicforms_legacy'
+
+      TEMPLATES = [
+         ...
+              'DIRS': [
+                  os.path.join(DYNAMICFORMS_BASEDIR, 'templates'),
+         ...
+              'OPTIONS': {
+         ...
+                  'libraries': {
+                      'dynamicforms': 'dynamicforms_legacy.templatetags.dynamicforms',
+                  }
+      STATICFILES_DIRS = [
+          ...
+          os.path.join(DYNAMICFORMS_BASEDIR, 'static'),
+      ]
+      ```
+- replace any javascript dynamicforms progress calls with progress-legacy
+- all other javascript code remains the same (including the dynamicforms object with support functions)
+- check that everything still works
+- Upgrade dynamicforms to \>= 0.70.1
+- Start migration to Vue front-end and the new backend
+
+# What is DynamicForms?
+
+DynamicForms wants to eliminate HTML form boilerplate for generic tables & forms. Specifying a single DRF Serializer /
+ViewSet and possibly desired form layout instantly provides both HTML renders and JSON renders (and anything else DRF
+supports) keeping you free to implement your project.
+
+There are two parts to DanymicForms:
+
+- Django / DRF extensions providing the JSON definitions for on-screen objects
+- HTML / Javascript component library providing the visualisation
+
+It performs all the visualisation & data entry of your DRF Serializers & ViewSets and adds some candy of its own: It is
+a [django](https://www.djangoproject.com/) library that gives you the power of dynamically-shown form fields,
+autofilled default values, dynamic record loading and similar candy with little effort. To put it differently: once
+defined, a particular ViewSet / Serializer can be rendered in multiple ways allowing you to perform viewing and
+authoring operations on the data in question.
+
+It is based on
+[django-rest-framework](http://www.django-rest-framework.org/)
+
+Documentation [on readthedocs](https://dynamicforms.readthedocs.io/)
+
+## Why DynamicForms
+
+- Turn your rest-framework ViewSets into HTML tables & forms
+- Powerful HTML based CRUD
+    - Support for fetching "new" records
+    - Render to table, form or dialog, with plenty of customisation options
+    - Full nested data support
+    - Dynamically display & hide fields based on other fields' values
+    - Easily add actions and place the buttons to execute them anywhere you like
+- Clear separation of list & dialog templates
+- Dynamic loading of additional records for table views supported by infinite scroll
+- Responsive tables (multiple table layouts for various screen widths)
+- Easy implementation of filtering
+- Action items, declared globally, placed where you need them
+- Custom templates whenever & wherever you want them
+- Support for form validation, will show errors even if they are not tied to a field
+- Progress dialog for long lasting ajax operations
+

dynamicforms-0.76.14/README.md

@@ -0,0 +1,99 @@
+# Notice to users of this library
+
+Releases 0.50.x and 0.70.x are interim releases with which we prepare the stage for 1.x release.
+
+0.50.x moves all "existing" code to `dynamicforms_legacy` module. If you weren't following vue
+development branches, you will need to change all imports in python to this "new" module.
+
+This is done to keep legacy code still running as existing code is transitioned to vue-based approach. Unless there is
+significant interest, we will remove this module with 1.x release.
+
+0.70.x re-introduces `dynamicforms` module, but this time refactored to only provide .componentdef OPTIONS +
+payload data responses needed by the vue front-end library. This will hopefully be refactored to be more OpenAPI
+compatible. The new primary branch is now `main`.
+
+HTML renderers will no longer be supported and have been removed from the "new" dynamicforms module. It was too slow
+and required too many hacks to remain viable. So we moved to Vue. The components in 0.70 will be vue3, vuetify3, vite
+and typescript-compatible. We're in final stages of adapting to the new stack. Some inputs and some table functionality
+isn't working yet.
+
+We're keeping the Bootstrap stubs too, but not actively developing to support seamless selection of the two frameworks.
+If there is interest to support CSS frameworks other than Vuetify, pull requests welcome. Hopefully the stubs should
+point the way on how to do it.
+
+Migration path is thus:
+
+- Upgrade to dynamicforms \>= 0.50.3
+- replace all dynamicforms imports with dynamicforms_legacy
+- because of the rename, there is a bit of work required in settings.py so that Django can find the templates and
+  filters:
+
+      ``` python
+      from dynamicforms_legacy import __file__ as DYNAMICFORMS_BASEDIR_FILE
+      DYNAMICFORMS_BASEDIR = os.path.dirname(DYNAMICFORMS_BASEDIR_FILE)
+      ...
+      INSTALLED_APPS = [
+        ...
+        'dynamicforms_legacy'
+
+      TEMPLATES = [
+         ...
+              'DIRS': [
+                  os.path.join(DYNAMICFORMS_BASEDIR, 'templates'),
+         ...
+              'OPTIONS': {
+         ...
+                  'libraries': {
+                      'dynamicforms': 'dynamicforms_legacy.templatetags.dynamicforms',
+                  }
+      STATICFILES_DIRS = [
+          ...
+          os.path.join(DYNAMICFORMS_BASEDIR, 'static'),
+      ]
+      ```
+- replace any javascript dynamicforms progress calls with progress-legacy
+- all other javascript code remains the same (including the dynamicforms object with support functions)
+- check that everything still works
+- Upgrade dynamicforms to \>= 0.70.1
+- Start migration to Vue front-end and the new backend
+
+# What is DynamicForms?
+
+DynamicForms wants to eliminate HTML form boilerplate for generic tables & forms. Specifying a single DRF Serializer /
+ViewSet and possibly desired form layout instantly provides both HTML renders and JSON renders (and anything else DRF
+supports) keeping you free to implement your project.
+
+There are two parts to DanymicForms:
+
+- Django / DRF extensions providing the JSON definitions for on-screen objects
+- HTML / Javascript component library providing the visualisation
+
+It performs all the visualisation & data entry of your DRF Serializers & ViewSets and adds some candy of its own: It is
+a [django](https://www.djangoproject.com/) library that gives you the power of dynamically-shown form fields,
+autofilled default values, dynamic record loading and similar candy with little effort. To put it differently: once
+defined, a particular ViewSet / Serializer can be rendered in multiple ways allowing you to perform viewing and
+authoring operations on the data in question.
+
+It is based on
+[django-rest-framework](http://www.django-rest-framework.org/)
+
+Documentation [on readthedocs](https://dynamicforms.readthedocs.io/)
+
+## Why DynamicForms
+
+- Turn your rest-framework ViewSets into HTML tables & forms
+- Powerful HTML based CRUD
+    - Support for fetching "new" records
+    - Render to table, form or dialog, with plenty of customisation options
+    - Full nested data support
+    - Dynamically display & hide fields based on other fields' values
+    - Easily add actions and place the buttons to execute them anywhere you like
+- Clear separation of list & dialog templates
+- Dynamic loading of additional records for table views supported by infinite scroll
+- Responsive tables (multiple table layouts for various screen widths)
+- Easy implementation of filtering
+- Action items, declared globally, placed where you need them
+- Custom templates whenever & wherever you want them
+- Support for form validation, will show errors even if they are not tied to a field
+- Progress dialog for long lasting ajax operations
+

dynamicforms-0.76.14/docs/.docs_archive/Makefile

@@ -0,0 +1,21 @@
+# Minimal makefile for Sphinx documentation
+#
+# sphinx-autobuild -v -n -a . _build\html
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = DynamicForms
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)