django-pfx 1.2.dev99__tar.gz → 1.2.dev103__tar.gz

{django-pfx-1.2.dev99 → django-pfx-1.2.dev103}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: django-pfx
-Version: 1.2.dev99
+Version: 1.2.dev103
 Summary: Django PFX is a toolkit to build web APIs dedicated to be used by React progressive web app.
 Author: Hervé Martinet
 Author-email: herve.martinet@gmail.com

{django-pfx-1.2.dev99 → django-pfx-1.2.dev103}/django_pfx.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: django-pfx
-Version: 1.2.dev99
+Version: 1.2.dev103
 Summary: Django PFX is a toolkit to build web APIs dedicated to be used by React progressive web app.
 Author: Hervé Martinet
 Author-email: herve.martinet@gmail.com

{django-pfx-1.2.dev99 → django-pfx-1.2.dev103}/django_pfx.egg-info/SOURCES.txt

@@ -17,6 +17,7 @@ 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/cookbook.md
 doc/source/decorator.md
@@ -24,7 +25,6 @@ doc/source/getting_started.md
 doc/source/internationalisation.md
 doc/source/model.md
 doc/source/pfx_views.md
-doc/source/pfxcore.views.rst
 doc/source/testing.md
 img/pfx.png
 img/pfx.svg

{django-pfx-1.2.dev99 → django-pfx-1.2.dev103}/doc/conf.py

@@ -16,6 +16,8 @@ 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',
@@ -26,8 +28,16 @@ settings.configure(
         'pfx.pfxcore'])
 django.setup()
 
-# -- Project information -----------------------------------------------------
 
+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'

{django-pfx-1.2.dev99 → django-pfx-1.2.dev103}/doc/index.rst

@@ -24,12 +24,12 @@ Topics
    source/getting_started
    source/decorator
    source/pfx_views
-   source/pfxcore.views
    source/model
    source/internationalisation
    source/authentication
    source/cookbook
    source/testing
+   source/api.views
 
 Indices and tables
 ==================

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

@@ -0,0 +1,46 @@
+API
+=====================
+
+The ``AuthenticationView`` class
+********************************
+.. autoclass:: pfx.pfxcore.views.AuthenticationView
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+The ``ForgottenPasswordView`` class
+***********************************
+.. autoclass:: pfx.pfxcore.views.ForgottenPasswordView
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+The ``DetailRestViewMixin`` class
+*********************************
+.. autoclass:: pfx.pfxcore.views.DetailRestViewMixin
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. :inherited-members:
+
+The ``LocaleMiddleware`` class
+******************************
+.. autoclass:: pfx.pfxcore.middleware.LocaleMiddleware
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+The ``LocaleRestView`` class
+****************************
+.. autoclass:: pfx.pfxcore.views.LocaleRestView
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+The ``ModelMixin`` class
+************************
+.. autoclass:: pfx.pfxcore.views.ModelMixin
+    :members:
+    :undoc-members:
+    :show-inheritance:

django-pfx-1.2.dev103/doc/source/authentication.md

@@ -0,0 +1,35 @@
+# Authentication
+
+## Modes
+
+There are 2 authentication modes: cookie and bearer token.
+You can activate either or both by adding middleware:
+
+* `'pfx.pfxcore.middleware.AuthenticationMiddleware'` (bearer token)
+* `'pfx.pfxcore.middleware.CookieAuthenticationMiddleware'` (cookie)
+
+To use the `CookieAuthenticationMiddleware`, you have to configure following settings:
+
+* `PFX_COOKIE_DOMAIN`: the cookie domain
+* `PFX_COOKIE_SECURE`: `Secure` attribute of the cookie (`True`/`False`)
+* `PFX_COOKIE_SAMESITE`: `SameSite` attribute of the cookie (`'Strict'`/`'Lax'`/`'None'`)
+* `PFX_TOKEN_SHORT_VALIDITY`: validity for short validity token (optional, default `{'hours': 12}`)
+* `PFX_TOKEN_LONG_VALIDITY`: validity for long validity token (optional, default `{'days': 30}`)
+
+`/auth/login?mode=jwt` will return a token for bearer token authentication.
+`/auth/login?mode=cookie` will set and return the authentication cookie.
+
+## Authentication views
+
+The following views provide standard services:
+
+* `AuthenticationView`
+  * `/auth/login`
+  * `/auth/logout`
+  * `/auth/set-password`
+  * `/auth/change-password`
+  * `/auth/validate-user-token`
+* `ForgottenPasswordView`
+  * `/auth/forgotten-password`
+
+See the API doc for details.

django-pfx-1.2.dev103/doc/source/internationalisation.md

@@ -0,0 +1,41 @@
+# Internationalisation
+
+## Translated strings
+
+Use Django's standard way of translating strings (verbose name, choices values, messages, ...).
+PFX will use the translated values according to the requested language.
+
+## Specify available languages
+
+In Django, `USE_I18N` must be `True` to use internationalization. Use `LANGUAGE_CODE` to set default locale.
+
+You can optionally set `USE_L10N` to `True` (see Django documentation).
+
+In Addition, you can set the list of available languages for web services with `LANGUAGES`:
+```
+LANGUAGES = [
+    ('fr', "French"),
+    ('en', "English"),
+]
+```
+
+You can use language only code of language and country.
+
+Service responses will use the first language of `Accept-Language` present in `LANGUAGES`.
+Use `X-Custom-Language` to force the use of a specific language.
+
+## LocaleRestView
+
+The `LocaleRestView` exposes a service on `/locales/languages` which returns the list of
+available languages.
+
+## LocaleMiddleware
+
+To enable internationalization in services, you have to add `'pfx.pfxcore.middleware.LocaleMiddleware'`
+in the `MIDDLEWARE` list.
+
+This middleware will use:
+* `LANGUAGES`, `LANGUAGE_CODE`, `Accept-Language` and `X-Custom-Language` to set the language.
+* `TIME_ZONE` and `X-Custom-Timezone` sot set the timezone.
+
+You can replace it by a custom middleware if you need another specific behavior.

django-pfx-1.2.dev99/doc/source/authentication.md

@@ -1,8 +0,0 @@
-# Authentication
-
-TODO define content
-
-- AuthenticationMiddleware
-- AuthenticationView
-- SignupView
-- ForgotenPasswordView

django-pfx-1.2.dev99/doc/source/internationalisation.md

@@ -1,5 +0,0 @@
-# Internationalisation
-
-- parameters
-- LocaleMiddleware
-- LocaleRestView

django-pfx-1.2.dev99/doc/source/pfxcore.views.rst

@@ -1,18 +0,0 @@
-Django PFX views
-=====================
-
-The ``DetailRestViewMixin`` class
-*********************************
-.. autoclass:: pfx.pfxcore.views.DetailRestViewMixin
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-.. :inherited-members:
-
-The ``ModelMixin`` class
-*********************************
-.. autoclass:: pfx.pfxcore.views.ModelMixin
-    :members:
-    :undoc-members:
-    :show-inheritance: