open-api-framework 0.10.3__tar.gz → 0.12.0__tar.gz

{open_api_framework-0.10.3 → open_api_framework-0.12.0}/CHANGELOG.rst

@@ -1,6 +1,51 @@
 Changelog
 =========
 
+0.12.0 (2025-07-15)
+-------------------
+
+**💥 Breaking changes**
+
+* Specify optional dependency groups:
+
+    * **celery**: ``celery``, ``flower``
+    * **cors**: ``django-cors-headers``
+    * **markup**: ``django-markup``
+    * **geo**: ``djangorestframework-gis``
+    * **csp**: ``django-csp``
+    * **commonground**: ``commonground-api-common``
+    * **inclusions**: ``djangorestframework-inclusions``
+    * **sanitization**: ``bleach``
+    * **server**: ``uwsgi``
+    * **redis**: ``django-redis``
+
+**New features**
+
+* Add DB connection pooling envvars + configuration (with workaround to make sure it works with APM)
+
+    * ``DB_POOL_ENABLED``
+    * ``DB_POOL_MIN_SIZE``
+    * ``DB_POOL_MAX_SIZE``
+    * ``DB_POOL_TIMEOUT``
+    * ``DB_POOL_MAX_WAITING``
+    * ``DB_POOL_MAX_LIFETIME``
+    * ``DB_POOL_MAX_IDLE``
+    * ``DB_POOL_RECONNECT_TIMEOUT``
+    * ``DB_POOL_NUM_WORKERS``
+
+* Add ``DB_CONN_MAX_AGE`` envvar (automatically set to 0 if connection pooling is enabled)
+
+**Maintenance**
+
+* Pin ```commonground-api-common``` to 2.7.0 or higher
+
+0.11.0 (2025-07-03)
+-------------------
+
+**New features**
+
+* Replace ``psycopg2`` with ``psycopg[binary]`` to support connection pooling
+
 0.10.3 (2025-06-17)
 -------------------
 

