open-api-framework 0.4.2__tar.gz → 0.6.0__tar.gz

{open_api_framework-0.4.2 → open_api_framework-0.6.0}/CHANGELOG.rst

@@ -1,6 +1,35 @@
 Changelog
 =========
 
+0.6.0 (2024-07-04)
+------------------
+
+**New features**
+
+* Use the callback class from mozilla-django-oidc-db to allow for a custom error view
+
+0.5.0 (2024-06-27)
+------------------
+
+**New features**
+
+* Add password to ``AXES_SENSITIVE_PARAMETERS``
+* Use stricter ``django-axes`` settings
+    * ``AXES_FAILURE_LIMIT`` changed from ``10`` to ``5``
+    * ``AXES_COOLOFF_TIME`` changed from ``1`` to ``5`` minutes
+* Make more ``log-outgoing-requests`` settings configurable
+    * ``LOG_OUTGOING_REQUESTS_EMIT_BODY`` (default ``True``)
+    * ``LOG_OUTGOING_REQUESTS_DB_SAVE_BODY`` (default ``True``)
+* Add base template to display current version in admin
+
+**Bugfixes**
+
+* Remove FIXTURE_DIRS setting and add root level app to INSTALLED_APPS
+
+**Other**
+
+* Move documentation to readthedocs
+
 0.4.2 (2024-06-20)
 ------------------
 

{open_api_framework-0.4.2 → open_api_framework-0.6.0}/MANIFEST.in

@@ -4,5 +4,6 @@ include open_api_framework/py.typed
 recursive-include open_api_framework *.html
 recursive-include open_api_framework *.txt
 recursive-include open_api_framework *.po
+recursive-include open_api_framework/static *.css
 global-exclude __pycache__
 global-exclude *.py[co]

