django-adminlinks¶
Usage documentation¶
What it is¶
A suite of template tags for rendering links to a Django AdminSite instance.
At it’s most basic, given a Model, it will do the appropriate checks to ensure that the currently signed in user can perform the requested action via the admin, and displays a configurable template with a link to the right place.
Why?¶
Because I wedge the Django admin into everything, whether it should fit or not. Not so much because I love the admin, but because it provides a well-understood CRUD application that can be bolted onto in a pinch.
Features¶
Here’s a brief run-down on what’s in the box:
- Basic, sane permission checking
- Calling the template tags without a RequestContext should not expose any markup.
- Users must be signed in, and pass the permission checking for the specific administration view.
- Optional CSS and JavaScript to improve the functionality by providing “button” like links, and a modal window for opening links.
- Pretty reasonable documentation. Or at least that’s the aim.
- An additional view on all instances which subclass our AdminlinksMixin, to edit a specific field on a model, which can be used for some fairly neat in-place editing of only distinct parts of some data.
Show me a demo!¶
The main draw, at least for me, is the ability to get frontend-editing for any model registered with the AdminSite. Currently when using the CSS, JS and Modeladmin mixin, you can hope for behaviour shown below.
Links¶
Modal editing¶
Note
The modal window has been sped up here to keep the animated GIF small, and the admin is in popup mode thanks to fix_admin_popups().
Developer documentation (API, etc)¶
Contributing¶
Please do!
The project is hosted on GitHub in the kezabelle/django-adminlinks repository. The main branch is master.
Bug reports and feature requests can be filed on the repository’s issue tracker.
If something can be discussed in 140 character chunks, there’s also my Twitter account.
Similar projects¶
In the course of writing this, I have become aware of other packages tackling the same sort of thing:
- Martin Mahner’s django-frontendadmin
- Yaco Sistemas’ django-inplaceedit
- Ryan Berg’s django-jumptoadmin
- Maxime Haineault’s django-editlive
- Interaction Consortium’s django-adminboost
If you’re aware of any others working in the same space, let me know and I’ll add them here.
License¶
django-adminlinks 0.8.0 is available under the terms of the Simplified BSD License (alternatively known as the FreeBSD License, or the 2-clause License). See the LICENSE file in the source distribution for a complete copy, or in the this release on GitHub.