{open_api_framework-0.10.3/open_api_framework.egg-info → open_api_framework-0.12.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: open-api-framework
-Version: 0.10.3
+Version: 0.12.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
@@ -30,30 +30,19 @@ Description-Content-Type: text/x-rst
 License-File: LICENSE
 Requires-Dist: django>=5.2
 Requires-Dist: django-axes>=6.5.1
-Requires-Dist: django-cors-headers>=4.4.0
-Requires-Dist: django-markup>=1.8.1
 Requires-Dist: django-jsonform>=2.22.0
 Requires-Dist: django-log-outgoing-requests>=0.6.1
 Requires-Dist: django-admin-index>=3.1.0
-Requires-Dist: django-redis>=5.4.0
 Requires-Dist: djangorestframework>=3.15.2
-Requires-Dist: djangorestframework-gis>=1.0
 Requires-Dist: django-filter>=24.2
 Requires-Dist: drf-spectacular[sidecar]>=0.27.2
-Requires-Dist: django-csp>=3.8
-Requires-Dist: djangorestframework-inclusions>=1.2.0
-Requires-Dist: commonground-api-common>=2.1.2
 Requires-Dist: mozilla-django-oidc-db>=0.19.0
-Requires-Dist: psycopg2>=2.9.9
-Requires-Dist: bleach>=6.1.0
+Requires-Dist: psycopg[binary]>=3.2.9
 Requires-Dist: python-dotenv>=1.0.0
 Requires-Dist: python-decouple>=3.8
 Requires-Dist: requests>=2.32.3
-Requires-Dist: uwsgi>=2.0.23
 Requires-Dist: sentry-sdk>=2.11.0
 Requires-Dist: elastic-apm>=6.22.0
-Requires-Dist: celery>=5.4.0
-Requires-Dist: flower>=2.0.1
 Requires-Dist: maykin-2fa>=1.0.1
 Requires-Dist: django-setup-configuration>=0.1.0
 Requires-Dist: django-sessionprofile>=3.0.0
@@ -75,12 +64,33 @@ Requires-Dist: sphinx-rtd-theme; extra == "docs"
 Provides-Extra: release
 Requires-Dist: bump-my-version; extra == "release"
 Requires-Dist: twine; extra == "release"
+Provides-Extra: celery
+Requires-Dist: celery>=5.4.0; extra == "celery"
+Requires-Dist: flower>=2.0.1; extra == "celery"
+Provides-Extra: cors
+Requires-Dist: django-cors-headers>=4.4.0; extra == "cors"
+Provides-Extra: markup
+Requires-Dist: django-markup>=1.8.1; extra == "markup"
+Provides-Extra: geo
+Requires-Dist: djangorestframework-gis>=1.0; extra == "geo"
+Provides-Extra: csp
+Requires-Dist: django-csp>=3.8; extra == "csp"
+Provides-Extra: commonground
+Requires-Dist: commonground-api-common>=2.7.0; extra == "commonground"
+Provides-Extra: inclusions
+Requires-Dist: djangorestframework-inclusions>=1.2.0; extra == "inclusions"
+Provides-Extra: sanitization
+Requires-Dist: bleach>=6.1.0; extra == "sanitization"
+Provides-Extra: server
+Requires-Dist: uwsgi>=2.0.23; extra == "server"
+Provides-Extra: redis
+Requires-Dist: django-redis>=5.4.0; extra == "redis"
 Dynamic: license-file
 
 Open API Framework
 ==================
 
-:Version: 0.10.3
+:Version: 0.12.0
 :Source: https://github.com/maykinmedia/open-api-framework
 :Keywords: metapackage, dependencies
 

{open_api_framework-0.10.3 → open_api_framework-0.12.0}/README.rst

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

{open_api_framework-0.10.3 → open_api_framework-0.12.0}/open_api_framework/conf/base.py

@@ -138,6 +138,161 @@ DATABASES = {
     }
 }
 
