django-boosted 0.1.1__tar.gz

django_boosted-0.1.1/LICENSE

@@ -0,0 +1,23 @@
+MIT License
+
+Copyright (c) 2025 Octolo
+
+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_boosted-0.1.1/PKG-INFO

@@ -0,0 +1,138 @@
+Metadata-Version: 2.4
+Name: django-boosted
+Version: 0.1.1
+Summary: Reusable helpers to register custom Django admin views and object tools.
+Author-email: Octolo <dev@octolo.tech>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/octolo/django-boosted
+Project-URL: Repository, https://github.com/octolo/django-boosted
+Project-URL: Documentation, https://github.com/octolo/django-boosted#readme
+Project-URL: Issues, https://github.com/octolo/django-boosted/issues
+Keywords: django,django-admin,admin-views,admin-tools,django-extensions,admin-customization,python
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 4.2
+Classifier: Framework :: Django :: 5.0
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: Django>=4.2
+Provides-Extra: dev
+Requires-Dist: pytest>=7.4; extra == "dev"
+Requires-Dist: pytest-django>=4.8; extra == "dev"
+Requires-Dist: ruff>=0.7.0; extra == "dev"
+Requires-Dist: black>=24.8; extra == "dev"
+Requires-Dist: bandit>=1.7; extra == "dev"
+Requires-Dist: safety>=3.2; extra == "dev"
+Requires-Dist: pip-audit>=2.7; extra == "dev"
+Dynamic: license-file
+
+# django-boosted
+
+Lightweight helpers to extend Django’s admin with extra views, custom forms, and the matching UI affordances (object tools, permissions, standard responses).
+
+## Features
+
+- **`@admin_boost_object_view` decorator** – fetches the target object, checks permissions, and builds the default context before rendering your template.
+- **`AdminBoostMixin`** – registers the custom URLs, protects them with `admin_site.admin_view`, and injects extra object-tool buttons into the change form.
+- **Additional templates** – a change form template that renders the injected buttons plus a simple “Hello” view as a teaching aid.
+
+## Installation
+
+```bash
+pip install django-boosted
+```
+
+## Quick start
+
+```python
+# app/admin.py
+from django.contrib import admin
+from django_boosted.mixins import AdminBoostMixin
+from django_boosted.decorators import admin_boost_object_view
+from .models import Client
+
+
+class ClientAdmin(AdminBoostMixin, admin.ModelAdmin):
+    boost_views = ["hello_view"]
+    change_form_template = "admin_boost/change_form.html"
+
+    @admin_boost_object_view(label="Say hello", template_name="admin_boost/hello.html")
+    def hello_view(self, request, obj):
+        return {"message": f"Hello {obj}!"}
+
+
+admin.site.register(Client, ClientAdmin)
+```
+
+Include the provided templates in your `TEMPLATES["DIRS"]` (or copy them to customize).
+
+## Using forms with ForeignKey widgets
+
+The decorator can automatically apply admin widgets (`ForeignKeyRawIdWidget` or `AutocompleteSelect`) to your form fields, using the same logic as `ModelAdmin.change_view()`:
+
+```python
+# app/admin.py
+from django import forms
+from django.contrib import admin, messages
+from django.shortcuts import redirect
+from django_boosted.mixins import AdminBoostMixin
+from django_boosted.decorators import admin_boost_object_view
+from .models import Company
+
+class SyncFullGroupForm(forms.Form):
+    group = forms.ModelChoiceField(queryset=Company.objects.all())
+    option = forms.ChoiceField(
+        label="sync method",
+        choices=[("method1", "Method 1"), ("method2", "Method 2")],
+    )
+
+class CompanyAdmin(AdminBoostMixin, admin.ModelAdmin):
+    boost_views = ["sync_full_group_view"]
+    change_form_template = "admin_boost/change_form.html"
+
+    @admin_boost_object_view(
+        label="Sync Full Group",
+        template_name="admin/sync_full_group.html",
+        form=SyncFullGroupForm,
+        raw_id_fields=["group"],  # Automatically applies ForeignKeyRawIdWidget
+    )
+    def sync_full_group_view(self, request, obj, form):
+        if request.method == "POST" and form.is_valid():
+            # Process form...
+            group = form.cleaned_data["group"]
+            option = form.cleaned_data["option"]
+            # ... your logic ...
+            self.message_user(request, "Sync completed", messages.SUCCESS)
+            return redirect(obj.admin_change_url)
+        return {}  # Return additional context if needed
+```
+
+The decorator handles:
+- Widget application (respects `raw_id_fields` and `autocomplete_fields`)
+- Form validation on POST
+- Adding the form to the template context
+- Backward compatibility (if your view doesn't accept a `form` parameter, it won't be passed)
+
+## Development commands
+
+Run everything via `./service.py dev <command>` or `python dev.py <command>`:
+
+| Command | Description |
+| --- | --- |
+| `./service.py dev install-dev` or `python dev.py install-dev` | create the venv and install the package editable with `dev` extras. |
+| `./service.py dev lint` or `python dev.py lint` | run Ruff + Black in check mode. |
+| `./service.py dev format` or `python dev.py format` | apply Ruff --fix then Black. |
+| `./service.py dev test` or `python dev.py test` | run `pytest` (with `pytest-django`). |
+| `./service.py dev build` or `python dev.py build` | clean then build wheel + sdist. |
+| `./service.py quality security` or `python dev.py security` | Bandit + Safety + pip-audit. |
+| `./service.py dev help` or `python dev.py help` | list all commands. |
+
+## License
+
+MIT — see the `LICENSE` file. Contributions welcome!

django_boosted-0.1.1/README.md

@@ -0,0 +1,104 @@
+# django-boosted
+
+Lightweight helpers to extend Django’s admin with extra views, custom forms, and the matching UI affordances (object tools, permissions, standard responses).
+
+## Features
+
+- **`@admin_boost_object_view` decorator** – fetches the target object, checks permissions, and builds the default context before rendering your template.
+- **`AdminBoostMixin`** – registers the custom URLs, protects them with `admin_site.admin_view`, and injects extra object-tool buttons into the change form.
+- **Additional templates** – a change form template that renders the injected buttons plus a simple “Hello” view as a teaching aid.
+
+## Installation
+
+```bash
+pip install django-boosted
+```
+
+## Quick start
+
+```python
+# app/admin.py
+from django.contrib import admin
+from django_boosted.mixins import AdminBoostMixin
+from django_boosted.decorators import admin_boost_object_view
+from .models import Client
+
+
+class ClientAdmin(AdminBoostMixin, admin.ModelAdmin):
+    boost_views = ["hello_view"]
+    change_form_template = "admin_boost/change_form.html"
+
+    @admin_boost_object_view(label="Say hello", template_name="admin_boost/hello.html")
+    def hello_view(self, request, obj):
+        return {"message": f"Hello {obj}!"}
+
+
+admin.site.register(Client, ClientAdmin)
+```
+
+Include the provided templates in your `TEMPLATES["DIRS"]` (or copy them to customize).
+
+## Using forms with ForeignKey widgets
+
+The decorator can automatically apply admin widgets (`ForeignKeyRawIdWidget` or `AutocompleteSelect`) to your form fields, using the same logic as `ModelAdmin.change_view()`:
+
+```python
+# app/admin.py
+from django import forms
+from django.contrib import admin, messages
+from django.shortcuts import redirect
+from django_boosted.mixins import AdminBoostMixin
+from django_boosted.decorators import admin_boost_object_view
+from .models import Company
+
+class SyncFullGroupForm(forms.Form):
+    group = forms.ModelChoiceField(queryset=Company.objects.all())
+    option = forms.ChoiceField(
+        label="sync method",
+        choices=[("method1", "Method 1"), ("method2", "Method 2")],
+    )
+
+class CompanyAdmin(AdminBoostMixin, admin.ModelAdmin):
+    boost_views = ["sync_full_group_view"]
+    change_form_template = "admin_boost/change_form.html"
+
+    @admin_boost_object_view(
+        label="Sync Full Group",
+        template_name="admin/sync_full_group.html",
+        form=SyncFullGroupForm,
+        raw_id_fields=["group"],  # Automatically applies ForeignKeyRawIdWidget
+    )
+    def sync_full_group_view(self, request, obj, form):
+        if request.method == "POST" and form.is_valid():
+            # Process form...
+            group = form.cleaned_data["group"]
+            option = form.cleaned_data["option"]
+            # ... your logic ...
+            self.message_user(request, "Sync completed", messages.SUCCESS)
+            return redirect(obj.admin_change_url)
+        return {}  # Return additional context if needed
+```
+
+The decorator handles:
+- Widget application (respects `raw_id_fields` and `autocomplete_fields`)
+- Form validation on POST
+- Adding the form to the template context
+- Backward compatibility (if your view doesn't accept a `form` parameter, it won't be passed)
+
+## Development commands
+
+Run everything via `./service.py dev <command>` or `python dev.py <command>`:
+
+| Command | Description |
+| --- | --- |
+| `./service.py dev install-dev` or `python dev.py install-dev` | create the venv and install the package editable with `dev` extras. |
+| `./service.py dev lint` or `python dev.py lint` | run Ruff + Black in check mode. |
+| `./service.py dev format` or `python dev.py format` | apply Ruff --fix then Black. |
+| `./service.py dev test` or `python dev.py test` | run `pytest` (with `pytest-django`). |
+| `./service.py dev build` or `python dev.py build` | clean then build wheel + sdist. |
+| `./service.py quality security` or `python dev.py security` | Bandit + Safety + pip-audit. |
+| `./service.py dev help` or `python dev.py help` | list all commands. |
+
+## License
+
+MIT — see the `LICENSE` file. Contributions welcome!