{open_api_framework-0.4.2/open_api_framework.egg-info → open_api_framework-0.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: open_api_framework
-Version: 0.4.2
+Version: 0.6.0
 Summary: A metapackage for registration components, that bundles the dependencies shared between these components and provides generic settings
 Author-email: Maykin Media <support@maykinmedia.nl>
 License: Copyright © Maykin 2024
@@ -77,7 +77,7 @@ Requires-Dist: twine; extra == "release"
 Open API Framework
 ==================
 
-:Version: 0.4.2
+:Version: 0.6.0
 :Source: https://github.com/maykinmedia/open-api-framework
 :Keywords: metapackage, dependencies
 
@@ -85,7 +85,8 @@ Open API Framework
 
 |python-versions| |django-versions| |pypi-version|
 
-A metapackage for registration components, that bundles the dependencies shared between these components
+A metapackage for registration components, that bundles the dependencies shared between these
+components and provides generic base settings
 
 .. contents::
 
@@ -95,42 +96,12 @@ Features
 ========
 
 * Bundling shared dependencies and introducing minimum versions for these dependencies
+* Providing generic base Django settings to avoid duplicate settings across registration components
 
-Installation
-============
+Usage
+=====
 
-Requirements
-------------
-
-* Python 3.9 or above
-* Django 4.2 or newer
-
-
-Install
--------
-
-1. Add open-api-framework to your requirements file
-2. Remove dependencies from your requirements file that occur in ``pyproject.toml``
-3. Recompile the dependencies
-
-Local development
-=================
-
-To install and develop the library locally, use:
-
-.. code-block:: bash
-
-    pip install -e .[tests,coverage,docs,release]
-
-When running management commands via ``django-admin``, make sure to add the root
-directory to the python path (or use ``python -m django <command>``):
-
-.. code-block:: bash
-
-    export PYTHONPATH=. DJANGO_SETTINGS_MODULE=testapp.settings
-    django-admin check
-    # or other commands like:
-    # django-admin makemessages -l nl
+Please see the hosted `documentation`_ for installation, configuration and usage instructions.
 
 License
 =======
@@ -168,3 +139,5 @@ Licensed under the `MIT license`.
 
 .. |pypi-version| image:: https://img.shields.io/pypi/v/open-api-framework.svg
     :target: https://pypi.org/project/open-api-framework/
+
+.. _documentation: https://open-api-framework.readthedocs.io/en/latest/

{open_api_framework-0.4.2 → open_api_framework-0.6.0}/README.rst

@@ -1,7 +1,7 @@
 Open API Framework
 ==================
 
-:Version: 0.4.2
+:Version: 0.6.0
 :Source: https://github.com/maykinmedia/open-api-framework
 :Keywords: metapackage, dependencies
 
@@ -9,7 +9,8 @@ Open API Framework
 
 |python-versions| |django-versions| |pypi-version|
 
-A metapackage for registration components, that bundles the dependencies shared between these components
+A metapackage for registration components, that bundles the dependencies shared between these
+components and provides generic base settings
 
 .. contents::
 
@@ -19,42 +20,12 @@ Features
 ========
 
 * Bundling shared dependencies and introducing minimum versions for these dependencies
+* Providing generic base Django settings to avoid duplicate settings across registration components
 
-Installation
-============
+Usage
+=====
 
-Requirements
-------------
-
-* Python 3.9 or above
-* Django 4.2 or newer
-
-
-Install
--------
-
-1. Add open-api-framework to your requirements file
-2. Remove dependencies from your requirements file that occur in ``pyproject.toml``
-3. Recompile the dependencies
-
-Local development
-=================
-
-To install and develop the library locally, use:
-
-.. code-block:: bash
-
-    pip install -e .[tests,coverage,docs,release]
-
-When running management commands via ``django-admin``, make sure to add the root
-directory to the python path (or use ``python -m django <command>``):
-
-.. code-block:: bash
-
-    export PYTHONPATH=. DJANGO_SETTINGS_MODULE=testapp.settings
-    django-admin check
-    # or other commands like:
-    # django-admin makemessages -l nl
+Please see the hosted `documentation`_ for installation, configuration and usage instructions.
 
 License
 =======
@@ -92,3 +63,5 @@ Licensed under the `MIT license`.
 
 .. |pypi-version| image:: https://img.shields.io/pypi/v/open-api-framework.svg
     :target: https://pypi.org/project/open-api-framework/
+
+.. _documentation: https://open-api-framework.readthedocs.io/en/latest/

{open_api_framework-0.4.2 → open_api_framework-0.6.0}/open_api_framework/conf/base.py

@@ -1,3 +1,4 @@
+import datetime
 import os
 import warnings
 from pathlib import Path
@@ -145,6 +146,8 @@ INSTALLED_APPS = [
     "mozilla_django_oidc_db",
     "log_outgoing_requests",
     "django_setup_configuration",
+    "open_api_framework",
+    PROJECT_DIRNAME,
 ]
 
 MIDDLEWARE = [
@@ -180,6 +183,7 @@ TEMPLATES = [
                 "django.template.context_processors.request",
                 "django.contrib.auth.context_processors.auth",
                 "django.contrib.messages.context_processors.messages",
+                "open_api_framework.context_processors.admin_settings",
                 f"{PROJECT_DIRNAME}.utils.context_processors.settings",
             ],
             "loaders": TEMPLATE_LOADERS,
@@ -216,8 +220,6 @@ MEDIA_URL = "/media/"
 
 FILE_UPLOAD_PERMISSIONS = 0o644
 
-FIXTURE_DIRS = (Path(DJANGO_PROJECT_DIR) / "fixtures",)
-
 #
 # Sending EMAIL
 #
@@ -480,11 +482,12 @@ NUM_PROXIES = config(  # TODO: this also is relevant for DRF settings if/when we
 AXES_CACHE = "axes"  # refers to CACHES setting
 # The number of login attempts allowed before a record is created for the
 # failed logins. Default: 3
-AXES_FAILURE_LIMIT = 10
+AXES_FAILURE_LIMIT = 5
+AXES_LOCK_OUT_AT_FAILURE = True  # Default: True
 # If set, defines a period of inactivity after which old failed login attempts
 # will be forgotten. Can be set to a python timedelta object or an integer. If
 # an integer, will be interpreted as a number of hours. Default: None
-AXES_COOLOFF_TIME = 1
+AXES_COOLOFF_TIME = datetime.timedelta(minutes=5)
 # The number of reverse proxies
 AXES_IPWARE_PROXY_COUNT = NUM_PROXIES - 1 if NUM_PROXIES else None
 # If set, specifies a template to render when a user is locked out. Template
@@ -494,7 +497,7 @@ AXES_LOCKOUT_PARAMETERS = [["ip_address", "user_agent", "username"]]
 AXES_BEHIND_REVERSE_PROXY = IS_HTTPS
 # By default, Axes obfuscates values for formfields named "password", but the admin
 # interface login formfield name is "auth-password", so we want to obfuscate that
-AXES_SENSITIVE_PARAMETERS = ["auth-password"]  # nosec
+AXES_SENSITIVE_PARAMETERS = ["password", "auth-password"]  # nosec
 
 # The default meta precedence order
 IPWARE_META_PRECEDENCE_ORDER = (
@@ -598,6 +601,10 @@ ADMIN_INDEX_AUTO_CREATE_APP_GROUP = False
 # Mozilla Django OIDC DB settings
 #
 OIDC_AUTHENTICATE_CLASS = "mozilla_django_oidc_db.views.OIDCAuthenticationRequestView"
+# Use custom callback view to handle admin login error situations
+# NOTE the AdminLoginFailure view for mozilla-django-oidc-db should be added to the projects
+# urlpatterns to properly catch errors
+OIDC_CALLBACK_CLASS = "mozilla_django_oidc_db.views.OIDCCallbackView"
 MOZILLA_DJANGO_OIDC_DB_CACHE = "oidc"
 MOZILLA_DJANGO_OIDC_DB_CACHE_TIMEOUT = 5 * 60
 
@@ -643,6 +650,8 @@ MAYKIN_2FA_ALLOW_MFA_BYPASS_BACKENDS = [
     "mozilla_django_oidc_db.backends.OIDCAuthenticationBackend",
 ]
 
+# if DISABLE_2FA is true, fill the MAYKIN_2FA_ALLOW_MFA_BYPASS_BACKENDS with all
+# configured AUTHENTICATION_BACKENDS and thus disabeling the entire 2FA chain.
 if config("DISABLE_2FA", default=False):  # pragma: no cover
     MAYKIN_2FA_ALLOW_MFA_BYPASS_BACKENDS = AUTHENTICATION_BACKENDS
 
@@ -650,7 +659,12 @@ if config("DISABLE_2FA", default=False):  # pragma: no cover
 #
 # LOG OUTGOING REQUESTS
 #
-LOG_OUTGOING_REQUESTS_EMIT_BODY = True
+LOG_OUTGOING_REQUESTS_EMIT_BODY = config(
+    "LOG_OUTGOING_REQUESTS_EMIT_BODY", default=True
+)
+LOG_OUTGOING_REQUESTS_DB_SAVE_BODY = config(
+    "LOG_OUTGOING_REQUESTS_DB_SAVE_BODY", default=True
+)
 LOG_OUTGOING_REQUESTS_DB_SAVE = config("LOG_OUTGOING_REQUESTS_DB_SAVE", default=False)
 LOG_OUTGOING_REQUESTS_RESET_DB_SAVE_AFTER = None
 LOG_OUTGOING_REQUESTS_MAX_AGE = config(

open_api_framework-0.6.0/open_api_framework/context_processors.py

@@ -0,0 +1,14 @@
+from django.conf import settings
+from django.http.request import HttpRequest
+
+
+def admin_settings(request: HttpRequest) -> dict:
+    show_version = request.user.is_staff
+
+    return {
+        "show_environment": getattr(settings, "ENVIRONMENT_SHOWN_IN_ADMIN", None),
+        "show_version": show_version,
+        "git_sha": getattr(settings, "GIT_SHA", None),
+        "version": getattr(settings, "RELEASE", None),
+        "environment": getattr(settings, "ENVIRONMENT", None),
+    }

open_api_framework-0.6.0/open_api_framework/static/open_api_framework/css/admin.css

@@ -0,0 +1,39 @@
+:root {
+    --version-fg: #c2c2c2;
+    --version-padding: 0 30px;
+    --version-font-size: smaller;
+
+    --env-button-bg: #333;
+    --env-button-fg: #f3f3f3;
+    --env-button-height: 35px;
+    --env-button-width: 300px;
+    --env-button-line-height: 35px;
+}
+
+.login .version {
+    text-align: center;
+}
+
+.version {
+    padding: var(--version-padding);
+    color: var(--version-fg);
+    font-size: var(--version-font-size);
+}
+
+.env {
+  display: block;
+  line-height: var(--env-button-line-height);
+  text-align: center;
+  font-weight: bold;
+  text-transform: uppercase;
+  color: var(--env-button-fg);
+  background-color: var(--env-button-bg);
+  position: fixed;
+  top: 0;
+  height: var(--env-button-height);
+  width: var(--env-button-width);
+  left: 50%;
+  margin-left: -150px;
+  z-index: 1000001;
+  box-shadow: 0 4px 8px 0 rgba(0, 0, 0, 0.2), 0 6px 20px 0 rgba(0, 0, 0, 0.2);
+}

open_api_framework-0.6.0/open_api_framework/templates/open_api_framework/admin/base_site.html

@@ -0,0 +1,22 @@
+{% extends "admin/base.html" %}
+{% load static open_api_framework %}
+
+{% block extrastyle %}
+    <link rel="stylesheet" type="text/css" href="{% static 'open_api_framework/css/admin.css' %}">
+{% endblock %}
+
+{% block messages %}
+    {% if show_environment %}
+        {% environment %}
+    {% endif %}
+
+    {{ block.super }}
+{% endblock %}
+
+{% block footer %}
+    <div id="footer">
+        {% if show_version %}
+            {% version %}
+        {% endif %}
+    </div>
+{% endblock %}

open_api_framework-0.6.0/open_api_framework/templates/open_api_framework/components/environment.html

@@ -0,0 +1 @@
+<div class="env env-{{ environment }}">{{ environment }}</div>

open_api_framework-0.6.0/open_api_framework/templates/open_api_framework/components/version.html

@@ -0,0 +1,5 @@
+{% load i18n %}
+
+<div class="version" title="Git SHA: {{ git_sha }}">
+    {% trans "Version" %} {{ version }}
+</div>

open_api_framework-0.6.0/open_api_framework/templatetags/open_api_framework.py

@@ -0,0 +1,19 @@
+from django import template
+from django.conf import settings
+
+register = template.Library()
+
+
+@register.inclusion_tag("open_api_framework/components/version.html")
+def version() -> dict:
+    return {
+        "version": getattr(settings, "RELEASE", ""),
+        "git_sha": getattr(settings, "GIT_SHA", ""),
+    }
+
+
+@register.inclusion_tag("open_api_framework/components/environment.html")
+def environment() -> dict:
+    return {
+        "environment": getattr(settings, "ENVIRONMENT", ""),
+    }

{open_api_framework-0.4.2 → open_api_framework-0.6.0/open_api_framework.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: open_api_framework
-Version: 0.4.2
+Version: 0.6.0
 Summary: A metapackage for registration components, that bundles the dependencies shared between these components and provides generic settings
 Author-email: Maykin Media <support@maykinmedia.nl>
 License: Copyright © Maykin 2024
@@ -77,7 +77,7 @@ Requires-Dist: twine; extra == "release"
 Open API Framework
 ==================
 
-:Version: 0.4.2
+:Version: 0.6.0
 :Source: https://github.com/maykinmedia/open-api-framework
 :Keywords: metapackage, dependencies
 
@@ -85,7 +85,8 @@ Open API Framework
 
 |python-versions| |django-versions| |pypi-version|
 
-A metapackage for registration components, that bundles the dependencies shared between these components
+A metapackage for registration components, that bundles the dependencies shared between these
+components and provides generic base settings
 
 .. contents::
 
@@ -95,42 +96,12 @@ Features
 ========
 
 * Bundling shared dependencies and introducing minimum versions for these dependencies
+* Providing generic base Django settings to avoid duplicate settings across registration components
 
-Installation
-============
+Usage
+=====
 
-Requirements
-------------
-
-* Python 3.9 or above
-* Django 4.2 or newer
-
-
-Install
--------
-
-1. Add open-api-framework to your requirements file
-2. Remove dependencies from your requirements file that occur in ``pyproject.toml``
-3. Recompile the dependencies
-
-Local development
-=================
-
-To install and develop the library locally, use:
-
-.. code-block:: bash
-
-    pip install -e .[tests,coverage,docs,release]
-
-When running management commands via ``django-admin``, make sure to add the root
-directory to the python path (or use ``python -m django <command>``):
-
-.. code-block:: bash
-
-    export PYTHONPATH=. DJANGO_SETTINGS_MODULE=testapp.settings
-    django-admin check
-    # or other commands like:
-    # django-admin makemessages -l nl
+Please see the hosted `documentation`_ for installation, configuration and usage instructions.
 
 License
 =======
@@ -168,3 +139,5 @@ Licensed under the `MIT license`.
 
 .. |pypi-version| image:: https://img.shields.io/pypi/v/open-api-framework.svg
     :target: https://pypi.org/project/open-api-framework/
+
+.. _documentation: https://open-api-framework.readthedocs.io/en/latest/

{open_api_framework-0.4.2 → open_api_framework-0.6.0}/open_api_framework.egg-info/SOURCES.txt

@@ -6,6 +6,7 @@ pyproject.toml
 setup.cfg
 open_api_framework/__init__.py
 open_api_framework/apps.py
+open_api_framework/context_processors.py
 open_api_framework/py.typed
 open_api_framework.egg-info/PKG-INFO
 open_api_framework.egg-info/SOURCES.txt
@@ -15,4 +16,10 @@ open_api_framework.egg-info/top_level.txt
 open_api_framework/conf/__init__.py
 open_api_framework/conf/base.py
 open_api_framework/conf/utils.py
+open_api_framework/static/open_api_framework/css/admin.css
+open_api_framework/templates/open_api_framework/admin/base_site.html
+open_api_framework/templates/open_api_framework/components/environment.html
+open_api_framework/templates/open_api_framework/components/version.html
+open_api_framework/templatetags/__init__.py
+open_api_framework/templatetags/open_api_framework.py
 tests/test_config_helpers.py

{open_api_framework-0.4.2 → open_api_framework-0.6.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "open_api_framework"
-version = "0.4.2"
+version = "0.6.0"
 description = "A metapackage for registration components, that bundles the dependencies shared between these components and provides generic settings"
 authors = [
     {name = "Maykin Media", email = "support@maykinmedia.nl"}
@@ -100,7 +100,7 @@ testpaths = ["tests"]
 DJANGO_SETTINGS_MODULE = "testapp.settings"
 
 [tool.bumpversion]
-current_version = "0.4.2"
+current_version = "0.6.0"
 files = [
     {filename = "pyproject.toml"},
     {filename = "README.rst"},