django-settings-expose 0.1.0__tar.gz

django_settings_expose-0.1.0/.gitignore

@@ -0,0 +1,12 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv
+
+.idea

django_settings_expose-0.1.0/.python-version

@@ -0,0 +1 @@
+3.9

django_settings_expose-0.1.0/LICENSE

@@ -0,0 +1,54 @@
+MIT License
+
+Copyright (c) 2026 Vladimir Klimenko <v.klimenko.2137@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+========================================================================
+Third-Party Code Components Included in this Product
+========================================================================
+
+This product includes code from the "django-settings-export" project, originally developed by Jakub Roztocil.
+
+Copyright © 2014 Jakub Roztocil <jakub@subtleapps.com>
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+    1. Redistributions of source code must retain the above copyright notice,
+       this list of conditions and the following disclaimer.
+
+    2. Redistributions in binary form must reproduce the above copyright
+       notice, this list of conditions and the following disclaimer in the
+       documentation and/or other materials provided with the distribution.
+
+    3. Neither the name of The author nor the names of its contributors may
+       be used to endorse or promote products derived from this software
+       without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE AUTHOR AND CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

django_settings_expose-0.1.0/PKG-INFO

@@ -0,0 +1,119 @@
+Metadata-Version: 2.4
+Name: django-settings-expose
+Version: 0.1.0
+Summary: Fast, cached Django settings exporter to templates.
+Author-email: Vladimir Klimenko <v.klimenko.2137@gmail.com>
+License: MIT
+License-File: LICENSE
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 3.2
+Classifier: Framework :: Django :: 4.2
+Classifier: Framework :: Django :: 5.2
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: <=3.14,>=3.9
+Requires-Dist: django<=5.2,>=3.2
+Description-Content-Type: text/markdown
+
+# django-settings-expose
+
+A modern, high-performance, and cached Django context processor that safely exposes specific settings to your templates.
+
+This is a heavily optimized drop-in replacement for the unmaintained `django-settings-export` package.
+Unlike the original implementation, `django-settings-expose` caches your exposed settings in memory at server startup,
+introducing **zero performance overhead** on later template renders.
+
+## Features
+
+- ⚡ **Zero-overhead:** Settings are read and cached once when the server boots.
+- 🔒 **Secure:** Only whitelisted settings in `SETTINGS_EXPOSE` are exposed.
+- 🛑 **Fail-fast:** Throws clear, descriptive errors during development if you typo a setting name or try to access an
+  unexposed variable in a template.
+
+---
+
+## Installation
+
+Install the package directly from PyPI:
+
+```bash
+pip install django-settings-expose
+```
+
+---
+
+## Configuration
+
+1. Add the context processor to your `settings.py` inside the `TEMPLATES` configuration:
+
+```python
+# settings.py
+
+TEMPLATES = [
+    {
+        # ...
+        "OPTIONS": {
+            "context_processors": [
+                # ...
+                # Add this line:
+                "django_settings_expose.settings_expose",
+            ],
+        },
+    },
+]
+```
+
+2. Define the list of settings you want to expose to your templates using `SETTINGS_EXPOSE`:
+
+```python
+# settings.py
+
+API_VERSION = "v1.2.6"
+COMPANY_NAME = "My Awesome Company"
+SECRET_KEY = "super-secret"  # Keep this safe!
+
+# Whitelist variables to be accessible in templates
+SETTINGS_EXPOSE = [
+    "API_VERSION",
+    "COMPANY_NAME",
+]
+```
+
+---
+
+## Usage in Templates
+
+All exposed settings are made available via a globally accessible `{{ settings }}` dictionary variable:
+
+```html
+
+<footer>
+  <p>Copyright © 2026 {{ settings.COMPANY_NAME }}</p>
+  <p>API Version: {{ settings.API_VERSION }}</p>
+</footer>
+```
+
+### Error Handling
+
+To protect you from typos and silent bugs, the library will raise explicit exceptions:
+
+* If a variable listed in `SETTINGS_EXPOSE` is missing from `settings.py`, it throws an `UndefinedSettingError` on
+  startup.
+* If a template attempts to access a variable that wasn't whitelisted (e.g., `{{ settings.SECRET_KEY }}`), it
+  throws an `UnexposedSettingError`.
+
+---
+
+## License & Acknowledgements
+
+This project is licensed under the **BSD 3-Clause License**.
+
+It is based on the original concept of `django-settings-export` by `Jakub Roztocil <jakub@subtleapps.com>` (Copyright ©
+2014).
+Modified and optimized by `Vladimir Klimenko <v.klimenko.2137@gmail.com>` (Copyright © 2026).

