Skip to main content

render image in various sizes

Project description

Build Status Coverage PyPI Version

Django image renderer is an app that will help you render images in many sizes (renditions). This can be really helpful for generating images size for different screens resolution (especially when targeting mobile).


Features

  • uses Pillow to resize images

  • uses Django’s default_storage to let you play with whatever storage backend you’ll need

  • uploaded image files named using uuid

  • rendition cached on disk

  • resize keeping original aspect ratio

  • crop if needed

  • simple widget for admin site

Quick start

Install the app.

pip install django-image-renderer

Add “renderer” to your INSTALLED_APPS setting like this:

settings.py

INSTALLED_APPS = (
    # your apps
    'renderer',
)

Include the renderer URL configuration in your project urls.py like this:

urls.py

url(r'^renderer/', include('renderer.urls', namespace='renderer')),

Run python manage.py migrate to create the renderer models.

Start the development server and visit http://localhost:8000/admin/ to create a MasterImage (you’ll need the Admin app enabled).

Requirements

  • Python (2.7, 3.4, 3.5)

  • Django (1.7, 1.8, 1.9)

Usage

There is only one model in the app: MasterImage. With a MasterImage you can ask for renditions.

m = MasterImage.objects.first()

# get the master file's URL
m.get_master_url()
# or
m.get_rendition_url(0, 0)

# cache and return URL of a renditions that as 200 pixels width
# and height computed according to master's aspect ratio
url = m.get_rendition_url(200, 0)

# cache and return URL of a renditions that as 50 pixels height
# and width computed according to master's aspect ratio
url = m.get_rendition_url(0, 50)

If you ask for a size that do not fit master’s aspect ration you’ll receive a center cropped image.

You can also ask for a rendition in templates.

models.py

def index(request):
    m = MasterImage.objects.first()
    return render(request, 'demo/index.html', {
        'master': m,
    })

index.html

{% load renderer %}
...
{% rendition master 42 42 %}
...
{% rendition_url 42 42 %}
...

This will render as:

<img src="/media/img/0fb34de8-9d83-456a-828b-72ab21f8ebab_42x42.png" width="42" height="42" alt="">
...
/media/img/0fb34de8-9d83-456a-828b-72ab21f8ebab_42x42.png
...

When using MasterImage in your model you may need a widget who provides a preview for you image. For convenience a mixin is provided.

models.py

from django.db import models

class DemoModel(models.Model):
    master = models.ForeignKey('renderer.MasterImage')

admin.py

from demo.models import DemoModel
from django.contrib import admin
from renderer.widgets import MasterImageAdminMixin

@admin.register(DemoModel)
class DemoModelAdmin(MasterImageAdminMixin, admin.ModelAdmin):
    fields = ('master', )

Sample project

A sample project is available in the sample folder. Test it as an usual Django project:

virtualenv --no-site-packages venv
source venv/bin/activate
pip install -r requirements.txt
python sample/manage.py migrate
python sample/manage.py createsuperuser
python sample/manage.py runserver

It’ also deployed at http://django-image-renderer.herokuapp.com/.

Project details


Download files

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

Source Distribution

django-image-renderer-0.1.3.tar.gz (12.2 kB view details)

Uploaded Source

Built Distribution

django_image_renderer-0.1.3-py2.py3-none-any.whl (16.6 kB view details)

Uploaded Python 2Python 3

File details

Details for the file django-image-renderer-0.1.3.tar.gz.

File metadata

File hashes

Hashes for django-image-renderer-0.1.3.tar.gz
Algorithm Hash digest
SHA256 53522bf93d8b2a8355f7880966997c8a0e11fb9e8fd4d90afde743e6b8be4db9
MD5 b5212db6a8f288f6c49a3ae43ff06c43
BLAKE2b-256 ab7cb0fa81c70502b2397a11756c650aeb9b22468cba33cb9344ab02a3cc6ac0

See more details on using hashes here.

File details

Details for the file django_image_renderer-0.1.3-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for django_image_renderer-0.1.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 8f4419e96b2ed63297c3f50486adf4a0cd65d92d736901a54e00ab93d614a4de
MD5 cdc60cd8c904a64c14b71b4fd3b1b0a1
BLAKE2b-256 bb93d545d38e2fae57c66c9c9b63652d25524bf2e56a754e207c7ab6a4dc1f31

See more details on using hashes here.

Supported by

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