Django app enabling painless creation of additional admin object tools.
.. image:: docs/images/example-tools.png
.. contents:: Contents :depth: 5
#. Python 2.7, 3.5-3.7
#. Django 1.11, 2.0, 2.1
#. Install or add
django-object-tools to your python path.
object_tools to your
django-object-tools overrides certain admin templates so you have to add it before
#. Hook up URLConf. Do this by pointing a given URL at the
tools.urls method. In this example, we register the default
object_tools.tools at the URL
.. code-block:: python
# urls.py from django.conf.urls.defaults import * from django.conf.urls import url import object_tools urlpatterns = [ path('object-tools/', object_tools.tools.urls) ]
#. Obviously Django Admin itself needs to be installed, as described
#. Remember to run
migrate whenever you install new tools to setup permissions.
django-object-tools itself doesn't do much in terms of providing useful tools. Its purpose is to simplify creation and integration of custom tools delivered by other Django applications. To that end it takes care of the messy details like permissions and admin template integration so you can focus on the fun stuff.
As an example lets create a tool allowing you to delete all objects. Yes this is a bit convoluted but it's a good toy example for illustration purposes. Have a look at
django-export <http://pypi.python.org/pypi/django-export> and
django-order <http://pypi.python.org/pypi/django-order> for examples of real world tools leveraging
Firstly create a Django app folder structure as per usual, with the root directory named
delete, including a file called
tools.py. It should look as follows::
delete/ __init__.py tools.py
tools.py to look like this:
.. code-block:: python
from django.contrib.admin.actions import delete_selected from django.contrib.admin.sites import site import object_tools class Delete(object_tools.ObjectTool): name = 'delete' label = 'Delete all' def view(self, request, extra_context=None): queryset = self.model.objects.all() modeladmin = site._registry.get(self.model) response = delete_selected(modeladmin, request, queryset) if response: return response else: return modeladmin.changelist_view(request) object_tools.tools.register(Delete)
Let's go through that line by line:
object_tools behaves similarly to Django's admin allowing you to explicitly register tools, see line 17. It also provides the
ObjectTool base class.
delete_selected method provided by Django. This method will do all the heavy lifting.
Create a tool class inheriting from
object_tools.ObjectTool. All object tools have to inherit from
ObjectTool provides various methods to simplify creation of tools. See
object_tools.options.py <https://github.com/praekelt/django-object-tools/blob/master/object_tools/options.py>_ for more details.
Set tool name to
delete. This has to be a unique name identifying the tool. This is used to uniquely identify the tool internally and for instance to setup permissions.
Set label to
Delete all. The label is displayed within admin and not the name, thus allowing you to specify a more verbose, user friendly label.
view method. This is the brains of your tool. The
view method is called when the user executes your tool, so your tool logic would go here. This can be any view like code, as long as it returns an
HttpResponse object. In this case we wrap Django's built-in
delete_selected to provide the form, logic and template code to perform the actual delete.
Register the tool with
object_tools, thus enabling its display in admin.
To enable the tool add
delete to your
Now when you navigate to the change list view of any model you'll find the delete all object tool in the upper right hand corner.
.. image:: docs/images/delete-example-final.png
Clicking on the Delete all tool fires off the view and proceeds with deleting objects as per usual.
django-object-tools adds per tool permissions to the built-in set of default Django permissions. So in this example only superusers or users who have the the Can delete permission will be able to see and use the tool. If you can't see or use a particular tool make sure the authenticated user has the required permissions to do so.