django_boosted-0.1.1/pyproject.toml

@@ -0,0 +1,83 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "django-boosted"
+version = "0.1.1"
+description = "Reusable helpers to register custom Django admin views and object tools."
+readme = "README.md"
+requires-python = ">=3.10"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [
+  {name = "Octolo", email = "dev@octolo.tech"}
+]
+keywords = [
+  "django",
+  "django-admin",
+  "admin-views",
+  "admin-tools",
+  "django-extensions",
+  "admin-customization",
+  "python",
+]
+dependencies = [
+  "Django>=4.2",
+]
+classifiers = [
+  "Framework :: Django",
+  "Framework :: Django :: 4.2",
+  "Framework :: Django :: 5.0",
+  "Intended Audience :: Developers",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3 :: Only",
+  "Topic :: Software Development :: Libraries :: Application Frameworks",
+]
+
+[project.urls]
+Homepage = "https://github.com/octolo/django-boosted"
+Repository = "https://github.com/octolo/django-boosted"
+Documentation = "https://github.com/octolo/django-boosted#readme"
+Issues = "https://github.com/octolo/django-boosted/issues"
+
+[project.optional-dependencies]
+dev = [
+  "pytest>=7.4",
+  "pytest-django>=4.8",
+  "ruff>=0.7.0",
+  "black>=24.8",
+  "bandit>=1.7",
+  "safety>=3.2",
+  "pip-audit>=2.7",
+]
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+django_boosted = ["templates/**/*", "static/**/*"]
+
+[tool.pytest.ini_options]
+DJANGO_SETTINGS_MODULE = "tests.settings"
+pythonpath = ["src", "."]
+addopts = "-ra"
+
+[tool.black]
+line-length = 88
+target-version = ["py311"]
+
+[tool.ruff]
+line-length = 88
+target-version = "py311"
+extend-exclude = ["**/migrations/*"]
+
+[tool.ruff.lint]
+select = ["E", "F", "I"]
+
+

django_boosted-0.1.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

django_boosted-0.1.1/src/django_boosted/__init__.py

@@ -0,0 +1,20 @@
+"""Public exports for django-boosted."""
+default_app_config = "django_boosted.apps.DjangoBoostedConfig"  # noqa: E402
+
+from .admin import AdminBoostModel, AdminBoostFormat  # noqa: E402
+from .decorators import admin_boost_action, admin_boost_view  # noqa: E402
+
+__all__ = [
+    "AdminBoostModel",
+    "AdminBoostFormat",
+    "admin_boost_action",
+    "admin_boost_view",
+]
+
+try:
+    from django_boosted.rest_framework.metadata import BoostedRestFrameworkMetadata
+    __all__.append("BoostedRestFrameworkMetadata")
+except ImportError:
+    pass  # rest_framework not installed
+
+__version__ = "0.1.0"

django_boosted-0.1.1/src/django_boosted/admin/__init__.py

@@ -0,0 +1,5 @@
+"""Admin module for django-boosted."""
+
+from .model import AdminBoostModel, AdminBoostFormat
+
+__all__ = ["AdminBoostModel", "AdminBoostFormat"]

django_boosted-0.1.1/src/django_boosted/admin/fieldsets.py

@@ -0,0 +1,44 @@
+from typing import Iterable
+
+
+def add_to_fieldset(self, name: str, fields: Iterable[str], **kwargs):
+    """Add fields to a fieldset by name. Create the fieldset if it doesn't exist."""
+    if self.fieldsets is None:
+        self.fieldsets = []
+
+    fieldset_dict = None
+
+    for fieldset in self.fieldsets:
+        if fieldset[0] == name:
+            fieldset_dict = fieldset[1]
+            break
+
+    if fieldset_dict is None:
+        fieldset_dict = {"fields": [],}
+        self.fieldsets.append((name, fieldset_dict))
+    else:
+        if "fields" not in fieldset_dict:
+            fieldset_dict["fields"] = []
+        elif isinstance(fieldset_dict["fields"], tuple):
+            fieldset_dict["fields"] = list(fieldset_dict["fields"])
+
+    for field in fields:
+        if field not in fieldset_dict["fields"]:
+            fieldset_dict["fields"].append(field)
+
+    if kwargs.get("classes"):
+        fieldset_dict["classes"] = kwargs.get("classes")
+
+def remove_from_fieldset(self, name: str, fields: Iterable[str]):
+    """Remove fields from a fieldset by name."""
+    if self.fieldsets is None:
+        return
+
+    for fieldset in self.fieldsets:
+        if fieldset[0] == name:
+            fieldset_dict = fieldset[1]
+            if "fields" in fieldset_dict:
+                for field in fields:
+                    if field in fieldset_dict["fields"]:
+                        fieldset_dict["fields"].remove(field)
+            break

django_boosted-0.1.1/src/django_boosted/admin/format.py

@@ -0,0 +1,90 @@
+"""Formatting utilities for django-boosted."""
+
+from django.utils.html import format_html
+from django.templatetags.static import static
+from django.utils.translation import gettext_lazy as _
+
+def boolean_icon_html(value):
+    """Return the HTML image (admin icon) for a boolean value."""
+    is_ok = value == "✓" if isinstance(value, str) else bool(value)
+    icon = "icon-yes.svg" if is_ok else "icon-no.svg"
+    return format_html(
+        '<img src="{}" alt="{}">',
+        static(f"admin/img/{icon}"),
+        _("Yes") if is_ok else _("No"),
+    )
+
+
+def format_label(
+    text: str,
+    label_type: str = "info",
+    size: str | None = None,
+    link: str | None = None,
+    style: str | None = None,
+) -> str:
+    classes = ["boost-label"]
+    valid_types = [
+        "success",
+        "info",
+        "warning",
+        "danger",
+        "primary",
+        "secondary",
+        "default",
+    ]
+    if label_type.lower() in valid_types:
+        classes.append(label_type.lower())
+    else:
+        classes.append("info")
+    if size and size.lower() in ["small", "big"]:
+        classes.append(size.lower())
+    if link:
+        classes.append("link")
+    css_class = " ".join(classes)
+    tag = "a" if link else "span"
+    if link and style:
+        return format_html(
+            '<{} href="{}" class="{}" style="{}">{}</{}>',
+            tag,
+            link,
+            css_class,
+            style,
+            text,
+            tag,
+        )
+    if link:
+        return format_html(
+            '<{} href="{}" class="{}">{}</{}>', tag, link, css_class, text, tag
+        )
+    if style:
+        return format_html(
+            '<{} class="{}" style="{}">{}</{}>', tag, css_class, style, text, tag
+        )
+    return format_html('<{} class="{}">{}</{}>', tag, css_class, text, tag)
+
+
+def format_status(
+    name: str, status: bool, style: str | None = None, link: str | None = None
+) -> str:
+    icon = "✓" if status else "✗"
+    status_class = "success" if status else "error"
+    tag = "a" if link else "span"
+    return format_html(
+        '<{} href="{}"><span class="boost-status {}" style="{}">{}</span> '
+        '<code>{}</code></{}>',
+        tag,
+        link,
+        status_class,
+        style,
+        icon,
+        name,
+        tag,
+    )
+
+
+def format_with_help_text(html_content: str, help_text: str | None = None) -> str:
+    if help_text:
+        return format_html(
+            '{}<br><small class="help">{}</small>', html_content, help_text
+        )
+    return html_content