django-pfx 1.2.dev133__tar.gz → 1.2.dev139__tar.gz

{django-pfx-1.2.dev133 → django-pfx-1.2.dev139}/.gitlab-ci.yml

@@ -85,9 +85,11 @@ pages:
     - master
 
 package:
-  only:
-    refs:
-      - master
+  rules:
+    - if: $CI_COMMIT_TAG =~ /^\d+\.\d+$/
+      when: on_success
+    - if: $CI_COMMIT_BRANCH == "master"
+      when: on_success
   script:
     - apt-get update
     - apt-get install -y gettext

{django-pfx-1.2.dev133 → django-pfx-1.2.dev139}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: django-pfx
-Version: 1.2.dev133
-Summary: Django PFX is a toolkit to build rest APIs with the Django framework.
+Version: 1.2.dev139
+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
@@ -11,6 +11,7 @@ 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
@@ -37,14 +38,28 @@ Requires-Dist: dill
 
 # Django PFX
 
-![pipeline]
-![coverage]
+[![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 to build rest APIs with the Django framework.
+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
 
-[logo]: https://gitlab.com/hmartinet/django-pfx/-/raw/master/img/pfx.png "PFX"
-[pipeline]: https://gitlab.com/hmartinet/django-pfx/badges/master/pipeline.svg "Pipeline Status"
-[coverage]: https://gitlab.com/hmartinet/django-pfx/badges/master/coverage.svg "Code Coverage"
+### 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.dev139/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.dev133 → django-pfx-1.2.dev139}/django_pfx.egg-info/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: django-pfx
-Version: 1.2.dev133
-Summary: Django PFX is a toolkit to build rest APIs with the Django framework.
+Version: 1.2.dev139
+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
@@ -11,6 +11,7 @@ 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
@@ -37,14 +38,28 @@ Requires-Dist: dill
 
 # Django PFX
 
-![pipeline]
-![coverage]
+[![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 to build rest APIs with the Django framework.
+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
 
-[logo]: https://gitlab.com/hmartinet/django-pfx/-/raw/master/img/pfx.png "PFX"
-[pipeline]: https://gitlab.com/hmartinet/django-pfx/badges/master/pipeline.svg "Pipeline Status"
-[coverage]: https://gitlab.com/hmartinet/django-pfx/badges/master/coverage.svg "Code Coverage"
+### 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.dev133 → django-pfx-1.2.dev139}/django_pfx.egg-info/SOURCES.txt

@@ -20,7 +20,6 @@ doc/conf.py
 doc/index.rst
 doc/source/api.views.rst
 doc/source/authentication.md
-doc/source/cookbook.md
 doc/source/decorator.md
 doc/source/generate_openapi.md
 doc/source/getting_started.md
@@ -28,6 +27,7 @@ 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

{django-pfx-1.2.dev133 → django-pfx-1.2.dev139}/doc/index.rst

@@ -6,8 +6,8 @@
 Welcome to Django PFX's documentation!
 ======================================
 
-Django PFX is a toolkit to build rest APIs with the Django framework.
-
+.. include:: ../README.md
+   :parser: myst_parser.sphinx_
 
 Topics
 ======
@@ -21,7 +21,7 @@ Topics
    source/model
    source/internationalisation
    source/authentication
-   source/cookbook
+   source/settings
    source/testing
    source/profiling
    source/generate_openapi

{django-pfx-1.2.dev133 → django-pfx-1.2.dev139}/doc/source/authentication.md

@@ -104,7 +104,7 @@ A service that allows users to request a password reset. This service sends an e
 a link to a "set password" page, which your frontend software must implement.
 
 You must set `PFX_RESET_PASSWORD_URL` in your settings to define this "set password" link.
-The link should include the `token` and `uidb64` parameters,
+The link must include the `token` and `uidb64` parameters,
 like so: `https://example.com/reset-password?token={token}&uidb64={uidb64}`.
 Your reset page should then call the "set password" service with these two parameters.
 
@@ -121,6 +121,7 @@ Refer to the [API doc](api.views.rst#pfx.pfxcore.views.ForgottenPasswordView) fo
 
 **Responses :**
 * `HTTP 200` OK with a success message.
+* `HTTP 422` Error if the email parameter is not an email address
 
 ### Sign Up
 A service that allows visitors to sign up.

django-pfx-1.2.dev139/doc/source/settings.md

@@ -0,0 +1,65 @@
+# Settings
+This page lists all the settings used by Django PFX.
+
+## Base
+
+### PFX_BASE_URL
+Base url of your frontend application.
+Not used directly by PFX, but can be used in email templates for instance.
+
+### PFX_SITE_NAME
+The name of your website, application and/or api.
+Used in the email sent by pfx (welcome email, reset password, etc.)
+
+### PFX_RESET_PASSWORD_URL
+The url to set/reset password in your frontend application.
+The url must include the `token` and `uidb64` parameters,
+like so: `f'{PFX_BASE_URL}/define-password?token={token}&uidb64={uidb64}"`.
+
+### PFX_MAX_LIST_RESULT_SIZE
+The maximum size of list returned by PFX ListRestView services.
+The goal is to avoid performance issues for huge database table.
+
+### PFX_TEST_MODE
+
+Enable test features.
+
+One good way to automate this setting is to rely on manage.py parameter
+
+To test if you launch test`./manage.py test` :
+```python
+import sys
+
+if len(sys.argv) > 1 and sys.argv[1] == 'test':
+    PFX_TEST_MODE=True
+```
+
+
+## Authentication
+
+### PFX_SECRET_KEY
+The secret key used to cypher the JWT token.
+
+### PFX_TOKEN_SHORT_VALIDITY
+Validity for short-validity tokens (optional, default `{'hours': 12}`)
+
+### PFX_TOKEN_LONG_VALIDITY
+Validity for long-validity tokens (optional, default `{'days': 30}`)
+
+### PFX_COOKIE_DOMAIN
+The domain sent in the cookie.
+Refer to [MDN documentation](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie#domaindomain-value)
+
+### PFX_COOKIE_SECURE
+Boolean, value that indicate that the cookie is sent only with https request.
+Refer to [MDN documentation](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie#secure)
+
+### PFX_COOKIE_SAMESITE
+SameSite value of the cookie.
+Can be `Strict`, `Lax`, `None`
+Refer to [MDN documentation](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie#samesitesamesite-value)
+
+## Authorisation
+
+### PFX_FORCE_USER_FILTERED_QUERYSET
+Force the use of a specific queryset that is segregated by user.

{django-pfx-1.2.dev133 → django-pfx-1.2.dev139}/doc/source/testing.md

@@ -147,7 +147,7 @@ get_val also allows to specify the index in an array.
 The syntax is `"@index"`.
 
 For instance if you want the pk of the author of the
-third item in an array of books you can specify `"items.@3.author.pk"`
+third item in an array of books you can specify `"items.@2.author.pk"`
 
 Example :
 ```python
@@ -159,7 +159,7 @@ class ATestClass(TestAssertMixin, TransactionTestCase):
     def a_test(self):
         client = APIClient()
         response = client.get('/api/books')
-        author_pk = self.get_val(response, 'items.@3.author.pk')
+        author_pk = self.get_val(response, 'items.@2.author.pk')
 ```
 
 ### assertJE
@@ -176,7 +176,7 @@ class ATestClass(TestAssertMixin, TransactionTestCase):
     def a_test(self):
         client = APIClient()
         response = client.get('/api/books')
-        self.assertJE(response, 'items.@3.author.pk', self.author1.pk)
+        self.assertJE(response, 'items.@2.author.pk', self.author1.pk)
 ```
 
 ### assertNJE

{django-pfx-1.2.dev133 → django-pfx-1.2.dev139}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = django-pfx
-description = Django PFX is a toolkit to build rest APIs with the Django framework.
+description = Django PFX is a toolkit designed to streamline the development of RESTful APIs using the Django framework.
 long_description = file: README.md
 long_description_content_type = text/markdown
 project_urls = 
@@ -14,6 +14,7 @@ classifiers =
 	Environment :: Web Environment
 	Framework :: Django
 	Framework :: Django :: 3.2
+	Framework :: Django :: 4.2
 	Intended Audience :: Developers
 	License :: OSI Approved :: BSD License
 	Operating System :: OS Independent

django-pfx-1.2.dev133/README.md

@@ -1,13 +0,0 @@
-# Django PFX
-
-![pipeline]
-![coverage]
-
-![logo]
-
-Django PFX is a toolkit to build rest APIs with the Django framework.
-
-
-[logo]: https://gitlab.com/hmartinet/django-pfx/-/raw/master/img/pfx.png "PFX"
-[pipeline]: https://gitlab.com/hmartinet/django-pfx/badges/master/pipeline.svg "Pipeline Status"
-[coverage]: https://gitlab.com/hmartinet/django-pfx/badges/master/coverage.svg "Code Coverage"

django-pfx-1.2.dev133/doc/source/cookbook.md

@@ -1,9 +0,0 @@
-# Cookbook
-
-Best recipes from the trenches.
-
-- override queryset
-- get_model_data
-- get_readonly_fields
-- validate
-- is_valid