django-admin-confirm 0.1__tar.gz

django-admin-confirm-0.1/MANIFEST.in

@@ -0,0 +1,2 @@
+include *.rst
+recursive-include admin-confirm/*

django-admin-confirm-0.1/PKG-INFO

@@ -0,0 +1,94 @@
+Metadata-Version: 2.1
+Name: django-admin-confirm
+Version: 0.1
+Summary: Adds confirmation to Django Admin changes and additions
+Home-page: https://github.com/trangpham/django-admin-confirm/
+Author: Thu Trang Pham
+Author-email: thuutrangpham@gmail.com
+License: Apache 2.0
+Description: # Django Admin Confirm
+        
+        ![coverage](https://raw.githubusercontent.com/TrangPham/django-admin-confirm/main/coverage.svg)
+        
+        AdminConfirmMixin is a mixin for ModelAdmin to add confirmations to changes and additions.
+        
+        ![Screenshot of Confirmation Page](https://raw.githubusercontent.com/TrangPham/django-admin-confirm/main/screenshot.png)
+        
+        It can be configured to add a confirmation page upon saving changes and/or additions on ModelAdmin.
+        
+        Typical Usage:
+        
+        ```py
+            from admin_confirm import AdminConfirmMixin
+        
+            class MyModelAdmin(AdminConfirmMixin, ModelAdmin):
+                confirm_change = True
+                confirmation_fields = ['field1', 'field2']
+        ```
+        
+        ## Installation
+        
+        Install django-admin-confirm by running:
+        
+            pip install django-admin-confirm
+        
+        Add to INSTALLED_APPS in your project settings before `django.contrib.admin`:
+        
+            INSTALLED_APPS = [
+                ...
+                'admin_confirm',
+        
+                'django.contrib.admin',
+                ...
+            ]
+        
+        Note that this project follows the template override rules of Django.
+        To override a template, your app should be listed before `admin_confirm` in INSTALLED_APPS.
+        
+        ## Configuration Options
+        
+        - `confirm_change` _Optional[bool]_ - decides if changes should trigger confirmation
+        - `confirm_add` _Optional[bool]_ - decides if additions should trigger confirmation
+        - `confirmation_fields` _Optional[Array[string]]_ - sets which fields changes should trigger confirmation
+        - `change_confirmation_template` _Optional[string]_ - path to custom html template to use
+        
+        Note that setting `confirmation_fields` without setting `confirm_change` or `confirm_add` would not trigger confirmation.
+        
+        ## Contribution & Appreciation
+        
+        Contributions are most welcome :) Feel free to:
+        
+        - address an issue
+        - raise an issue
+        - add more test cases
+        - add feature requests
+        
+        Your appreciation is also very welcome :) Feel free to:
+        
+        - star the project
+        - open an issue just to share your thanks
+        
+        ## Feature List
+        
+        This is a list of features which could potentially be added in the future. Some of which might make more sense in their own package.
+        
+        - [ ] confirmations on changelist actions
+        - [ ] global actions on changelist page
+        - [ ] instance actions on change/view page
+        - [ ] action logs (adding actions to history of instances)
+        - [ ] add help tooltip/popover to any field for more info
+        - [ ] run scripts from admin
+        - [ ] completed action summary page
+        - [ ] add top and bottom areas to instance pages which can be configured for any content
+        
+        ## Support
+        
+        If you are having issues, please let us know through raising an issue.
+        
+        ## License
+        
+        The project is licensed under the Apache 2.0 license.
+        
+Platform: UNKNOWN
+Requires-Python: >=3
+Description-Content-Type: text/markdown

django-admin-confirm-0.1/README.md

@@ -0,0 +1,82 @@
+# Django Admin Confirm
+
+![coverage](https://raw.githubusercontent.com/TrangPham/django-admin-confirm/main/coverage.svg)
+
+AdminConfirmMixin is a mixin for ModelAdmin to add confirmations to changes and additions.
+
+![Screenshot of Confirmation Page](https://raw.githubusercontent.com/TrangPham/django-admin-confirm/main/screenshot.png)
+
+It can be configured to add a confirmation page upon saving changes and/or additions on ModelAdmin.
+
+Typical Usage:
+
+```py
+    from admin_confirm import AdminConfirmMixin
+
+    class MyModelAdmin(AdminConfirmMixin, ModelAdmin):
+        confirm_change = True
+        confirmation_fields = ['field1', 'field2']
+```
+
+## Installation
+
+Install django-admin-confirm by running:
+
+    pip install django-admin-confirm
+
+Add to INSTALLED_APPS in your project settings before `django.contrib.admin`:
+
+    INSTALLED_APPS = [
+        ...
+        'admin_confirm',
+
+        'django.contrib.admin',
+        ...
+    ]
+
+Note that this project follows the template override rules of Django.
+To override a template, your app should be listed before `admin_confirm` in INSTALLED_APPS.
+
+## Configuration Options
+
+- `confirm_change` _Optional[bool]_ - decides if changes should trigger confirmation
+- `confirm_add` _Optional[bool]_ - decides if additions should trigger confirmation
+- `confirmation_fields` _Optional[Array[string]]_ - sets which fields changes should trigger confirmation
+- `change_confirmation_template` _Optional[string]_ - path to custom html template to use
+
+Note that setting `confirmation_fields` without setting `confirm_change` or `confirm_add` would not trigger confirmation.
+
+## Contribution & Appreciation
+
+Contributions are most welcome :) Feel free to:
+
+- address an issue
+- raise an issue
+- add more test cases
+- add feature requests
+
+Your appreciation is also very welcome :) Feel free to:
+
+- star the project
+- open an issue just to share your thanks
+
+## Feature List
+
+This is a list of features which could potentially be added in the future. Some of which might make more sense in their own package.
+
+- [ ] confirmations on changelist actions
+- [ ] global actions on changelist page
+- [ ] instance actions on change/view page
+- [ ] action logs (adding actions to history of instances)
+- [ ] add help tooltip/popover to any field for more info
+- [ ] run scripts from admin
+- [ ] completed action summary page
+- [ ] add top and bottom areas to instance pages which can be configured for any content
+
+## Support
+
+If you are having issues, please let us know through raising an issue.
+
+## License
+
+The project is licensed under the Apache 2.0 license.

django-admin-confirm-0.1/admin_confirm/__init__.py

@@ -0,0 +1 @@
+from .admin import AdminConfirmMixin

django-admin-confirm-0.1/admin_confirm/admin.py

@@ -0,0 +1,170 @@
+from django.contrib.admin.exceptions import DisallowedModelAdminToField
+from django.contrib.admin.utils import flatten_fieldsets, unquote
+from django.core.exceptions import PermissionDenied
+from django.template.response import TemplateResponse
+from django.contrib.admin.options import TO_FIELD_VAR
+from django.utils.translation import gettext as _
+
+
+class AdminConfirmMixin:
+    # Should we ask for confirmation for changes?
+    confirm_change = None
+
+    # Should we ask for confirmation for additions?
+    confirm_add = None
+
+    # If asking for confirmation, which fields should we confirm for?
+    confirmation_fields = None
+
+    # Custom templates (designed to be over-ridden in subclasses)
+    confirmation_template = None
+
+    def get_confirmation_fields(self, request, obj=None):
+        """
+        Hook for specifying confirmation fields
+        """
+        if self.confirmation_fields is not None:
+            return self.confirmation_fields
+
+        return flatten_fieldsets(self.get_fieldsets(request, obj))
+
+    def render_change_confirmation(self, request, context):
+        opts = self.model._meta
+        app_label = opts.app_label
+
+        request.current_app = self.admin_site.name
+        context.update(
+            media=self.media,
+        )
+
+        return TemplateResponse(
+            request,
+            self.confirmation_template
+            or [
+                "admin/{}/{}/change_confirmation.html".format(
+                    app_label, opts.model_name
+                ),
+                "admin/{}/change_confirmation.html".format(app_label),
+                "admin/change_confirmation.html",
+            ],
+            context,
+        )
+
+    def changeform_view(self, request, object_id=None, form_url="", extra_context=None):
+        if request.method == "POST":
+            if (not object_id and "_confirm_add" in request.POST) or (
+                object_id and "_confirm_change" in request.POST
+            ):
+                return self._change_confirmation_view(
+                    request, object_id, form_url, extra_context
+                )
+
+        extra_context = {
+            **(extra_context or {}),
+            "confirm_add": self.confirm_add,
+            "confirm_change": self.confirm_change,
+        }
+        return super().changeform_view(request, object_id, form_url, extra_context)
+
+    def _change_confirmation_view(self, request, object_id, form_url, extra_context):
+        # This code is taken from super()._changeform_view
+        to_field = request.POST.get(TO_FIELD_VAR, request.GET.get(TO_FIELD_VAR))
+        if to_field and not self.to_field_allowed(request, to_field):
+            raise DisallowedModelAdminToField(
+                "The field %s cannot be referenced." % to_field
+            )
+
+        model = self.model
+        opts = model._meta
+
+        add = object_id is None
+        if add:
+            if not self.has_add_permission(request):
+                raise PermissionDenied
+
+            obj = None
+        else:
+            obj = self.get_object(request, unquote(object_id), to_field)
+            if obj is None:
+                return self._get_obj_does_not_exist_redirect(request, opts, object_id)
+
+            if not self.has_view_or_change_permission(request, obj):
+                raise PermissionDenied
+
+        fieldsets = self.get_fieldsets(request, obj)
+        ModelForm = self.get_form(
+            request, obj, change=not add, fields=flatten_fieldsets(fieldsets)
+        )
+
+        form = ModelForm(request.POST, request.FILES, obj)
+        form_validated = form.is_valid()
+        if form_validated:
+            new_object = self.save_form(request, form, change=not add)
+        else:
+            new_object = form.instance
+
+        # End code from super()._changeform_view
+
+        changed_data = {}
+        if form_validated:
+            if add:
+                for name in form.changed_data:
+                    new_value = getattr(new_object, name)
+                    # Don't consider default values as changed for adding
+                    if (
+                        new_value is not None
+                        and new_value != model._meta.get_field(name).default
+                    ):
+                        changed_data[name] = [None, new_value]
+            else:
+                # Parse the changed data - Note that using form.changed_data would not work because initial is not set
+                for name, field in form.fields.items():
+                    initial_value = getattr(obj, name)
+                    new_value = getattr(new_object, name)
+                    if (
+                        field.has_changed(initial_value, new_value)
+                        and initial_value != new_value
+                    ):
+                        changed_data[name] = [initial_value, new_value]
+
+        changed_confirmation_fields = set(
+            self.get_confirmation_fields(request, obj)
+        ) & set(changed_data.keys())
+        if not bool(changed_confirmation_fields):
+            # No confirmation required for changed fields, continue to save
+            return super()._changeform_view(request, object_id, form_url, extra_context)
+
+        # Parse raw form data from POST
+        form_data = {}
+        # Parse the original save action from request
+        save_action = None
+        for key in request.POST:
+            if key in ["_save", "_saveasnew", "_addanother", "_continue"]:
+                save_action = key
+
+            if key.startswith("_") or key == "csrfmiddlewaretoken":
+                continue
+            form_data[key] = request.POST.get(key)
+
+        if add:
+            title_action = _("adding")
+        else:
+            title_action = _("changing")
+
+        context = {
+            **self.admin_site.each_context(request),
+            "preserved_filters": self.get_preserved_filters(request),
+            "title": f"{_('Confirm')} {title_action} {opts.verbose_name}",
+            "subtitle": str(obj),
+            "object_name": str(obj),
+            "object_id": object_id,
+            "app_label": opts.app_label,
+            "model_name": opts.model_name,
+            "opts": opts,
+            "form_data": form_data,
+            "changed_data": changed_data,
+            "add": add,
+            "submit_name": save_action,
+            **(extra_context or {}),
+        }
+        return self.render_change_confirmation(request, context)

django-admin-confirm-0.1/django_admin_confirm.egg-info/PKG-INFO

@@ -0,0 +1,94 @@
+Metadata-Version: 2.1
+Name: django-admin-confirm
+Version: 0.1
+Summary: Adds confirmation to Django Admin changes and additions
+Home-page: https://github.com/trangpham/django-admin-confirm/
+Author: Thu Trang Pham
+Author-email: thuutrangpham@gmail.com
+License: Apache 2.0
+Description: # Django Admin Confirm
+        
+        ![coverage](https://raw.githubusercontent.com/TrangPham/django-admin-confirm/main/coverage.svg)
+        
+        AdminConfirmMixin is a mixin for ModelAdmin to add confirmations to changes and additions.
+        
+        ![Screenshot of Confirmation Page](https://raw.githubusercontent.com/TrangPham/django-admin-confirm/main/screenshot.png)
+        
+        It can be configured to add a confirmation page upon saving changes and/or additions on ModelAdmin.
+        
+        Typical Usage:
+        
+        ```py
+            from admin_confirm import AdminConfirmMixin
+        
+            class MyModelAdmin(AdminConfirmMixin, ModelAdmin):
+                confirm_change = True
+                confirmation_fields = ['field1', 'field2']
+        ```
+        
+        ## Installation
+        
+        Install django-admin-confirm by running:
+        
+            pip install django-admin-confirm
+        
+        Add to INSTALLED_APPS in your project settings before `django.contrib.admin`:
+        
+            INSTALLED_APPS = [
+                ...
+                'admin_confirm',
+        
+                'django.contrib.admin',
+                ...
+            ]
+        
+        Note that this project follows the template override rules of Django.
+        To override a template, your app should be listed before `admin_confirm` in INSTALLED_APPS.
+        
+        ## Configuration Options
+        
+        - `confirm_change` _Optional[bool]_ - decides if changes should trigger confirmation
+        - `confirm_add` _Optional[bool]_ - decides if additions should trigger confirmation
+        - `confirmation_fields` _Optional[Array[string]]_ - sets which fields changes should trigger confirmation
+        - `change_confirmation_template` _Optional[string]_ - path to custom html template to use
+        
+        Note that setting `confirmation_fields` without setting `confirm_change` or `confirm_add` would not trigger confirmation.
+        
+        ## Contribution & Appreciation
+        
+        Contributions are most welcome :) Feel free to:
+        
+        - address an issue
+        - raise an issue
+        - add more test cases
+        - add feature requests
+        
+        Your appreciation is also very welcome :) Feel free to:
+        
+        - star the project
+        - open an issue just to share your thanks
+        
+        ## Feature List
+        
+        This is a list of features which could potentially be added in the future. Some of which might make more sense in their own package.
+        
+        - [ ] confirmations on changelist actions
+        - [ ] global actions on changelist page
+        - [ ] instance actions on change/view page
+        - [ ] action logs (adding actions to history of instances)
+        - [ ] add help tooltip/popover to any field for more info
+        - [ ] run scripts from admin
+        - [ ] completed action summary page
+        - [ ] add top and bottom areas to instance pages which can be configured for any content
+        
+        ## Support
+        
+        If you are having issues, please let us know through raising an issue.
+        
+        ## License
+        
+        The project is licensed under the Apache 2.0 license.
+        
+Platform: UNKNOWN
+Requires-Python: >=3
+Description-Content-Type: text/markdown

django-admin-confirm-0.1/django_admin_confirm.egg-info/SOURCES.txt

@@ -0,0 +1,10 @@
+MANIFEST.in
+README.md
+setup.py
+admin_confirm/__init__.py
+admin_confirm/admin.py
+django_admin_confirm.egg-info/PKG-INFO
+django_admin_confirm.egg-info/SOURCES.txt
+django_admin_confirm.egg-info/dependency_links.txt
+django_admin_confirm.egg-info/requires.txt
+django_admin_confirm.egg-info/top_level.txt

django-admin-confirm-0.1/django_admin_confirm.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

django-admin-confirm-0.1/django_admin_confirm.egg-info/requires.txt

@@ -0,0 +1 @@
+Django>=1.7

django-admin-confirm-0.1/django_admin_confirm.egg-info/top_level.txt

@@ -0,0 +1 @@
+admin_confirm

django-admin-confirm-0.1/setup.cfg

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

django-admin-confirm-0.1/setup.py

@@ -0,0 +1,22 @@
+import os
+from setuptools import setup
+
+here = os.path.abspath(os.path.dirname(__file__))
+README = open(os.path.join(here, "README.md")).read()
+
+setup(
+    name="django-admin-confirm",
+    version="0.1",
+    packages=["admin_confirm"],
+    description="Adds confirmation to Django Admin changes and additions",
+    long_description_content_type="text/markdown",
+    long_description=README,
+    author="Thu Trang Pham",
+    author_email="thuutrangpham@gmail.com",
+    url="https://github.com/trangpham/django-admin-confirm/",
+    license="Apache 2.0",
+    install_requires=[
+        "Django>=1.7",
+    ],
+    python_requires='>=3',
+)