+DATABASES["default"]["CONN_MAX_AGE"] = config(
+    "DB_CONN_MAX_AGE",
+    default=0,
+    # The default is set to `60` in the docker settings, so that's what is mentioned
+    # in the help text as well
+    help_text=(
+        "The lifetime of a database connection, as an integer of seconds. "
+        "Use 0 to close database connections at the end of each request — Django’s historical behavior. "
+        "This setting is ignored if connection pooling is used. Defaults to: ``60``."
+    ),
+    group="Database",
+    auto_display_default=False,
+    cast=lambda x: int(x) if x != "None" else None,
+)
+
+# https://docs.djangoproject.com/en/5.2/ref/databases/#connection-pool
+# https://www.psycopg.org/psycopg3/docs/api/pool.html#the-connectionpool-class
+
+DB_POOL_ENABLED = config(
+    "DB_POOL_ENABLED",
+    default=False,
+    help_text=("Whether to use connection pooling."),
+    group="Database",
+)
+
+DB_POOL_MIN_SIZE = config(
+    "DB_POOL_MIN_SIZE",
+    default=4,
+    help_text=(
+        "The minimum number of connection the pool will hold. "
+        "The pool will actively try to create new connections if some are lost (closed, broken) "
+        "and will try to never go below min_size."
+    ),
+    group="Database",
+    cast=int,
+)
+
+DB_POOL_MAX_SIZE = config(
+    "DB_POOL_MAX_SIZE",
+    default=None,
+    help_text=(
+        "The maximum number of connections the pool will hold. "
+        "If None, or equal to min_size, the pool will not grow or shrink. "
+        "If larger than min_size, the pool can grow if more than min_size connections "
+        "are requested at the same time and will shrink back after the extra connections "
+        "have been unused for more than max_idle seconds."
+    ),
+    group="Database",
+    cast=lambda x: int(x) if x is not None else None,
+)
+
+DB_POOL_TIMEOUT = config(
+    "DB_POOL_TIMEOUT",
+    default=30,
+    help_text=(
+        "The default maximum time in seconds that a client can wait "
+        "to receive a connection from the pool (using connection() or getconn()). "
+        "Note that these methods allow to override the timeout default."
+    ),
+    group="Database",
+    cast=int,
+)
+
+DB_POOL_MAX_WAITING = config(
+    "DB_POOL_MAX_WAITING",
+    default=0,
+    help_text=(
+        "Maximum number of requests that can be queued to the pool, "
+        "after which new requests will fail, raising TooManyRequests. 0 means no queue limit."
+    ),
+    group="Database",
+    cast=int,
+)
+
+DB_POOL_MAX_LIFETIME = config(
+    "DB_POOL_MAX_LIFETIME",
+    default=60 * 60,
+    help_text=(
+        "The maximum lifetime of a connection in the pool, in seconds. "
+        "Connections used for longer get closed and replaced by a new one. "
+        "The amount is reduced by a random 10% to avoid mass eviction"
+    ),
+    group="Database",
+    cast=int,
+)
+
+DB_POOL_MAX_IDLE = config(
+    "DB_POOL_MAX_IDLE",
+    default=10 * 60,
+    help_text=(
+        "Maximum time, in seconds, that a connection can stay unused in the pool "
+        "before being closed, and the pool shrunk. This only happens to "
+        "connections more than min_size, if max_size allowed the pool to grow."
+    ),
+    group="Database",
+    cast=int,
+)
+
+DB_POOL_RECONNECT_TIMEOUT = config(
+    "DB_POOL_RECONNECT_TIMEOUT",
+    default=5 * 60,
+    help_text=(
+        "Maximum time, in seconds, the pool will try to create a connection. "
+        "If a connection attempt fails, the pool will try to reconnect a few times, "
+        "using an exponential backoff and some random factor to avoid mass attempts. "
+        "If repeated attempts fail, after reconnect_timeout second the connection "
+        "attempt is aborted and the reconnect_failed() callback invoked."
+    ),
+    group="Database",
+    cast=int,
+)
+
+DB_POOL_NUM_WORKERS = config(
+    "DB_POOL_NUM_WORKERS",
+    default=3,
+    help_text=(
+        "Number of background worker threads used to maintain the pool state. "
+        "Background workers are used for example to create new connections and "
+        "to clean up connections when they are returned to the pool."
+    ),
+    group="Database",
+    cast=int,
+)
+
+
+if DB_POOL_ENABLED:
+    # FIXME Workaround for https://github.com/elastic/apm-agent-python/issues/2094
+    # apm-agent-python does not instrument ConnectionPool yet
+    import psycopg
+
+    class WrapperConnectionClass(psycopg.Connection):
+        @classmethod
+        def connect(
+            cls,
+            conninfo: str = "",
+            **kwargs,
+        ) -> "psycopg.Connection[psycopg.rows.TupleRow]":
+            return psycopg.connect(conninfo, **kwargs)
+
+    DATABASES["default"]["OPTIONS"] = {
+        "pool": {
+            "min_size": DB_POOL_MIN_SIZE,
+            "max_size": DB_POOL_MAX_SIZE,
+            "timeout": DB_POOL_TIMEOUT,
+            "max_waiting": DB_POOL_MAX_WAITING,
+            "max_lifetime": DB_POOL_MAX_LIFETIME,
+            "max_idle": DB_POOL_MAX_IDLE,
+            "reconnect_timeout": DB_POOL_RECONNECT_TIMEOUT,
+            "num_workers": DB_POOL_NUM_WORKERS,
+            "connection_class": WrapperConnectionClass,
+        }
+    }
+    # Cannot use a `CONN_MAX_AGE` other than 0 with connection pooling
+    DATABASES["default"]["CONN_MAX_AGE"] = 0
+
 # keep the current schema for now and deal with migrating to BigAutoField later, see
 # https://docs.djangoproject.com/en/4.0/ref/settings/#std:setting-DEFAULT_AUTO_FIELD
 DEFAULT_AUTO_FIELD = "django.db.models.AutoField"

