django-admin-helpers 0.1.0__py3-none-any.whl

django_admin_helpers/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.1.0"

django_admin_helpers/apps.py

@@ -0,0 +1,9 @@
+from django.apps import AppConfig
+from django.utils.translation import gettext_lazy as _
+
+
+class AdminHelpersAppConfig(AppConfig):
+    """App config for Django Admin Helpers."""
+
+    name = "django_admin_helpers"
+    verbose_name = _("admin helpers")

django_admin_helpers/conf.py

@@ -0,0 +1,40 @@
+"""
+These are the available settings.
+
+All attributes prefixed ``ADMIN_HELPERS_*`` can be overridden from your Django
+project's settings module by defining a setting with the same name.
+"""
+
+from __future__ import annotations
+
+from dataclasses import dataclass
+from typing import Any
+
+from django.conf import settings as django_settings
+
+# All attributes accessed with this prefix are possible to overwrite
+# through django.conf.settings.
+SETTINGS_PREFIX = "ADMIN_HELPERS_"
+
+
+@dataclass(frozen=True)
+class AppSettings:
+    """Access this instance as `.conf.app_settings`."""
+
+    ADMIN_HELPERS_ENABLED: bool = True
+    """Whether the app is enabled (dummy setting to demo usage)."""
+
+    def __getattribute__(self, __name: str) -> Any:
+        """
+        Check if a Django project settings should override the app default.
+
+        In order to avoid returning any random properties of the django settings,
+        we inspect the prefix firstly.
+        """
+        if __name.startswith(SETTINGS_PREFIX) and hasattr(django_settings, __name):
+            return getattr(django_settings, __name)
+
+        return super().__getattribute__(__name)
+
+
+app_settings = AppSettings()

django_admin_helpers/main.py

@@ -0,0 +1,11 @@
+from .conf import app_settings
+
+
+def add(n1: int, n2: int) -> int:
+    """Add the arguments."""
+    return n1 + n2
+
+
+def is_enabled() -> bool:
+    """Example usage of app settings."""
+    return app_settings.ADMIN_HELPERS_ENABLED

django_admin_helpers-0.1.0.dist-info/LICENSE

@@ -0,0 +1,22 @@
+
+MIT License
+
+Copyright (c) 2024 Bruno Alla
+
+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.

django_admin_helpers-0.1.0.dist-info/METADATA

