open-api-framework 0.11.0__tar.gz → 0.13.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (37) hide show
  1. {open_api_framework-0.11.0 → open_api_framework-0.13.0}/CHANGELOG.rst +81 -0
  2. {open_api_framework-0.11.0/open_api_framework.egg-info → open_api_framework-0.13.0}/PKG-INFO +29 -13
  3. {open_api_framework-0.11.0 → open_api_framework-0.13.0}/README.rst +1 -1
  4. {open_api_framework-0.11.0 → open_api_framework-0.13.0}/open_api_framework/conf/base.py +599 -222
  5. {open_api_framework-0.11.0 → open_api_framework-0.13.0/open_api_framework.egg-info}/PKG-INFO +29 -13
  6. {open_api_framework-0.11.0 → open_api_framework-0.13.0}/open_api_framework.egg-info/SOURCES.txt +1 -0
  7. {open_api_framework-0.11.0 → open_api_framework-0.13.0}/open_api_framework.egg-info/requires.txt +39 -11
  8. {open_api_framework-0.11.0 → open_api_framework-0.13.0}/pyproject.toml +42 -13
  9. open_api_framework-0.13.0/tests/test_csp.py +66 -0
  10. {open_api_framework-0.11.0 → open_api_framework-0.13.0}/tests/test_generate_envvar_docs.py +18 -6
  11. {open_api_framework-0.11.0 → open_api_framework-0.13.0}/LICENSE +0 -0
  12. {open_api_framework-0.11.0 → open_api_framework-0.13.0}/MANIFEST.in +0 -0
  13. {open_api_framework-0.11.0 → open_api_framework-0.13.0}/open_api_framework/__init__.py +0 -0
  14. {open_api_framework-0.11.0 → open_api_framework-0.13.0}/open_api_framework/admin.py +0 -0
  15. {open_api_framework-0.11.0 → open_api_framework-0.13.0}/open_api_framework/apps.py +0 -0
  16. {open_api_framework-0.11.0 → open_api_framework-0.13.0}/open_api_framework/conf/__init__.py +0 -0
  17. {open_api_framework-0.11.0 → open_api_framework-0.13.0}/open_api_framework/conf/utils.py +0 -0
  18. {open_api_framework-0.11.0 → open_api_framework-0.13.0}/open_api_framework/context_processors.py +0 -0
  19. {open_api_framework-0.11.0 → open_api_framework-0.13.0}/open_api_framework/management/__init__.py +0 -0
  20. {open_api_framework-0.11.0 → open_api_framework-0.13.0}/open_api_framework/management/commands/__init__.py +0 -0
  21. {open_api_framework-0.11.0 → open_api_framework-0.13.0}/open_api_framework/management/commands/generate_envvar_docs.py +0 -0
  22. {open_api_framework-0.11.0 → open_api_framework-0.13.0}/open_api_framework/py.typed +0 -0
  23. {open_api_framework-0.11.0 → open_api_framework-0.13.0}/open_api_framework/static/open_api_framework/css/admin.css +0 -0
  24. {open_api_framework-0.11.0 → open_api_framework-0.13.0}/open_api_framework/templates/open_api_framework/admin/base_site.html +0 -0
  25. {open_api_framework-0.11.0 → open_api_framework-0.13.0}/open_api_framework/templates/open_api_framework/components/environment.html +0 -0
  26. {open_api_framework-0.11.0 → open_api_framework-0.13.0}/open_api_framework/templates/open_api_framework/components/version.html +0 -0
  27. {open_api_framework-0.11.0 → open_api_framework-0.13.0}/open_api_framework/templates/open_api_framework/env_config.rst +0 -0
  28. {open_api_framework-0.11.0 → open_api_framework-0.13.0}/open_api_framework/templatetags/__init__.py +0 -0
  29. {open_api_framework-0.11.0 → open_api_framework-0.13.0}/open_api_framework/templatetags/doc_tags.py +0 -0
  30. {open_api_framework-0.11.0 → open_api_framework-0.13.0}/open_api_framework/templatetags/open_api_framework.py +0 -0
  31. {open_api_framework-0.11.0 → open_api_framework-0.13.0}/open_api_framework/utils.py +0 -0
  32. {open_api_framework-0.11.0 → open_api_framework-0.13.0}/open_api_framework.egg-info/dependency_links.txt +0 -0
  33. {open_api_framework-0.11.0 → open_api_framework-0.13.0}/open_api_framework.egg-info/top_level.txt +0 -0
  34. {open_api_framework-0.11.0 → open_api_framework-0.13.0}/setup.cfg +0 -0
  35. {open_api_framework-0.11.0 → open_api_framework-0.13.0}/tests/test_admin.py +0 -0
  36. {open_api_framework-0.11.0 → open_api_framework-0.13.0}/tests/test_config_helpers.py +0 -0
  37. {open_api_framework-0.11.0 → open_api_framework-0.13.0}/tests/test_settings.py +0 -0