{open_api_framework-0.10.3 → open_api_framework-0.12.0/open_api_framework.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: open-api-framework
-Version: 0.10.3
+Version: 0.12.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
@@ -30,30 +30,19 @@ Description-Content-Type: text/x-rst
 License-File: LICENSE
 Requires-Dist: django>=5.2
 Requires-Dist: django-axes>=6.5.1
-Requires-Dist: django-cors-headers>=4.4.0
-Requires-Dist: django-markup>=1.8.1
 Requires-Dist: django-jsonform>=2.22.0
 Requires-Dist: django-log-outgoing-requests>=0.6.1
 Requires-Dist: django-admin-index>=3.1.0
-Requires-Dist: django-redis>=5.4.0
 Requires-Dist: djangorestframework>=3.15.2
-Requires-Dist: djangorestframework-gis>=1.0
 Requires-Dist: django-filter>=24.2
 Requires-Dist: drf-spectacular[sidecar]>=0.27.2
-Requires-Dist: django-csp>=3.8
-Requires-Dist: djangorestframework-inclusions>=1.2.0
-Requires-Dist: commonground-api-common>=2.1.2
 Requires-Dist: mozilla-django-oidc-db>=0.19.0
-Requires-Dist: psycopg2>=2.9.9
-Requires-Dist: bleach>=6.1.0
+Requires-Dist: psycopg[binary]>=3.2.9
 Requires-Dist: python-dotenv>=1.0.0
 Requires-Dist: python-decouple>=3.8
 Requires-Dist: requests>=2.32.3
-Requires-Dist: uwsgi>=2.0.23
 Requires-Dist: sentry-sdk>=2.11.0
 Requires-Dist: elastic-apm>=6.22.0
-Requires-Dist: celery>=5.4.0
-Requires-Dist: flower>=2.0.1
 Requires-Dist: maykin-2fa>=1.0.1
 Requires-Dist: django-setup-configuration>=0.1.0
 Requires-Dist: django-sessionprofile>=3.0.0
@@ -75,12 +64,33 @@ Requires-Dist: sphinx-rtd-theme; extra == "docs"
 Provides-Extra: release
 Requires-Dist: bump-my-version; extra == "release"
 Requires-Dist: twine; extra == "release"
+Provides-Extra: celery
+Requires-Dist: celery>=5.4.0; extra == "celery"
+Requires-Dist: flower>=2.0.1; extra == "celery"
+Provides-Extra: cors
+Requires-Dist: django-cors-headers>=4.4.0; extra == "cors"
+Provides-Extra: markup
+Requires-Dist: django-markup>=1.8.1; extra == "markup"
+Provides-Extra: geo
+Requires-Dist: djangorestframework-gis>=1.0; extra == "geo"
+Provides-Extra: csp
+Requires-Dist: django-csp>=3.8; extra == "csp"
+Provides-Extra: commonground
+Requires-Dist: commonground-api-common>=2.7.0; extra == "commonground"
+Provides-Extra: inclusions
+Requires-Dist: djangorestframework-inclusions>=1.2.0; extra == "inclusions"
+Provides-Extra: sanitization
+Requires-Dist: bleach>=6.1.0; extra == "sanitization"
+Provides-Extra: server
+Requires-Dist: uwsgi>=2.0.23; extra == "server"
+Provides-Extra: redis
+Requires-Dist: django-redis>=5.4.0; extra == "redis"
 Dynamic: license-file
 
 Open API Framework
 ==================
 
-:Version: 0.10.3
+:Version: 0.12.0
 :Source: https://github.com/maykinmedia/open-api-framework
 :Keywords: metapackage, dependencies
 

{open_api_framework-0.10.3 → open_api_framework-0.12.0}/open_api_framework.egg-info/requires.txt

@@ -1,45 +1,65 @@
 django>=5.2
 django-axes>=6.5.1
-django-cors-headers>=4.4.0
-django-markup>=1.8.1
 django-jsonform>=2.22.0
 django-log-outgoing-requests>=0.6.1
 django-admin-index>=3.1.0
-django-redis>=5.4.0
 djangorestframework>=3.15.2
-djangorestframework-gis>=1.0
 django-filter>=24.2
 drf-spectacular[sidecar]>=0.27.2
-django-csp>=3.8
-djangorestframework-inclusions>=1.2.0
-commonground-api-common>=2.1.2
 mozilla-django-oidc-db>=0.19.0
-psycopg2>=2.9.9
-bleach>=6.1.0
+psycopg[binary]>=3.2.9
 python-dotenv>=1.0.0
 python-decouple>=3.8
 requests>=2.32.3
-uwsgi>=2.0.23
 sentry-sdk>=2.11.0
 elastic-apm>=6.22.0
-celery>=5.4.0
-flower>=2.0.1
 maykin-2fa>=1.0.1
 django-setup-configuration>=0.1.0
 django-sessionprofile>=3.0.0
 django-upgrade-check>=1.1.0
 
+[celery]
+celery>=5.4.0
+flower>=2.0.1
+
+[commonground]
+commonground-api-common>=2.7.0
+
+[cors]
+django-cors-headers>=4.4.0
+
 [coverage]
 pytest-cov
 
+[csp]
+django-csp>=3.8
+
 [docs]
 sphinx
 sphinx-rtd-theme
 
+[geo]
+djangorestframework-gis>=1.0
+
+[inclusions]
+djangorestframework-inclusions>=1.2.0
+
+[markup]
+django-markup>=1.8.1
+
+[redis]
+django-redis>=5.4.0
+
 [release]
 bump-my-version
 twine
 
+[sanitization]
+bleach>=6.1.0
+
+[server]
+uwsgi>=2.0.23
+
 [tests]
 pytest
 pytest-django

{open_api_framework-0.10.3 → open_api_framework-0.12.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "open-api-framework"
-version = "0.10.3"
+version = "0.12.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"}
@@ -27,30 +27,19 @@ requires-python = ">=3.12"
 dependencies = [
     "django>=5.2",
     "django-axes>=6.5.1",
-    "django-cors-headers>=4.4.0",
-    "django-markup>=1.8.1",
     "django-jsonform>=2.22.0",
     "django-log-outgoing-requests>=0.6.1",
     "django-admin-index>=3.1.0",
-    "django-redis>=5.4.0",
     "djangorestframework>=3.15.2",
-    "djangorestframework-gis>=1.0",
     "django-filter>=24.2",
     "drf-spectacular[sidecar]>=0.27.2",
-    "django-csp>=3.8",
-    "djangorestframework-inclusions>=1.2.0",
-    "commonground-api-common>=2.1.2",
     "mozilla-django-oidc-db>=0.19.0",
-    "psycopg2>=2.9.9",
-    "bleach>=6.1.0",
+    "psycopg[binary]>=3.2.9",
     "python-dotenv>=1.0.0",
     "python-decouple>=3.8",
     "requests>=2.32.3",
-    "uwsgi>=2.0.23",
     "sentry-sdk>=2.11.0",
     "elastic-apm>=6.22.0",
-    "celery>=5.4.0",
-    "flower>=2.0.1",
     "maykin-2fa>=1.0.1",
     "django-setup-configuration>=0.1.0",
     "django-sessionprofile>=3.0.0",
@@ -85,6 +74,37 @@ release = [
     "bump-my-version",
     "twine",
 ]
+celery = [
+    "celery>=5.4.0",
+    "flower>=2.0.1"
+]
+cors = [
+    "django-cors-headers>=4.4.0"
+]
+markup = [
+    "django-markup>=1.8.1"
+]
+geo = [
+    "djangorestframework-gis>=1.0"
+]
+csp = [
+    "django-csp>=3.8"
+]
+commonground = [
+    "commonground-api-common>=2.7.0"
+]
+inclusions = [
+    "djangorestframework-inclusions>=1.2.0"
+]
+sanitization = [
+    "bleach>=6.1.0"
+]
+server = [
+    "uwsgi>=2.0.23"
+]
+redis = [
+    "django-redis>=5.4.0"
+]
 
 [tool.setuptools.packages.find]
 include = ["open_api_framework*"]
@@ -100,7 +120,7 @@ env = [
 ]
 
 [tool.bumpversion]
-current_version = "0.10.3"
+current_version = "0.12.0"
 files = [
     {filename = "pyproject.toml"},
     {filename = "README.rst"},

{open_api_framework-0.10.3 → open_api_framework-0.12.0}/tests/test_generate_envvar_docs.py

@@ -33,6 +33,16 @@ Database
 * ``DB_PASSWORD``: password of the database user. Defaults to: ``testapp``.
 * ``DB_HOST``: hostname of the PostgreSQL database. Defaults to ``db`` for the docker environment, otherwise defaults to ``localhost``.
 * ``DB_PORT``: port number of the database. Defaults to: ``5432``.
+* ``DB_CONN_MAX_AGE``: The lifetime of a database connection, as an integer of seconds. Use 0 to close database connections at the end of each request — Django’s historical behavior. This setting is ignored if connection pooling is used. Defaults to: ``60``.
+* ``DB_POOL_ENABLED``: Whether to use connection pooling. Defaults to: ``False``.
+* ``DB_POOL_MIN_SIZE``: The minimum number of connection the pool will hold. The pool will actively try to create new connections if some are lost (closed, broken) and will try to never go below min_size. Defaults to: ``4``.
+* ``DB_POOL_MAX_SIZE``: The maximum number of connections the pool will hold. If None, or equal to min_size, the pool will not grow or shrink. If larger than min_size, the pool can grow if more than min_size connections are requested at the same time and will shrink back after the extra connections have been unused for more than max_idle seconds. Defaults to: ``None``.
+* ``DB_POOL_TIMEOUT``: The default maximum time in seconds that a client can wait to receive a connection from the pool (using connection() or getconn()). Note that these methods allow to override the timeout default. Defaults to: ``30``.
+* ``DB_POOL_MAX_WAITING``: Maximum number of requests that can be queued to the pool, after which new requests will fail, raising TooManyRequests. 0 means no queue limit. Defaults to: ``0``.
+* ``DB_POOL_MAX_LIFETIME``: The maximum lifetime of a connection in the pool, in seconds. Connections used for longer get closed and replaced by a new one. The amount is reduced by a random 10% to avoid mass eviction. Defaults to: ``3600``.
+* ``DB_POOL_MAX_IDLE``: Maximum time, in seconds, that a connection can stay unused in the pool before being closed, and the pool shrunk. This only happens to connections more than min_size, if max_size allowed the pool to grow. Defaults to: ``600``.
+* ``DB_POOL_RECONNECT_TIMEOUT``: Maximum time, in seconds, the pool will try to create a connection. If a connection attempt fails, the pool will try to reconnect a few times, using an exponential backoff and some random factor to avoid mass attempts. If repeated attempts fail, after reconnect_timeout second the connection attempt is aborted and the reconnect_failed() callback invoked. Defaults to: ``300``.
+* ``DB_POOL_NUM_WORKERS``: Number of background worker threads used to maintain the pool state. Background workers are used for example to create new connections and to clean up connections when they are returned to the pool. Defaults to: ``3``.
 
 
 Logging