django-pfx 1.1.dev2__tar.gz → 1.2__tar.gz

{django-pfx-1.1.dev2 → django-pfx-1.2}/.gitignore

@@ -26,3 +26,7 @@ dev_custom.py
 
 # Other
 /local
+/doc/_build/
+/examples/**/venv/
+/examples/**/db.sqlite3
+/doc/api/

{django-pfx-1.1.dev2 → django-pfx-1.2}/.gitlab-ci.yml

@@ -8,7 +8,7 @@ variables:
 
 cache:
   paths:
-    - ~/.cache/pip/
+    - .cache/pip/
 
 before_script:
   - python -V  # Print out python version for debugging
@@ -20,6 +20,7 @@ before_script:
 
 stages:
   - test
+  - build
   - package
 
 test:
@@ -34,9 +35,13 @@ test:
     - coverage run --source='.' runtest.py
     - coverage report
     - coverage xml
+    - coverage html
   coverage: '/TOTAL.*\s([.\d]+)%/'
   artifacts:
     when: always
+    paths:
+      - htmlcov/**
+    expire_in: 7 day
     reports:
       junit: testreport.xml
       coverage_report:
@@ -46,9 +51,39 @@ test:
     matrix:
       - DJANGO_VERSION: 'Django==3.2.*'  # LTS
       - DJANGO_VERSION: 'Django>=3.2,<4.0'
-      # TODO: There is a bug with validation message override. Fix it for django 4.
-      # - DJANGO_VERSION: 'Django>=4.0,<5.0'
-      # - DJANGO_VERSION: 'Django>=4.2.*'  # LTS # TODO: activate when released.
+      - DJANGO_VERSION: 'Django>=4.0,<5.0'
+      - DJANGO_VERSION: 'Django>=4.2.*'  # LTS
+
+build doc:
+  stage: build
+  needs: []
+  interruptible: true
+  script:
+    - cd doc
+    - make html
+  artifacts:
+    when: always
+    paths:
+      - doc/_build/**
+    expire_in: 7 day
+
+pages:
+  stage: package
+  needs:
+    - job: build doc
+      artifacts: true
+    - job: test
+      artifacts: true
+  script:
+    - mkdir public
+    - mv doc/_build/html public/doc
+    - mv htmlcov public/coverage
+  artifacts:
+    paths:
+      - public
+  only:
+    - master
+
 package:
   only:
     refs:

django-pfx-1.2/PKG-INFO

@@ -0,0 +1,65 @@
+Metadata-Version: 2.1
+Name: django-pfx
+Version: 1.2
+Summary: Django PFX is a toolkit designed to streamline the development of RESTful APIs using the Django framework.
+Author: Hervé Martinet
+Author-email: herve.martinet@gmail.com
+License: BSD-3-Clause
+Project-URL: Source, https://gitlab.com/pfx4/django-pfx
+Project-URL: Tracker, https://gitlab.com/pfx4/django-pfx/-/issues
+Project-URL: Documentation, https://pfx4.gitlab.io/django-pfx/doc/
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 3.2
+Classifier: Framework :: Django :: 4.2
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: django<5.0,>=3.2
+Requires-Dist: django-cors-headers
+Requires-Dist: django_json_widget
+Requires-Dist: pyjwt>=2.1
+Requires-Dist: Babel
+Requires-Dist: boto3
+Requires-Dist: apispec
+Requires-Dist: pyyaml
+Requires-Dist: pytz
+Requires-Dist: dill
+
+# Django PFX
+
+[![pipeline status](https://gitlab.com/pfx4/django-pfx/badges/master/pipeline.svg)](https://gitlab.com/pfx4/django-pfx/-/commits/master)
+[![coverage report](https://gitlab.com/pfx4/django-pfx/badges/master/coverage.svg)](https://pfx4.gitlab.io/django-pfx/coverage)
+
+![logo]
+
+Django PFX is a toolkit designed to streamline the development of RESTful APIs
+using the Django framework, leveraging views and the ORM (Object-Relational Mapping).
+With a focus on simplicity and efficiency, Django PFX enables developers to rapidly
+create robust web service APIs for web applications and simplifies the testing process.
+
+### Key Features:
+- Predefined CRUD API (but customizable)
+- Internationalization
+- Authentication & Authorization
+- JSON-only RESTful API
+- Flexibility
+- Tests & Profiling Tools
+- Automatic Open API Documentation
+
+### Links
+- [Source](https://gitlab.com/pfx4/django-pfx)
+- [Issue tracker](https://gitlab.com/pfx4/django-pfx/-/issues)
+- [Documentation](https://pfx4.gitlab.io/django-pfx/doc/)
+
+[logo]: https://gitlab.com/pfx4/django-pfx/-/raw/master/img/pfx.png "PFX"

django-pfx-1.2/README.md

@@ -0,0 +1,27 @@
+# Django PFX
+
+[![pipeline status](https://gitlab.com/pfx4/django-pfx/badges/master/pipeline.svg)](https://gitlab.com/pfx4/django-pfx/-/commits/master)
+[![coverage report](https://gitlab.com/pfx4/django-pfx/badges/master/coverage.svg)](https://pfx4.gitlab.io/django-pfx/coverage)
+
+![logo]
+
+Django PFX is a toolkit designed to streamline the development of RESTful APIs
+using the Django framework, leveraging views and the ORM (Object-Relational Mapping).
+With a focus on simplicity and efficiency, Django PFX enables developers to rapidly
+create robust web service APIs for web applications and simplifies the testing process.
+
+### Key Features:
+- Predefined CRUD API (but customizable)
+- Internationalization
+- Authentication & Authorization
+- JSON-only RESTful API
+- Flexibility
+- Tests & Profiling Tools
+- Automatic Open API Documentation
+
+### Links
+- [Source](https://gitlab.com/pfx4/django-pfx)
+- [Issue tracker](https://gitlab.com/pfx4/django-pfx/-/issues)
+- [Documentation](https://pfx4.gitlab.io/django-pfx/doc/)
+
+[logo]: https://gitlab.com/pfx4/django-pfx/-/raw/master/img/pfx.png "PFX"

django-pfx-1.2/django_pfx.egg-info/PKG-INFO

@@ -0,0 +1,65 @@
+Metadata-Version: 2.1
+Name: django-pfx
+Version: 1.2
+Summary: Django PFX is a toolkit designed to streamline the development of RESTful APIs using the Django framework.
+Author: Hervé Martinet
+Author-email: herve.martinet@gmail.com
+License: BSD-3-Clause
+Project-URL: Source, https://gitlab.com/pfx4/django-pfx
+Project-URL: Tracker, https://gitlab.com/pfx4/django-pfx/-/issues
+Project-URL: Documentation, https://pfx4.gitlab.io/django-pfx/doc/
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 3.2
+Classifier: Framework :: Django :: 4.2
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: django<5.0,>=3.2
+Requires-Dist: django-cors-headers
+Requires-Dist: django_json_widget
+Requires-Dist: pyjwt>=2.1
+Requires-Dist: Babel
+Requires-Dist: boto3
+Requires-Dist: apispec
+Requires-Dist: pyyaml
+Requires-Dist: pytz
+Requires-Dist: dill
+
+# Django PFX
+
+[![pipeline status](https://gitlab.com/pfx4/django-pfx/badges/master/pipeline.svg)](https://gitlab.com/pfx4/django-pfx/-/commits/master)
+[![coverage report](https://gitlab.com/pfx4/django-pfx/badges/master/coverage.svg)](https://pfx4.gitlab.io/django-pfx/coverage)
+
+![logo]
+
+Django PFX is a toolkit designed to streamline the development of RESTful APIs
+using the Django framework, leveraging views and the ORM (Object-Relational Mapping).
+With a focus on simplicity and efficiency, Django PFX enables developers to rapidly
+create robust web service APIs for web applications and simplifies the testing process.
+
+### Key Features:
+- Predefined CRUD API (but customizable)
+- Internationalization
+- Authentication & Authorization
+- JSON-only RESTful API
+- Flexibility
+- Tests & Profiling Tools
+- Automatic Open API Documentation
+
+### Links
+- [Source](https://gitlab.com/pfx4/django-pfx)
+- [Issue tracker](https://gitlab.com/pfx4/django-pfx/-/issues)
+- [Documentation](https://pfx4.gitlab.io/django-pfx/doc/)
+
+[logo]: https://gitlab.com/pfx4/django-pfx/-/raw/master/img/pfx.png "PFX"

{django-pfx-1.1.dev2 → django-pfx-1.2}/django_pfx.egg-info/SOURCES.txt

@@ -7,6 +7,7 @@ README.md
 pyproject.toml
 requirements.txt
 runtest.py
+serve-doc
 setup.cfg
 setup.py
 django_pfx.egg-info/PKG-INFO
@@ -14,25 +15,50 @@ django_pfx.egg-info/SOURCES.txt
 django_pfx.egg-info/dependency_links.txt
 django_pfx.egg-info/requires.txt
 django_pfx.egg-info/top_level.txt
+doc/Makefile
+doc/conf.py
+doc/index.rst
+doc/source/api.views.rst
+doc/source/authentication.md
+doc/source/decorator.md
+doc/source/generate_openapi.md
+doc/source/getting_started.md
+doc/source/internationalisation.md
+doc/source/model.md
+doc/source/pfx_views.md
+doc/source/profiling.md
+doc/source/settings.md
+doc/source/testing.md
 img/pfx.png
 img/pfx.svg
 pfx/__init__.py
 pfx/pfxcore/__init__.py
 pfx/pfxcore/apps.py
+pfx/pfxcore/default_settings.py
 pfx/pfxcore/exceptions.py
 pfx/pfxcore/fields.py
+pfx/pfxcore/settings.py
 pfx/pfxcore/shortcuts.py
 pfx/pfxcore/test.py
 pfx/pfxcore/urls.py
+pfx/pfxcore/apidoc/__init__.py
+pfx/pfxcore/apidoc/parameters.py
+pfx/pfxcore/apidoc/schema.py
+pfx/pfxcore/apidoc/tags.py
 pfx/pfxcore/decorator/__init__.py
 pfx/pfxcore/decorator/rest.py
 pfx/pfxcore/http/__init__.py
 pfx/pfxcore/http/json_response.py
 pfx/pfxcore/locale/fr/LC_MESSAGES/django.mo
 pfx/pfxcore/locale/fr/LC_MESSAGES/django.po
+pfx/pfxcore/management/__init__.py
+pfx/pfxcore/management/commands/__init__.py
+pfx/pfxcore/management/commands/makeapidoc.py
+pfx/pfxcore/management/commands/profile.py
 pfx/pfxcore/middleware/__init__.py
 pfx/pfxcore/middleware/authentication.py
 pfx/pfxcore/middleware/locale.py
+pfx/pfxcore/middleware/profiling.py
 pfx/pfxcore/models/__init__.py
 pfx/pfxcore/models/cache_mixins.py
 pfx/pfxcore/models/not_null_fields.py
@@ -52,6 +78,24 @@ pfx/pfxcore/views/fields.py
 pfx/pfxcore/views/filters_views.py
 pfx/pfxcore/views/locale_views.py
 pfx/pfxcore/views/rest_views.py
+pfx/pfxcore/views/parameters/__init__.py
+pfx/pfxcore/views/parameters/date_format.py
+pfx/pfxcore/views/parameters/groups.py
+pfx/pfxcore/views/parameters/list_count.py
+pfx/pfxcore/views/parameters/list_items.py
+pfx/pfxcore/views/parameters/list_mode.py
+pfx/pfxcore/views/parameters/list_order.py
+pfx/pfxcore/views/parameters/list_search.py
+pfx/pfxcore/views/parameters/media_redirect.py
+pfx/pfxcore/views/parameters/meta_fields.py
+pfx/pfxcore/views/parameters/meta_filters.py
+pfx/pfxcore/views/parameters/meta_orders.py
+pfx/pfxcore/views/parameters/subset.py
+pfx/pfxcore/views/parameters/subset_limit.py
+pfx/pfxcore/views/parameters/subset_offset.py
+pfx/pfxcore/views/parameters/subset_page.py
+pfx/pfxcore/views/parameters/subset_page_size.py
+pfx/pfxcore/views/parameters/subset_page_subset.py
 tests/__init__.py
 tests/models.py
 tests/urls.py
@@ -65,15 +109,19 @@ tests/settings/dev_default.py
 tests/tests/__init__.py
 tests/tests/basic_api_errors.py
 tests/tests/basic_api_test.py
+tests/tests/test_api_doc.py
 tests/tests/test_auth_api.py
 tests/tests/test_cache.py
+tests/tests/test_client.py
 tests/tests/test_fields.py
 tests/tests/test_filters.py
 tests/tests/test_locale_api.py
 tests/tests/test_perm_tests.py
 tests/tests/test_perms_api.py
+tests/tests/test_profiling_middleware.py
 tests/tests/test_shortcuts.py
 tests/tests/test_timezone_middleware.py
 tests/tests/test_tools.py
 tests/tests/test_user_queryset.py
+tests/tests/test_view_decorators.py
 tests/tests/test_view_fields.py

{django-pfx-1.1.dev2 → django-pfx-1.2}/django_pfx.egg-info/requires.txt

@@ -1,7 +1,10 @@
-django<4.0,>=3.2
+django<5.0,>=3.2
 django-cors-headers
-django_request_mapping
 django_json_widget
 pyjwt>=2.1
 Babel
 boto3
+apispec
+pyyaml
+pytz
+dill

{django-pfx-1.1.dev2 → django-pfx-1.2}/django_pfx.egg-info/top_level.txt

@@ -1,2 +1,3 @@
 dist
+doc
 pfx

django-pfx-1.2/doc/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+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)

django-pfx-1.2/doc/conf.py

@@ -0,0 +1,81 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import sys
+
+import django
+from django.conf import settings
+
+from sphinx.ext.autodoc import between
+
+sys.path.insert(0, os.path.abspath('../'))
+settings.configure(
+    SECRET_KEY='something to make Django happy',
+    INSTALLED_APPS=[
+        'django.contrib.auth',
+        'django.contrib.contenttypes',
+        'django.contrib.postgres',
+        'pfx.pfxcore'])
+django.setup()
+
+
+def setup(app):
+    # Register a sphinx.ext.autodoc.between listener to ignore everything
+    # between lines that contain --- and """ (yaml from apispec)
+    app.connect('autodoc-process-docstring',
+                between('^.*(---|""")$', exclude=True))
+    return app
+
+
+# -- Project information -----------------------------------------------------
+project = 'Django PFX'
+copyright = '2021, Hervé Martinet, Nicolas Béraneck'
+author = 'Hervé Martinet, Nicolas Béraneck'
+
+# The full version, including alpha/beta/rc tags
+release = '1.0'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = ['myst_parser',
+              'sphinx.ext.autodoc',
+              'sphinx.ext.autosummary']
+autodoc_member_order = 'bysource'
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+master_doc = 'index'
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = "sphinx_rtd_theme"
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+# html_static_path = ['_static']
+
+myst_heading_anchors = 3

django-pfx-1.2/doc/index.rst

@@ -0,0 +1,35 @@
+.. Django PFX documentation master file, created by
+   sphinx-quickstart on Fri Dec 10 14:58:11 2021.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to Django PFX's documentation!
+======================================
+
+.. include:: ../README.md
+   :parser: myst_parser.sphinx_
+
+Topics
+======
+
+.. toctree::
+   :maxdepth: 2
+
+   source/getting_started
+   source/decorator
+   source/pfx_views
+   source/model
+   source/internationalisation
+   source/authentication
+   source/settings
+   source/testing
+   source/profiling
+   source/generate_openapi
+   source/api.views
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

django-pfx-1.2/doc/source/api.views.rst

@@ -0,0 +1,137 @@
+API Reference
+=============
+
+``pfx.pfxcore.middleware``
+**************************
+
+.. autoclass:: pfx.pfxcore.middleware.AuthenticationMiddleware
+    :show-inheritance:
+
+.. autoclass:: pfx.pfxcore.middleware.LocaleMiddleware
+    :show-inheritance:
+
+.. autofunction:: pfx.pfxcore.middleware.locale.get_language_from_request
+.. autofunction:: pfx.pfxcore.middleware.locale.get_timezone_from_request
+
+
+``pfx.pfxcore.models``
+**********************
+
+.. autoclass:: pfx.pfxcore.models.ErrorMessageMixin
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. autoclass:: pfx.pfxcore.models.JSONReprMixin
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. autoclass:: pfx.pfxcore.models.PFXModelMixin
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+``pfx.pfxcore.views``
+*********************
+
+Base services
+-------------
+
+.. autoclass:: pfx.pfxcore.views.AuthenticationView
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. autoclass:: pfx.pfxcore.views.ForgottenPasswordView
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. autoclass:: pfx.pfxcore.views.SignupView
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. autoclass:: pfx.pfxcore.views.LocaleRestView
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+View Mixins
+-----------
+
+.. autoclass:: pfx.pfxcore.views.ModelMixin
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. autoclass:: pfx.pfxcore.views.ModelResponseMixin
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. autoclass:: pfx.pfxcore.views.BodyMixin
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. autoclass:: pfx.pfxcore.views.ModelBodyMixin
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. autoclass:: pfx.pfxcore.views.DetailRestViewMixin
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. autoclass:: pfx.pfxcore.views.SlugDetailRestViewMixin
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. autoclass:: pfx.pfxcore.views.ListRestViewMixin
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. autoclass:: pfx.pfxcore.views.CreateRestViewMixin
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. autoclass:: pfx.pfxcore.views.UpdateRestViewMixin
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. autoclass:: pfx.pfxcore.views.DeleteRestViewMixin
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. autoclass:: pfx.pfxcore.views.MediaRestViewMixin
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. autoclass:: pfx.pfxcore.views.SecuredRestViewMixin
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. autoclass:: pfx.pfxcore.views.BaseRestView
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. autoclass:: pfx.pfxcore.views.RestView
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. autoclass:: pfx.pfxcore.views.SendMessageTokenMixin
+    :members:
+    :undoc-members:
+    :show-inheritance: