Skip to main content

Django mixin to easily add urls to any ModelAdmin

Project description

https://raw.githubusercontent.com/saxix/django-admin-extra-urls/develop/docs/image.png

pluggable django application that offers one single mixin class ExtraUrlMixin to easily add new url (and related buttons on the screen) to any ModelAdmin.

  • action() decorator It will produce a button in the change form view.

  • ChangeFormButton() to add button that point to external urls.

  • ChangeListButton() to add button that point to external urls.

Install

pip install django-admin-extra-urls

After installation add it to INSTALLED_APPS

INSTALLED_APPS = (
    ...
    'admin_extra_urls',
)

How to use it

from admin_extra_urls import api as extras

class MyModelModelAdmin(extras.ExtraUrlMixin, admin.ModelAdmin):
    extra_buttons = [extras.ChangeFormButton('/{original.pk}/'),]
    actions = ['smart_action']

    @extras.action() # /admin/myapp/mymodel/update_all/
    def consolidate(self, request):
        ...
        ...

    @extras.action() # /admin/myapp/mymodel/update/10/
    def update(self, request, pk):
        # if we use `pk` in the args, the button will be in change_form
        obj = self.get_object(pk=pk)
        ...

    @action(urls=[r'^aaa/(?P<pk>.*)/(?P<state>.*)/$',
                  r'^bbb/(?P<pk>.*)/$'])
    def revert(self, request, pk, state=None):
        obj = self.get_object(pk=pk)
        ...


    @extras.action(label='Truncate', permission=lambda request, obj: request.user.is_superuser)
    def truncate(self, request):

        if request.method == 'POST':
            self.model.objects._truncate()
        else:
            return extras._confirm_action(self, request, self.truncate,
                                   'Continuing will erase the entire content of the table.',
                                   'Successfully executed', )

You don’t need to return a HttpResponse. The default behavior is:

  • if the method contains the pk argument button will be displayed in the ‘update’ view and the browser will be redirected to change_view

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

urls

None

list of urls to be linked to the action.

Integration with other libraries

django-import-export

@admin.register(Rule)
class RuleAdmin(ExtraUrlMixin, ImportExportMixin, BaseModelAdmin):
    @action(label='Export')
    def _export(self, request):
        if '_changelist_filters' in request.GET:
            real_query = QueryDict(request.GET.get('_changelist_filters'))
            request.GET = real_query
        return self.export_action(request)

    @action(label='Import')
    def _import(self, request):
        return self.import_action(request)

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-admin-extra-urls-3.2.tar.gz (100.7 kB view details)

Uploaded Source

File details

Details for the file django-admin-extra-urls-3.2.tar.gz.

File metadata

  • Download URL: django-admin-extra-urls-3.2.tar.gz
  • Upload date:
  • Size: 100.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0 requests-toolbelt/0.9.1 tqdm/4.37.0 CPython/3.6.8

File hashes

Hashes for django-admin-extra-urls-3.2.tar.gz
Algorithm Hash digest
SHA256 b9066bc5c2ace9a77ea02b486427037813c172f0d9040da3730a9d71f6e23c27
MD5 779da58443b2cb4d9b59352b3fcbf805
BLAKE2b-256 463f2e4942dc94300fd7e8cbd25163b6545c6eaedd20ab21923352860b2bf4f4

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page