Django mixin to easily add urls to any ModelAdmin


Keywords
django, django-admin, python
License
BSD-3-Clause
Install
pip install admin-extra-urls==2.1.0

Documentation

admin-extra-urls

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-urls

After 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 master-build master-cov  
Development dev-build dev-cov  
Project home page: https://github.com/saxix/django-admin-extra-urls
Issue tracker: https://github.com/saxix/django-admin-extra-urls/issues?sort
Download: http://pypi.python.org/pypi/admin-extra-urls/