saxix/django-admin-extra-urls


Single mixin class to easily add buttons on any Django ModelAdmin related page

License: Other

Language: Python

Keywords: django, django-admin, python


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/

Project Statistics

Sourcerank 6
Repository Size 125 KB
Stars 14
Forks 10
Watchers 2
Open issues 1
Dependencies 19
Contributors 8
Tags 25
Created
Last updated
Last pushed

Top Contributors See all

Stefano Apostolico Domenico marcoimme Kirill Goncharov Michael Overmeyer Giovanni B. Jorrit Paolo Melchiorre

Packages Referencing this Repo

admin-extra-urls
Django mixin to easily add urls to any ModelAdmin
Latest release 2.1.0 - Updated - 14 stars

Recent Tags See all

2.1 September 03, 2018
2.1 September 03, 2018
2.0 September 03, 2018
1.9 April 18, 2018
1.8 February 01, 2018
1.7 January 17, 2018
1.6 October 27, 2017
1.5 June 12, 2017
1.4 March 01, 2017
1.3.1 August 25, 2016
1.3 August 23, 2016
1.2 July 24, 2016
1.1 July 11, 2016
1.0 January 07, 2016
0.8 December 17, 2015

Something wrong with this page? Make a suggestion

Last synced: 2019-04-04 16:17:05 UTC

Login to resync this repository