django_settings_expose-0.1.0/README.md

@@ -0,0 +1,96 @@
+# django-settings-expose
+
+A modern, high-performance, and cached Django context processor that safely exposes specific settings to your templates.
+
+This is a heavily optimized drop-in replacement for the unmaintained `django-settings-export` package.
+Unlike the original implementation, `django-settings-expose` caches your exposed settings in memory at server startup,
+introducing **zero performance overhead** on later template renders.
+
+## Features
+
+- ⚡ **Zero-overhead:** Settings are read and cached once when the server boots.
+- 🔒 **Secure:** Only whitelisted settings in `SETTINGS_EXPOSE` are exposed.
+- 🛑 **Fail-fast:** Throws clear, descriptive errors during development if you typo a setting name or try to access an
+  unexposed variable in a template.
+
+---
+
+## Installation
+
+Install the package directly from PyPI:
+
+```bash
+pip install django-settings-expose
+```
+
+---
+
+## Configuration
+
+1. Add the context processor to your `settings.py` inside the `TEMPLATES` configuration:
+
+```python
+# settings.py
+
+TEMPLATES = [
+    {
+        # ...
+        "OPTIONS": {
+            "context_processors": [
+                # ...
+                # Add this line:
+                "django_settings_expose.settings_expose",
+            ],
+        },
+    },
+]
+```
+
+2. Define the list of settings you want to expose to your templates using `SETTINGS_EXPOSE`:
+
+```python
+# settings.py
+
+API_VERSION = "v1.2.6"
+COMPANY_NAME = "My Awesome Company"
+SECRET_KEY = "super-secret"  # Keep this safe!
+
+# Whitelist variables to be accessible in templates
+SETTINGS_EXPOSE = [
+    "API_VERSION",
+    "COMPANY_NAME",
+]
+```
+
+---
+
+## Usage in Templates
+
+All exposed settings are made available via a globally accessible `{{ settings }}` dictionary variable:
+
+```html
+
+<footer>
+  <p>Copyright © 2026 {{ settings.COMPANY_NAME }}</p>
+  <p>API Version: {{ settings.API_VERSION }}</p>
+</footer>
+```
+
+### Error Handling
+
+To protect you from typos and silent bugs, the library will raise explicit exceptions:
+
+* If a variable listed in `SETTINGS_EXPOSE` is missing from `settings.py`, it throws an `UndefinedSettingError` on
+  startup.
+* If a template attempts to access a variable that wasn't whitelisted (e.g., `{{ settings.SECRET_KEY }}`), it
+  throws an `UnexposedSettingError`.
+
+---
+
+## License & Acknowledgements
+
+This project is licensed under the **BSD 3-Clause License**.
+
+It is based on the original concept of `django-settings-export` by `Jakub Roztocil <jakub@subtleapps.com>` (Copyright ©
+2014).
+Modified and optimized by `Vladimir Klimenko <v.klimenko.2137@gmail.com>` (Copyright © 2026).

django_settings_expose-0.1.0/django_settings_expose/__init__.py

@@ -0,0 +1,13 @@
+from .context_processors import (
+    settings_expose,
+    SettingsExposeError,
+    UndefinedSettingError,
+    UnexposedSettingError,
+)
+
+__all__ = [
+    "settings_expose",
+    "SettingsExposeError",
+    "UndefinedSettingError",
+    "UnexposedSettingError",
+]

django_settings_expose-0.1.0/django_settings_expose/context_processors.py

