Django mixin to easily add urls to any ModelAdmin
Project description
pluggable django application that offers one single mixin class ExtraUrlMixin to easily add new url (and related buttons on the screen) to any ModelAdmin.
It provides two decorators link() and action().
link() is intended to be used for multiple records. It will produce a button in the change list view.
action() works on a single record. It will produce a button in the change form view.
Install
pip install admin-extra-urlsAfter installation add it to INSTALLED_APPS
INSTALLED_APPS = (
...
'admin_extra_urls',
)How to use it
from admin_extra_urls.extras import ExtraUrlMixin, link, action
class MyModelModelAdmin(ExtraUrlMixin, admin.ModelAdmin):
@link() # /admin/myapp/mymodel/update_all/
def update_all(self, request):
...
...
@action() # /admin/myapp/mymodel/update/10/
def update(self, request, pk):
obj = self.get_object(pk=pk)
...You don’t need to return a HttpResponse. The default behavior is:
with link() button is displayed in the ‘list’ view and the browser will be redirected to changelist_view
with action() button is displayed in the ‘update’ view and the browser will be redirected to change_view
link() / action() options
path |
None |
path url path for the action. will be the url where the button will point to. |
label |
None |
label for the button. by default the “labelized” function name |
icon |
‘’ |
icon for the button |
permission |
None |
permission required to use the button. Can be a callable (current object as argument). |
css_class |
“btn btn-success” |
extra css classes to use for the button |
order |
999 |
in case of multiple button the order to use |
visible |
lambda o: o and o.pk |
callable or bool. By default do not display “action” button if in add mode |
Integration with other libraries
django-import-export
@admin.register(Rule)
class RuleAdmin(ExtraUrlMixin, ImportExportMixin, BaseModelAdmin):
@link(label='Export')
def _export(self, request):
return self.export_action(request)
@link(label='Import')
def _import(self, request):
return self.import_action(request)Links
Stable |
||||
Development |
||||
Project home page: |
||||
Issue tracker: |
https://github.com/saxix/django-admin-extra-urls/issues?sort |
|||
Download: |
||||
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file admin-extra-urls-1.9.0.tar.gz.
File metadata
- Download URL: admin-extra-urls-1.9.0.tar.gz
- Upload date:
- Size: 17.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 9a9fc7ce35181876d5dbc12376f31ccb031bfb79c3438d64cfe2c8388d23f1c4 |
|
| MD5 | 104171e90f1c84e56e529a8787163dad |
|
| BLAKE2b-256 | 1fe2e1efacf346b6fe911636abebe61d224d7a399a661b258c32c78d143f9a48 |