@@ -0,0 +1,122 @@
+Metadata-Version: 2.1
+Name: django-admin-helpers
+Version: 0.1.0
+Summary: A collections of helpers for the Django admin.
+Home-page: https://github.com/browniebroke/django-admin-helpers
+License: MIT
+Author: Bruno Alla
+Author-email: oss@browniebroke.com
+Requires-Python: >=3.8,<4.0
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 3.2
+Classifier: Framework :: Django :: 4.0
+Classifier: Framework :: Django :: 4.1
+Classifier: Framework :: Django :: 4.2
+Classifier: Framework :: Django :: 5.0
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+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: Topic :: Software Development :: Libraries
+Requires-Dist: django (>=3.2)
+Project-URL: Bug Tracker, https://github.com/browniebroke/django-admin-helpers/issues
+Project-URL: Changelog, https://github.com/browniebroke/django-admin-helpers/blob/main/CHANGELOG.md
+Project-URL: Documentation, https://django-admin-helpers.readthedocs.io
+Project-URL: Repository, https://github.com/browniebroke/django-admin-helpers
+Description-Content-Type: text/markdown
+
+# Django Admin Helpers
+
+<p align="center">
+  <a href="https://github.com/browniebroke/django-admin-helpers/actions/workflows/ci.yml?query=branch%3Amain">
+    <img src="https://img.shields.io/github/actions/workflow/status/browniebroke/django-admin-helpers/ci.yml?branch=main&label=CI&logo=github&style=flat-square" alt="CI Status" >
+  </a>
+  <a href="https://django-admin-helpers.readthedocs.io">
+    <img src="https://img.shields.io/readthedocs/django-admin-helpers.svg?logo=read-the-docs&logoColor=fff&style=flat-square" alt="Documentation Status">
+  </a>
+  <a href="https://codecov.io/gh/browniebroke/django-admin-helpers">
+    <img src="https://img.shields.io/codecov/c/github/browniebroke/django-admin-helpers.svg?logo=codecov&logoColor=fff&style=flat-square" alt="Test coverage percentage">
+  </a>
+</p>
+<p align="center">
+  <a href="https://python-poetry.org/">
+    <img src="https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json" alt="Poetry">
+  </a>
+  <a href="https://github.com/astral-sh/ruff">
+    <img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json" alt="Ruff">
+  </a>
+  <a href="https://github.com/pre-commit/pre-commit">
+    <img src="https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white&style=flat-square" alt="pre-commit">
+  </a>
+</p>
+<p align="center">
+  <a href="https://pypi.org/project/django-admin-helpers/">
+    <img src="https://img.shields.io/pypi/v/django-admin-helpers.svg?logo=python&logoColor=fff&style=flat-square" alt="PyPI Version">
+  </a>
+  <img src="https://img.shields.io/pypi/pyversions/django-admin-helpers.svg?style=flat-square&logo=python&amp;logoColor=fff" alt="Supported Python versions">
+  <img src="https://img.shields.io/pypi/l/django-admin-helpers.svg?style=flat-square" alt="License">
+</p>
+
+---
+
+**Documentation**: <a href="https://django-admin-helpers.readthedocs.io" target="_blank">https://django-admin-helpers.readthedocs.io </a>
+
+**Source Code**: <a href="https://github.com/browniebroke/django-admin-helpers" target="_blank">https://github.com/browniebroke/django-admin-helpers </a>
+
+---
+
+A collections of helpers for the Django admin.
+
+## Installation
+
+Install this via pip (or your favourite package manager):
+
+`pip install django-admin-helpers`
+
+Add the app to your `INSTALLED_APPS`:
+
+```python
+INSTALLED_APPS = [
+    # ...
+    "django_admin_helpers",
+]
+```
+
+## Contributors ✨
+
+Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
+
+<!-- prettier-ignore-start -->
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<table>
+  <tbody>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://browniebroke.com/"><img src="https://avatars.githubusercontent.com/u/861044?v=4?s=80" width="80px;" alt="Bruno Alla"/><br /><sub><b>Bruno Alla</b></sub></a><br /><a href="https://github.com/browniebroke/django-admin-helpers/commits?author=browniebroke" title="Code">💻</a> <a href="#ideas-browniebroke" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/browniebroke/django-admin-helpers/commits?author=browniebroke" title="Documentation">📖</a></td>
+    </tr>
+  </tbody>
+</table>
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+<!-- prettier-ignore-end -->
+
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
+
+## Credits
+
+This package was created with
+[Copier](https://copier.readthedocs.io/) and the
+[browniebroke/pypackage-template](https://github.com/browniebroke/pypackage-template)
+project template.
+

django_admin_helpers-0.1.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+django_admin_helpers/__init__.py,sha256=kUR5RAFc7HCeiqdlX36dZOHkUI5wI6V_43RpEcD8b-0,22
+django_admin_helpers/apps.py,sha256=mkkV76IimInl_WQzEVauUMroWH5NxlS88OCkbzFVxu8,251
+django_admin_helpers/conf.py,sha256=T598wzsafvnmFrkOcKk0uBGAmQR7Vo62iRSRiK1iZ0A,1174
+django_admin_helpers/main.py,sha256=LBa65yxZvpOl6ixy5kmlcCkeyg8tEm76E-Sq0rgojQ0,230
+django_admin_helpers/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+django_admin_helpers-0.1.0.dist-info/LICENSE,sha256=ji4Rf9Jc6RASNBAcebQKpyCbnx0s6ESGoI3WktUE-Hg,1068
+django_admin_helpers-0.1.0.dist-info/METADATA,sha256=2shn33LPXszyGqOwumMlMKg0rON_0iCp-ewBcyPCQaI,5308
+django_admin_helpers-0.1.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+django_admin_helpers-0.1.0.dist-info/RECORD,,

django_admin_helpers-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 1.9.0
+Root-Is-Purelib: true
+Tag: py3-none-any