https://github.com/exogen/django-adminbrowse
[UNMAINTAINED] Add related object links and other useful features to the Django admin interface.
https://github.com/exogen/django-adminbrowse
Last synced: 6 months ago
JSON representation
[UNMAINTAINED] Add related object links and other useful features to the Django admin interface.
- Host: GitHub
- URL: https://github.com/exogen/django-adminbrowse
- Owner: exogen
- Created: 2010-12-02T17:19:11.000Z (about 15 years ago)
- Default Branch: master
- Last Pushed: 2016-09-20T03:51:39.000Z (over 9 years ago)
- Last Synced: 2025-06-30T22:30:28.737Z (6 months ago)
- Language: Python
- Homepage:
- Size: 96.7 KB
- Stars: 39
- Watchers: 3
- Forks: 3
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
django-adminbrowse
==================
Make browsing the Django admin site easier by adding helpful features to
changelist pages. Like so:
* Link to the change form for objects in foreign key fields
* Link to filtered changelist pages showing only related objects
* Link to URLs contained in URL fields
* Easily generate other dynamic changelist columns
* Works with no modifications to Django or its default templates
Installation
------------
From the Python package index:
$ easy_install -Z django-adminbrowse
The `-Z` (`--always-unzip`) option will unzip the package during installation, making it easier to copy the media files to the desired location.
From the source repository:
$ pip install git+git://github.com/exogen/django-adminbrowse.git
Then, add 'adminbrowse' to your `INSTALLED_APPS`:
INSTALLED_APPS = (
...
'adminbrowse',
)
Finally, copy the media files to the location from which your static files
are served, and set `ADMINBROWSE_MEDIA_URL` to the corresponding location.
Keep reading for details.
After installing adminbrowse, you may wish to ensure that everything's in
working order:
$ python manage.py test adminbrowse
If it's not, please let me know!
Usage
-----
### Quickstart
To enable the most basic functionality, just inherit from
`adminbrowse.AutoBrowseModelAdmin` instead of Django's
`django.contrib.admin.ModelAdmin`:
from adminbrowse import AutoBrowseModelAdmin
class MyModelAdmin(AutoBrowseModelAdmin):
...
Make sure you have made adminbrowse media available at the URL specified by
the `ADMINBROWSE_MEDIA_URL` setting. For example, if you copied the
adminbrowse media to **`/adminbrowse`**, set `ADMINBROWSE_MEDIA_URL`
to **`/adminbrowse/`**.
### How it works
Django allows one to use callable objects in the `list_display` attribute of
`ModelAdmin` classes. adminbrowse is simply a collection of classes that
implement `__call__()` to dynamically render changelist column content.
The included `ModelAdmin` subclass, `AutoBrowseModelAdmin`, does only two
things:
* It scans the `list_display` attribute when instantiated, replacing field
strings with their adminbrowse-enhanced equivalents when possible.
* It includes the adminbrowse CSS in its Media definition.
Documentation
-------------
### Examples
Given these classes:
class Author(Model):
name = CharField(max_length=75)
website = URLField(blank=True)
class Book(Model):
title = CharField(max_length=200)
author = ForeignKey(Author, related_name='books')
`Author`'s `ModelAdmin.list_display` might find these useful:
* `link_to_url(Author, 'website')`: Make the author's URL clickable, if it exists
* `link_to_changelist(Author, 'books')`: Link to a filtered `Book` changelist showing
only books for the appropriate author
And `Book`'s `ModelAdmin.list_display` might want to use these:
* `truncated_field(Book, 'title', 50)`: Truncate long titles to 50 characters,
appending an ellipsis if needed
* `link_to_change(Book, 'author')`: Link to the change form of the book's author
### Media
If you're not using `AutoBrowseModelAdmin` to automatically include the adminbrowse
media, you'll want to place the following `Media` definition in your `ModelAdmin`
classes:
class Media:
css = {'all': (ADMINBROWSE_MEDIA_URL + 'css/adminbrowse.css',)}
...where `ADMINBROWSE_MEDIA_URL` is the value from `settings.py`.
### Rendering templates
Use `help(adminbrowse.template_column)` for now.
### Custom changelist columns
Use `help(adminbrowse.ChangeListColumn)` for now.
### Performance effects
Won't using `link_to_changelist()` drastically increase the number of queries
executed? By default, yes, it will trigger one query per row in the changelist.
This trade-off may be acceptable, especially when you consider that the admin
site is paginated, and probably only accessed by a handful of people. In my
experience, the time spent on database queries is only increased by a few
milliseconds.
However, if you can't spare the extra queries, you can still use
`link_to_changelist()` in a useful way. The `text` argument sets the link text
to display. If you set this to a string instead of a callable, the `QuerySet`
will never be evaluated (the default is `len()`, which is why the number of
items is shown – it's called with the `QuerySet`).
Using it like so:
link_to_changelist(Author, 'books', text="List books by this author")
...will still provide a clickable link to the filtered changelist without
performing the query.
[INSTALL]: http://github.com/exogen/django-adminbrowse/blob/master/INSTALL
[www]: http://brianbeck.com/