@@ -1,6 +1,87 @@
1
1
  Changelog
2
2
  =========
3
3
 
4
+ 0.13.0 (2025-09-18)
5
+ -------------------
6
+
7
+ **New features**
8
+
9
+ * [#178] Add logging envvars:
10
+
11
+ * ``LOG_FORMAT_CONSOLE``
12
+ * ``ENABLE_STRUCTLOG_REQUESTS``
13
+
14
+ * [#178] Specify optional dependency groups:
15
+
16
+ * **structlog**: ``structlog``, ``django-structlog``
17
+ * **structlog-celery**: ``structlog``, ``django-structlog[celery]``
18
+
19
+ * [#178] Add option to configure whether to use structlog or standard logging (default: stdlib logging).
20
+ To enable structlog, downstream projects can do the following in their base settings:
21
+
22
+ .. code-block:: python
23
+
24
+ os.environ["_USE_STRUCTLOG"] = "True"
25
+
26
+ from open_api_framework.conf.base import * # noqa
27
+
28
+ **Bugfixes/QOL**
29
+
30
+ * Fix casting DB_PORT "" to int
31
+
32
+ **Maintenance**
33
+
34
+ * Pin ```django-csp``` to 4.0 or higher.
35
+
36
+ .. warning::
37
+
38
+ The CSP environment variables function the same as with 3.8, but if any changes are made to
39
+ CSP settings for downstream projects (like adding extra values to directives via the old 3.8 settings),
40
+ manual action is needed to make sure it works with 4.0
41
+ (`see documentation <https://django-csp.readthedocs.io/en/latest/configuration.html#migrating-from-django-csp-3-8>`_)
42
+
43
+ **Documentation**
44
+
45
+ * [#171] Add documentation for connection pooling behaviour.
46
+
47
+ 0.12.0 (2025-07-15)
48
+ -------------------
49
+
50
+ **💥 Breaking changes**
51
+
52
+ * Specify optional dependency groups:
53
+
54
+ * **celery**: ``celery``, ``flower``
55
+ * **cors**: ``django-cors-headers``
56
+ * **markup**: ``django-markup``
57
+ * **geo**: ``djangorestframework-gis``
58
+ * **csp**: ``django-csp``
59
+ * **commonground**: ``commonground-api-common``
60
+ * **inclusions**: ``djangorestframework-inclusions``
61
+ * **sanitization**: ``bleach``
62
+ * **server**: ``uwsgi``
63
+ * **redis**: ``django-redis``
64
+
65
+ **New features**
66
+
67
+ * Add DB connection pooling envvars + configuration (with workaround to make sure it works with APM)
68
+
69
+ * ``DB_POOL_ENABLED``
70
+ * ``DB_POOL_MIN_SIZE``
71
+ * ``DB_POOL_MAX_SIZE``
72
+ * ``DB_POOL_TIMEOUT``
73
+ * ``DB_POOL_MAX_WAITING``
74
+ * ``DB_POOL_MAX_LIFETIME``
75
+ * ``DB_POOL_MAX_IDLE``
76
+ * ``DB_POOL_RECONNECT_TIMEOUT``
77
+ * ``DB_POOL_NUM_WORKERS``
78
+
79
+ * Add ``DB_CONN_MAX_AGE`` envvar (automatically set to 0 if connection pooling is enabled)
80
+
81
+ **Maintenance**
82
+
83
+ * Pin ```commonground-api-common``` to 2.7.0 or higher
84
+
4
85
  0.11.0 (2025-07-03)
5
86
  -------------------
6
87
 
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: open-api-framework
3
- Version: 0.11.0
3
+ Version: 0.13.0
4
4
  Summary: A metapackage for registration components, that bundles the dependencies shared between these components and provides generic settings
5
5
  Author-email: Maykin Media <support@maykinmedia.nl>
6
6
  License: Copyright © Maykin 2024
@@ -30,30 +30,19 @@ Description-Content-Type: text/x-rst
30
30
  License-File: LICENSE
31
31
  Requires-Dist: django>=5.2
32
32
  Requires-Dist: django-axes>=6.5.1
33
- Requires-Dist: django-cors-headers>=4.4.0
34
- Requires-Dist: django-markup>=1.8.1
35
33
  Requires-Dist: django-jsonform>=2.22.0
36
34
  Requires-Dist: django-log-outgoing-requests>=0.6.1
37
35
  Requires-Dist: django-admin-index>=3.1.0
38
- Requires-Dist: django-redis>=5.4.0
39
36
  Requires-Dist: djangorestframework>=3.15.2
40
- Requires-Dist: djangorestframework-gis>=1.0
41
37
  Requires-Dist: django-filter>=24.2
42
38
  Requires-Dist: drf-spectacular[sidecar]>=0.27.2
43
- Requires-Dist: django-csp>=3.8
44
- Requires-Dist: djangorestframework-inclusions>=1.2.0
45
- Requires-Dist: commonground-api-common>=2.1.2
46
39
  Requires-Dist: mozilla-django-oidc-db>=0.19.0
47
40
  Requires-Dist: psycopg[binary]>=3.2.9
48
- Requires-Dist: bleach>=6.1.0
49
41
  Requires-Dist: python-dotenv>=1.0.0
50
42
  Requires-Dist: python-decouple>=3.8
51
43
  Requires-Dist: requests>=2.32.3
52
- Requires-Dist: uwsgi>=2.0.23
53
44
  Requires-Dist: sentry-sdk>=2.11.0
54
45
  Requires-Dist: elastic-apm>=6.22.0
55
- Requires-Dist: celery>=5.4.0
56
- Requires-Dist: flower>=2.0.1
57
46
  Requires-Dist: maykin-2fa>=1.0.1
58
47
  Requires-Dist: django-setup-configuration>=0.1.0
59
48
  Requires-Dist: django-sessionprofile>=3.0.0
@@ -75,12 +64,39 @@ Requires-Dist: sphinx-rtd-theme; extra == "docs"
75
64
  Provides-Extra: release
76
65
  Requires-Dist: bump-my-version; extra == "release"
77
66
  Requires-Dist: twine; extra == "release"
67
+ Provides-Extra: celery
68
+ Requires-Dist: celery>=5.4.0; extra == "celery"
69
+ Requires-Dist: flower>=2.0.1; extra == "celery"
70
+ Provides-Extra: cors
71
+ Requires-Dist: django-cors-headers>=4.4.0; extra == "cors"
72
+ Provides-Extra: markup
73
+ Requires-Dist: django-markup>=1.8.1; extra == "markup"
74
+ Provides-Extra: geo
75
+ Requires-Dist: djangorestframework-gis>=1.0; extra == "geo"
76
+ Provides-Extra: csp
77
+ Requires-Dist: django-csp>=4.0; extra == "csp"
78
+ Provides-Extra: commonground
79
+ Requires-Dist: commonground-api-common>=2.7.0; extra == "commonground"
80
+ Provides-Extra: inclusions
81
+ Requires-Dist: djangorestframework-inclusions>=1.2.0; extra == "inclusions"
82
+ Provides-Extra: sanitization
83
+ Requires-Dist: bleach>=6.1.0; extra == "sanitization"
84
+ Provides-Extra: server
85
+ Requires-Dist: uwsgi>=2.0.23; extra == "server"
86
+ Provides-Extra: redis
87
+ Requires-Dist: django-redis>=5.4.0; extra == "redis"
88
+ Provides-Extra: structlog
89
+ Requires-Dist: structlog>=25.4.0; extra == "structlog"
90
+ Requires-Dist: django-structlog>=9.1.1; extra == "structlog"
91
+ Provides-Extra: structlog-celery
92
+ Requires-Dist: structlog>=25.4.0; extra == "structlog-celery"
93
+ Requires-Dist: django-structlog[celery]>=9.1.1; extra == "structlog-celery"
78
94
  Dynamic: license-file
79
95
 
80
96
  Open API Framework
81
97
  ==================
82
98
 
83
- :Version: 0.11.0
99
+ :Version: 0.13.0
84
100
  :Source: https://github.com/maykinmedia/open-api-framework
85
101
  :Keywords: metapackage, dependencies
86
102
 
@@ -1,7 +1,7 @@
1
1
  Open API Framework
2
2
  ==================
3
3
 
4
- :Version: 0.11.0
4
+ :Version: 0.13.0
5
5
  :Source: https://github.com/maykinmedia/open-api-framework
6
6
  :Keywords: metapackage, dependencies
7
7