@@ -0,0 +1,62 @@
+"""
+Modern implementation of Django settings exporter to templates.
+Based on django-settings-export by Jakub Roztocil.
+
+Original work Copyright © 2014 Jakub Roztocil <jakub@subtleapps.com>
+Modified work Copyright © 2026 Vladimir Klimenko <v.klimenko.2137@gmail.com>
+
+Licensed under the MIT License.
+The original component is licensed under the BSD 3-Clause License.
+See the LICENSE file in the root of this project for full license texts.
+"""
+
+from django.conf import settings as django_settings
+from django.core.exceptions import ImproperlyConfigured
+
+
+class SettingsExposeError(ImproperlyConfigured):
+    """Base error indicating misconfiguration."""
+
+
+class UndefinedSettingError(SettingsExposeError):
+    """An undefined setting name included in SETTINGS_EXPOSE."""
+
+
+class UnexposedSettingError(SettingsExposeError):
+    """An unexposed setting has been accessed from a template."""
+
+
+class ExposedSettings(dict):
+    def __init__(self, settings_obj, **kwargs):
+        super().__init__(**kwargs)
+        for var in getattr(settings_obj, "SETTINGS_EXPOSE", []):
+            try:
+                self[var] = getattr(settings_obj, var)
+            except AttributeError:
+                raise UndefinedSettingError(
+                    f"'{var}' is included in SETTINGS_EXPOSE "
+                    f"but it does not exist in settings.py!",
+                )
+
+    def __missing__(self, key):
+        if hasattr(self, key):
+            raise KeyError(key)
+        raise UnexposedSettingError(
+            f"The 'settings.{key}' variable is not accessible from templates. "
+            f"Please add '{key}' to the SETTINGS_EXPOSE list in settings.py.",
+        )
+
+
+CONTEXT_CACHE = {"settings": ExposedSettings(settings_obj=django_settings)}
+
+
+def settings_expose(_):
+    return CONTEXT_CACHE
+
+
+__all__ = [
+    "settings_expose",
+    "SettingsExposeError",
+    "UndefinedSettingError",
+    "UnexposedSettingError",
+]

django_settings_expose-0.1.0/pyproject.toml

