open-api-framework 0.9.6__tar.gz → 0.10.0__tar.gz

{open_api_framework-0.9.6 → open_api_framework-0.10.0}/CHANGELOG.rst

@@ -1,6 +1,19 @@
 Changelog
 =========
 
+0.10.0 (2025-05-19)
+-------------------
+
+**New features**
+
+* Add separate "Logging" group for logging related environment variables in docs
+* Add ``open_api_framework.conf.utils.mute_logging`` util to silence logging in CI
+* [maykinmedia/objects-api#592] Silence log events in Sentry if structlog is used
+
+**Bugfixes**
+
+* [#127] Make ``LOGIN_URL`` non-lazy to avoid errors when using ``django-rosetta``
+
 0.9.6 (2025-03-28)
 ------------------
 

{open_api_framework-0.9.6/open_api_framework.egg-info → open_api_framework-0.10.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: open-api-framework
-Version: 0.9.6
+Version: 0.10.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
@@ -69,6 +69,8 @@ Requires-Dist: isort; extra == "tests"
 Requires-Dist: black; extra == "tests"
 Requires-Dist: flake8; extra == "tests"
 Requires-Dist: factory-boy; extra == "tests"
+Requires-Dist: django-rosetta; extra == "tests"
+Requires-Dist: django-webtest; extra == "tests"
 Provides-Extra: coverage
 Requires-Dist: pytest-cov; extra == "coverage"
 Provides-Extra: docs
@@ -82,7 +84,7 @@ Dynamic: license-file
 Open API Framework
 ==================
 
-:Version: 0.9.6
+:Version: 0.10.0
 :Source: https://github.com/maykinmedia/open-api-framework
 :Keywords: metapackage, dependencies
 

{open_api_framework-0.9.6 → open_api_framework-0.10.0}/README.rst

@@ -1,7 +1,7 @@
 Open API Framework
 ==================
 
-:Version: 0.9.6
+:Version: 0.10.0
 :Source: https://github.com/maykinmedia/open-api-framework
 :Keywords: metapackage, dependencies
 

{open_api_framework-0.9.6 → open_api_framework-0.10.0}/open_api_framework/conf/base.py

@@ -347,7 +347,10 @@ DEFAULT_FROM_EMAIL = config(
 # LOGGING
 #
 LOG_STDOUT = config(
-    "LOG_STDOUT", default=True, help_text="whether to log to stdout or not"
+    "LOG_STDOUT",
+    default=True,
+    help_text="whether to log to stdout or not",
+    group="Logging",
 )
 LOG_LEVEL = config(
     "LOG_LEVEL",
@@ -356,6 +359,7 @@ LOG_LEVEL = config(
         "control the verbosity of logging output. "
         "Available values are ``CRITICAL``, ``ERROR``, ``WARNING``, ``INFO`` and ``DEBUG``"
     ),
+    group="Logging",
 )
 LOG_QUERIES = config(
     "LOG_QUERIES",
@@ -364,9 +368,14 @@ LOG_QUERIES = config(
         "enable (query) logging at the database backend level. Note that you "
         "must also set ``DEBUG=1``, which should be done very sparingly!"
     ),
+    group="Logging",
 )
+# XXX: this should be renamed to `LOG_OUTGOING_REQUESTS` in the next major release
 LOG_REQUESTS = config(
-    "LOG_REQUESTS", default=False, help_text="enable logging of the outgoing requests"
+    "LOG_REQUESTS",
+    default=False,
+    help_text="enable logging of the outgoing requests",
+    group="Logging",
 )
 if LOG_QUERIES and not DEBUG:
     warnings.warn(
@@ -379,6 +388,7 @@ CELERY_LOGLEVEL = config(
     default="INFO",
     help_text="control the verbosity of logging output for celery, independent of ``LOG_LEVEL``."
     " Available values are ``CRITICAL``, ``ERROR``, ``WARNING``, ``INFO`` and ``DEBUG``",
+    group="Celery",
 )
 
 LOGGING_DIR = Path(BASE_DIR) / "log"
@@ -564,8 +574,7 @@ SESSION_COOKIE_AGE = config(
     help_text="For how long, in seconds, the session cookie will be valid.",
 )
 
-
-LOGIN_URL = reverse_lazy("admin:login")
+LOGIN_URL = "admin:login"
 LOGIN_REDIRECT_URL = reverse_lazy("admin:index")
 LOGOUT_REDIRECT_URL = reverse_lazy("admin:index")
 
@@ -953,22 +962,26 @@ LOG_OUTGOING_REQUESTS_EMIT_BODY = config(
     "LOG_OUTGOING_REQUESTS_EMIT_BODY",
     default=True,
     help_text="Whether or not outgoing request bodies should be logged",
+    group="Logging",
 )
 LOG_OUTGOING_REQUESTS_DB_SAVE = config(
     "LOG_OUTGOING_REQUESTS_DB_SAVE",
     default=False,
     help_text="Whether or not outgoing request logs should be saved to the database",
+    group="Logging",
 )
 LOG_OUTGOING_REQUESTS_DB_SAVE_BODY = config(
     "LOG_OUTGOING_REQUESTS_DB_SAVE_BODY",
     default=True,
     help_text="Whether or not outgoing request bodies should be saved to the database",
+    group="Logging",
 )
 LOG_OUTGOING_REQUESTS_RESET_DB_SAVE_AFTER = None
 LOG_OUTGOING_REQUESTS_MAX_AGE = config(
     "LOG_OUTGOING_REQUESTS_MAX_AGE",
     default=7,
     help_text="The amount of time after which request logs should be deleted from the database",
+    group="Logging",
 )  # number of days
 
 

{open_api_framework-0.9.6 → open_api_framework-0.10.0}/open_api_framework/conf/utils.py

@@ -1,3 +1,4 @@
+import logging  # noqa: TID251
 import sys
 from dataclasses import dataclass
 from pathlib import Path
@@ -6,6 +7,7 @@ from urllib.parse import urlparse
 
 from decouple import Csv, Undefined, config as _config, undefined
 from sentry_sdk.integrations import DidNotEnable, django, redis
+from sentry_sdk.integrations.logging import LoggingIntegration
 
 
 @dataclass
@@ -103,6 +105,20 @@ def get_sentry_integrations() -> list:
     else:
         extra.append(celery.CeleryIntegration())
 
+    try:
+        import structlog  # type: ignore  # noqa
+    except ImportError:
+        pass
+    else:
+        extra.append(
+            LoggingIntegration(
+                level=logging.INFO,  # breadcrumbs
+                # do not send any logs as event to Sentry at all - these must be scraped by
+                # the (container) infrastructure instead.
+                event_level=None,
+            ),
+        )
+
     return [*default, *extra]
 
 
@@ -119,3 +135,24 @@ def get_django_project_dir() -> str:
     # Get the path of the importing module
     base_dirname = get_project_dirname()
     return Path(sys.modules[base_dirname].__file__).parent
+
+
+def mute_logging(config: dict) -> None:  # pragma: no cover
+    """
+    Disable (console) output from logging.
+    :arg config: The logging config, typically the django LOGGING setting.
+    """
+
+    # set up the null handler for all loggers so that nothing gets emitted
+    for name, logger in config["loggers"].items():
+        if name == "flaky_tests":
+            continue
+        logger["handlers"] = ["null"]
+
+    # some tooling logs to a logger which isn't defined, and that ends up in the root
+    # logger -> add one so that we can mute that output too.
+    config["loggers"].update(
+        {
+            "": {"handlers": ["null"], "level": "CRITICAL", "propagate": False},
+        }
+    )

{open_api_framework-0.9.6 → open_api_framework-0.10.0/open_api_framework.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: open-api-framework
-Version: 0.9.6
+Version: 0.10.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
@@ -69,6 +69,8 @@ Requires-Dist: isort; extra == "tests"
 Requires-Dist: black; extra == "tests"
 Requires-Dist: flake8; extra == "tests"
 Requires-Dist: factory-boy; extra == "tests"
+Requires-Dist: django-rosetta; extra == "tests"
+Requires-Dist: django-webtest; extra == "tests"
 Provides-Extra: coverage
 Requires-Dist: pytest-cov; extra == "coverage"
 Provides-Extra: docs
@@ -82,7 +84,7 @@ Dynamic: license-file
 Open API Framework
 ==================
 
-:Version: 0.9.6
+:Version: 0.10.0
 :Source: https://github.com/maykinmedia/open-api-framework
 :Keywords: metapackage, dependencies
 

{open_api_framework-0.9.6 → open_api_framework-0.10.0}/open_api_framework.egg-info/requires.txt

@@ -48,3 +48,5 @@ isort
 black
 flake8
 factory-boy
+django-rosetta
+django-webtest

{open_api_framework-0.9.6 → open_api_framework-0.10.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "open-api-framework"
-version = "0.9.6"
+version = "0.10.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"}
@@ -75,6 +75,8 @@ tests = [
     "black",
     "flake8",
     "factory-boy",
+    "django-rosetta",
+    "django-webtest"
 ]
 coverage = [
     "pytest-cov",
@@ -109,7 +111,7 @@ env = [
 ]
 
 [tool.bumpversion]
-current_version = "0.9.6"
+current_version = "0.10.0"
 files = [
     {filename = "pyproject.toml"},
     {filename = "README.rst"},

{open_api_framework-0.9.6 → open_api_framework-0.10.0}/tests/test_generate_envvar_docs.py

@@ -35,21 +35,35 @@ Database
 * ``DB_PORT``: port number of the database. Defaults to: ``5432``.
 
 
-Cross-Origin-Resource-Sharing
------------------------------
+Logging
+-------
 
-* ``CORS_ALLOW_ALL_ORIGINS``: allow cross-domain access from any client. Defaults to: ``False``.
-* ``CORS_ALLOWED_ORIGINS``: explicitly list the allowed origins for cross-domain requests. Example: http://localhost:3000,https://some-app.gemeente.nl. Defaults to: ``[]``.
-* ``CORS_ALLOWED_ORIGIN_REGEXES``: same as ``CORS_ALLOWED_ORIGINS``, but supports regular expressions. Defaults to: ``[]``.
-* ``CORS_EXTRA_ALLOW_HEADERS``: headers that are allowed to be sent as part of the cross-domain request. By default, Authorization, Accept-Crs and Content-Crs are already included. The value of this variable is added to these already included headers. Defaults to: ``[]``.
+* ``LOG_STDOUT``: whether to log to stdout or not. Defaults to: ``True``.
+* ``LOG_LEVEL``: control the verbosity of logging output. Available values are ``CRITICAL``, ``ERROR``, ``WARNING``, ``INFO`` and ``DEBUG``. Defaults to: ``WARNING``.
+* ``LOG_QUERIES``: enable (query) logging at the database backend level. Note that you must also set ``DEBUG=1``, which should be done very sparingly!. Defaults to: ``False``.
+* ``LOG_REQUESTS``: enable logging of the outgoing requests. Defaults to: ``False``.
+* ``LOG_OUTGOING_REQUESTS_EMIT_BODY``: Whether or not outgoing request bodies should be logged. Defaults to: ``True``.
+* ``LOG_OUTGOING_REQUESTS_DB_SAVE``: Whether or not outgoing request logs should be saved to the database. Defaults to: ``False``.
+* ``LOG_OUTGOING_REQUESTS_DB_SAVE_BODY``: Whether or not outgoing request bodies should be saved to the database. Defaults to: ``True``.
+* ``LOG_OUTGOING_REQUESTS_MAX_AGE``: The amount of time after which request logs should be deleted from the database. Defaults to: ``7``.
 
 
 Celery
 ------
 
+* ``CELERY_LOGLEVEL``: control the verbosity of logging output for celery, independent of ``LOG_LEVEL``. Available values are ``CRITICAL``, ``ERROR``, ``WARNING``, ``INFO`` and ``DEBUG``. Defaults to: ``INFO``.
 * ``CELERY_RESULT_BACKEND``: the URL of the backend/broker that will be used by Celery to send the notifications. Defaults to: ``redis://localhost:6379/1``.
 
 
+Cross-Origin-Resource-Sharing
+-----------------------------
+
+* ``CORS_ALLOW_ALL_ORIGINS``: allow cross-domain access from any client. Defaults to: ``False``.
+* ``CORS_ALLOWED_ORIGINS``: explicitly list the allowed origins for cross-domain requests. Example: http://localhost:3000,https://some-app.gemeente.nl. Defaults to: ``[]``.
+* ``CORS_ALLOWED_ORIGIN_REGEXES``: same as ``CORS_ALLOWED_ORIGINS``, but supports regular expressions. Defaults to: ``[]``.
+* ``CORS_EXTRA_ALLOW_HEADERS``: headers that are allowed to be sent as part of the cross-domain request. By default, Authorization, Accept-Crs and Content-Crs are already included. The value of this variable is added to these already included headers. Defaults to: ``[]``.
+
+
 Elastic APM
 -----------
 
@@ -83,11 +97,6 @@ Optional
 * ``EMAIL_HOST_PASSWORD``: password to connect to the mail server. Defaults to: ``(empty string)``.
 * ``EMAIL_USE_TLS``: whether to use TLS or not to connect to the mail server. Should be True if you're changing the ``EMAIL_PORT`` to 487. Defaults to: ``False``.
 * ``DEFAULT_FROM_EMAIL``: The default email address from which emails are sent. Defaults to: ``testapp@example.com``.
-* ``LOG_STDOUT``: whether to log to stdout or not. Defaults to: ``True``.
-* ``LOG_LEVEL``: control the verbosity of logging output. Available values are ``CRITICAL``, ``ERROR``, ``WARNING``, ``INFO`` and ``DEBUG``. Defaults to: ``WARNING``.
-* ``LOG_QUERIES``: enable (query) logging at the database backend level. Note that you must also set ``DEBUG=1``, which should be done very sparingly!. Defaults to: ``False``.
-* ``LOG_REQUESTS``: enable logging of the outgoing requests. Defaults to: ``False``.
-* ``CELERY_LOGLEVEL``: control the verbosity of logging output for celery, independent of ``LOG_LEVEL``. Available values are ``CRITICAL``, ``ERROR``, ``WARNING``, ``INFO`` and ``DEBUG``. Defaults to: ``INFO``.
 * ``SESSION_COOKIE_AGE``: For how long, in seconds, the session cookie will be valid. Defaults to: ``1209600``.
 * ``SESSION_COOKIE_SAMESITE``: The value of the SameSite flag on the session cookie. This flag prevents the cookie from being sent in cross-site requests thus preventing CSRF attacks and making some methods of stealing session cookie impossible.Currently interferes with OIDC. Keep the value set at Lax if used. Defaults to: ``Lax``.
 * ``CSRF_COOKIE_SAMESITE``: The value of the SameSite flag on the CSRF cookie. This flag prevents the cookie from being sent in cross-site requests. Defaults to: ``Strict``.
@@ -100,10 +109,6 @@ Optional
 * ``SITE_DOMAIN``: Defines the primary domain where the application is hosted. Defaults to: ``(empty string)``.
 * ``SENTRY_DSN``: URL of the sentry project to send error reports to. Default empty, i.e. -> no monitoring set up. Highly recommended to configure this.
 * ``DISABLE_2FA``: Whether or not two factor authentication should be disabled. Defaults to: ``False``.
-* ``LOG_OUTGOING_REQUESTS_EMIT_BODY``: Whether or not outgoing request bodies should be logged. Defaults to: ``True``.
-* ``LOG_OUTGOING_REQUESTS_DB_SAVE``: Whether or not outgoing request logs should be saved to the database. Defaults to: ``False``.
-* ``LOG_OUTGOING_REQUESTS_DB_SAVE_BODY``: Whether or not outgoing request bodies should be saved to the database. Defaults to: ``True``.
-* ``LOG_OUTGOING_REQUESTS_MAX_AGE``: The amount of time after which request logs should be deleted from the database. Defaults to: ``7``.
 
 
 

open_api_framework-0.10.0/tests/test_settings.py

@@ -0,0 +1,26 @@
+from django.conf import settings
+from django.urls import reverse
+
+import requests_mock
+from django_webtest import WebTest
+
+
+def test_sentry_settings():
+    """
+    test that sentry settings are initialized
+    """
+
+    assert hasattr(settings, "SENTRY_CONFIG") is True
+    assert hasattr(settings, "SENTRY_DSN") is True
+
+
+@requests_mock.Mocker()
+class RosettaTests(WebTest):
+    def test_rosetta_redirect_fails_with_lazy_login_url(self, m):
+        response = self.app.get("/admin/rosetta/files/project/")
+
+        expected_login_url = (
+            reverse(settings.LOGIN_URL) + "?next=/admin/rosetta/files/project/"
+        )
+        self.assertEqual(response.status_code, 302)
+        self.assertEqual(response.location, expected_login_url)

open_api_framework-0.9.6/tests/test_settings.py

@@ -1,8 +0,0 @@
-def test_sentry_settings():
-    """
-    test that sentry settings are initialized
-    """
-    from django.conf import settings
-
-    assert hasattr(settings, "SENTRY_CONFIG") is True
-    assert hasattr(settings, "SENTRY_DSN") is True