Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/trangpham/django-admin-confirm
AdminConfirmMixin is a mixin for ModelAdmin that adds confirmations to changes, additions and actions.
https://github.com/trangpham/django-admin-confirm
django-admin
Last synced: 3 months ago
JSON representation
AdminConfirmMixin is a mixin for ModelAdmin that adds confirmations to changes, additions and actions.
- Host: GitHub
- URL: https://github.com/trangpham/django-admin-confirm
- Owner: TrangPham
- License: other
- Created: 2020-11-08T18:56:53.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-02T14:14:44.000Z (3 months ago)
- Last Synced: 2024-04-05T22:07:26.878Z (3 months ago)
- Topics: django-admin
- Language: Python
- Homepage:
- Size: 5.59 MB
- Stars: 121
- Watchers: 4
- Forks: 14
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Lists
- awesome-django-admin - django-admin-confirm - Adds confirmations to changes, additions and actions (Packages to install at your project / Actions)
README
# Django Admin Confirm
[](https://pypi.org/project/django-admin-confirm/)  [](https://coveralls.io/github/TrangPham/django-admin-confirm)
 
 
AdminConfirmMixin is a mixin for ModelAdmin to add confirmations to change, add and actions.
It can be configured to add a confirmation page on ModelAdmin upon:
- saving changes
- adding new instances
- performing actions
Typical Usage:
```py
from admin_confirm import AdminConfirmMixin
class MyModelAdmin(AdminConfirmMixin, ModelAdmin):
confirm_change = True
confirmation_fields = ['field1', 'field2']
```
## Disclaimer
Be aware that not all possible combinations of ModelAdmin have been tested, even if test coverage is high.
See [testing readme](docs/testing_notes.md) for more details
## 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
**Environment Variables**:
Caching is used to cache files for confirmation. When change/add is submitted on the ModelAdmin, if confirmation is required, files will be cached until all validations pass and confirmation is received.
- `ADMIN_CONFIRM_CACHE_TIMEOUT` _default: 1000_
- `ADMIN_CONFIRM_CACHE_KEY_PREFIX` _default: admin_confirm\_\_file_cache_
**Attributes:**
- `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 should trigger confirmation for add/change. For adding new instances, the field would only trigger a confirmation if it's set to a value that's not its default.
- `change_confirmation_template` _Optional[string]_ - path to custom html template to use for change/add
- `action_confirmation_template` _Optional[string]_ - path to custom html template to use for actions
Note that setting `confirmation_fields` without setting `confirm_change` or `confirm_add` would not trigger confirmation for change/add. Confirmations for actions does not use the `confirmation_fields` option.
**Method Overrides:**
If you want even more control over the confirmation, these methods can be overridden:
- `get_confirmation_fields(self, request: HttpRequest, obj: Optional[Object]) -> List[str]`
- `render_change_confirmation(self, request: HttpRequest, context: dict) -> TemplateResponse`
- `render_action_confirmation(self, request: HttpRequest, context: dict) -> TemplateResponse`
## Usage
**Confirm Change:**
```py
from admin_confirm import AdminConfirmMixin
class MyModelAdmin(AdminConfirmMixin, ModelAdmin):
confirm_change = True
confirmation_fields = ['field1', 'field2']
```
This would confirm changes on changes that include modifications on`field1` and/or `field2`.
**Confirm Add:**
```py
from admin_confirm import AdminConfirmMixin
class MyModelAdmin(AdminConfirmMixin, ModelAdmin):
confirm_add = True
confirmation_fields = ['field1', 'field2']
```
This would confirm add on adds that set `field1` and/or `field2` to a non default value.
Note: `confirmation_fields` apply to both add/change confirmations.
**Confirm Action:**
```py
from admin_confirm import AdminConfirmMixin, confirm_action
class MyModelAdmin(AdminConfirmMixin, ModelAdmin):
actions = ["action1", "action2"]
def action1(modeladmin, request, queryset):
# Do something with the queryset
@confirm_action
def action2(modeladmin, request, queryset):
# Do something with the queryset
action2.allowed_permissions = ('change',)
```
This would confirm `action2` but not `action1`.
Action confirmation will respect `allowed_permissions` and the `has_xxx_permission` methods.
> Note: AdminConfirmMixin does not confirm any changes on inlines
## 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
Check out our [development process](docs/development_process.md) if you're interested.
## 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.