@@ -0,0 +1,31 @@
+[project]
+name = "django-settings-expose"
+version = "0.1.0"
+description = "Fast, cached Django settings exporter to templates."
+readme = "README.md"
+requires-python = ">=3.9, <=3.14"
+license = {text = "MIT"}
+authors = [
+    {name = "Vladimir Klimenko", email = "v.klimenko.2137@gmail.com"}
+]
+classifiers = [
+    "Framework :: Django",
+    "Framework :: Django :: 3.2",
+    "Framework :: Django :: 4.2",
+    "Framework :: Django :: 5.2",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "License :: OSI Approved :: MIT License",
+]
+dependencies = [
+    "Django>=3.2,<=5.2",
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"

django_settings_expose-0.1.0/uv.lock

@@ -0,0 +1,72 @@
+version = 1
+revision = 3
+requires-python = ">=3.9, <=3.14"
+resolution-markers = [
+    "python_full_version >= '3.12'",
+    "python_full_version >= '3.10' and python_full_version < '3.12'",
+    "python_full_version < '3.10'",
+]
+
+[[package]]
+name = "asgiref"
+version = "3.11.1"
+source = { registry = "https://pypi.org/simple" }
+dependencies = [
+    { name = "typing-extensions", marker = "python_full_version < '3.11'" },
+]
+sdist = { url = "https://files.pythonhosted.org/packages/63/40/f03da1264ae8f7cfdbf9146542e5e7e8100a4c66ab48e791df9a03d3f6c0/asgiref-3.11.1.tar.gz", hash = "sha256:5f184dc43b7e763efe848065441eac62229c9f7b0475f41f80e207a114eda4ce", size = 38550, upload-time = "2026-02-03T13:30:14.33Z" }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/5c/0a/a72d10ed65068e115044937873362e6e32fab1b7dce0046aeb224682c989/asgiref-3.11.1-py3-none-any.whl", hash = "sha256:e8667a091e69529631969fd45dc268fa79b99c92c5fcdda727757e52146ec133", size = 24345, upload-time = "2026-02-03T13:30:13.039Z" },
+]
+
+[[package]]
+name = "django"
+version = "4.2.30"
+source = { registry = "https://pypi.org/simple" }
+dependencies = [
+    { name = "asgiref" },
+    { name = "sqlparse" },
+    { name = "tzdata", marker = "sys_platform == 'win32'" },
+]
+sdist = { url = "https://files.pythonhosted.org/packages/11/b5/f1a53dc68da6429d6e0345bb848161e2381a2e9f02700148911e8582c2b3/django-4.2.30.tar.gz", hash = "sha256:4ebc7a434e3819db6cf4b399fb5b3f536310a30e8486f08b66886840be84b37c", size = 10468707, upload-time = "2026-04-07T14:05:45.57Z" }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/39/b7/a7c96f239cf91313a6589233fed55111c7063b26683b226802732c455dbc/django-4.2.30-py3-none-any.whl", hash = "sha256:4d07aaf1c62f9984842b67c2874ebbf7056a17be253860299b93ae1881faad65", size = 7997231, upload-time = "2026-04-07T14:05:38.241Z" },
+]
+
+[[package]]
+name = "django-settings-expose"
+version = "0.1.0"
+source = { editable = "." }
+dependencies = [
+    { name = "django" },
+]
+
+[package.metadata]
+requires-dist = [{ name = "django", specifier = ">=3.2,<=5.2" }]
+
+[[package]]
+name = "sqlparse"
+version = "0.5.5"
+source = { registry = "https://pypi.org/simple" }
+sdist = { url = "https://files.pythonhosted.org/packages/90/76/437d71068094df0726366574cf3432a4ed754217b436eb7429415cf2d480/sqlparse-0.5.5.tar.gz", hash = "sha256:e20d4a9b0b8585fdf63b10d30066c7c94c5d7a7ec47c889a2d83a3caa93ff28e", size = 120815, upload-time = "2025-12-19T07:17:45.073Z" }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/49/4b/359f28a903c13438ef59ebeee215fb25da53066db67b305c125f1c6d2a25/sqlparse-0.5.5-py3-none-any.whl", hash = "sha256:12a08b3bf3eec877c519589833aed092e2444e68240a3577e8e26148acc7b1ba", size = 46138, upload-time = "2025-12-19T07:17:46.573Z" },
+]
+
+[[package]]
+name = "typing-extensions"
+version = "4.15.0"
+source = { registry = "https://pypi.org/simple" }
+sdist = { url = "https://files.pythonhosted.org/packages/72/94/1a15dd82efb362ac84269196e94cf00f187f7ed21c242792a923cdb1c61f/typing_extensions-4.15.0.tar.gz", hash = "sha256:0cea48d173cc12fa28ecabc3b837ea3cf6f38c6d1136f85cbaaf598984861466", size = 109391, upload-time = "2025-08-25T13:49:26.313Z" }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/18/67/36e9267722cc04a6b9f15c7f3441c2363321a3ea07da7ae0c0707beb2a9c/typing_extensions-4.15.0-py3-none-any.whl", hash = "sha256:f0fa19c6845758ab08074a0cfa8b7aecb71c999ca73d62883bc25cc018c4e548", size = 44614, upload-time = "2025-08-25T13:49:24.86Z" },
+]
+
+[[package]]
+name = "tzdata"
+version = "2026.2"
+source = { registry = "https://pypi.org/simple" }
+sdist = { url = "https://files.pythonhosted.org/packages/ba/19/1b9b0e29f30c6d35cb345486df41110984ea67ae69dddbc0e8a100999493/tzdata-2026.2.tar.gz", hash = "sha256:9173fde7d80d9018e02a662e168e5a2d04f87c41ea174b139fbef642eda62d10", size = 198254, upload-time = "2026-04-24T15:22:08.651Z" }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/ce/e4/dccd7f47c4b64213ac01ef921a1337ee6e30e8c6466046018326977efd95/tzdata-2026.2-py2.py3-none-any.whl", hash = "sha256:bbe9af844f658da81a5f95019480da3a89415801f6cc966806612cc7169bffe7", size = 349321, upload-time = "2026-04-24T15:22:05.876Z" },
+]