Skip to main content

Thumbnails for ImageFields in django admin.

Project description

django_admin_thumbnail
======================
[![PyPi version](https://pypip.in/v/django_admin_thumbnail/badge.png)](https://crate.io/packages/django_admin_thumbnail/)
[![PyPi downloads](https://pypip.in/d/django_admin_thumbnail/badge.png)](https://crate.io/packages/django_admin_thumbnail/)

This is a package developed to help you with `ImageField` visualization in your `ModelAdmin`. It automatically creates user friendly thumbnail for any `ImageField` you choose to put in your `list_display`.

All you have to do is to switch from *ModelAdmin* to *ThumbAdmin* subclass. It's super easy to use:

The Looks
---------
This is how it looks when you hover your cursor over an `ImageField` column:

![The Looks](https://raw.github.com/fjcaetano/django-admin-thumbnail/master/thumb_image.png)

Usage
-----

Insert **admin_thumbnail** to the end of your `INSTALLED_APPS` in `settings.py`:

``` python
INSTALLED_APPS = (
...
'admin_thumbnail',
...
)
```

Now, your `ModelAdmin` must look like this::

``` python
from models import ModelExample
from admin_thumbnail import thumb_admin
from django.contrib import admin

class ModelExampleAdmin(thumb_admin.ThumbAdmin):
list_display = ('an_image_field',)

admin.register(ModelExample, ModelExampleAdmin)
```

After that you must create your DB table that manages the cached thumbnails:

python manage.py syncdb

If you're using `south` you'll need to initialise **sorl.thumbnail's** migrations:

```
python manage.py schemamigration sorl.thumbnail --initial
python manage.py migrate sorl.thumbnail --database=$DATABASE_NAME
```

If your `$DATABASE_NAME` is not _default_, and you're using a (DB router)[https://docs.djangoproject.com/en/dev/topics/db/multi-db/#using-routers], you should add a key named `thumbnail` to your database mapping dictionary!

Yes! It's THAT simple!

# Installation

Please, first read the [sorl.thumbnail installation](http://sorl-thumbnail.readthedocs.org/en/latest/) to install it's requirements.

Install using pip:

pip install django-admin-thumbnail

Or you can clone the project and install it via:

python setup.py install

## Requirements

* [Django 1.4+](http://pypi.python.org/pypi/Django/1.4)
* [sorl.thumbnail 11.12+](http://pypi.python.org/pypi/sorl-thumbnail/11.12)
* [PIL 1.1.6+](http://pypi.python.org/pypi/PIL/1.1.6)

# Localization

django-admin-thumbnail is localizable, but currently, the only officially supported languages are pt_BR, en_US and es. But feel free to localize it the way you want and then, send me the .po file for it to be official.


# Contact

If you have any comments, ideas questions, feedback, etcetera, email me and we'll be in touch. I'm <flavio@vieiracaetano.com>

Project details


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
django_admin_thumbnail-1.0.tar.gz (5.5 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page