Skip to main content

A Django ImageField that offers progressive image loading during HTML rendering.

Project description

Progressive Image Model Field for Django

Requires:

  • Python 3.6+
  • Pillow 4.0+
  • Django 1.10+

The Problem: So, you have build a website (portfolio, news, eshop etc), you have optimized your static files (css, js, fonts, images) but still, the webpage loads quite slow due to lots of images being rendered (however, there might be other reasons, but right now, let’s focus on the image rendering).

The Solution: Based on José Manuel Pérez’s article about How Medium does progressive image loading, I have created a Django ModelField, which I called ProgressiveImageField. All it does is this: when an instance’s progressiveimagefield is created (saved, most commonly via the admin interface), it automatically creates a very small blurred thumbnail (maximum dimensions 10x10px) next to the original image. When this large image is rendered, the src attribute of the img element points to the thumbnail and not the large image. So, the user, initially, sees the blurred thumbnail. Behind the scenes, javascript takes place and gradually downloads the original image. Once the original image is downloaded, the blurred thumbnail is replaced through a nice-looking-CSS-fade effect. That’s all!

Installation

  1. Install it using pip:

    pip install django-progressiveimagefield

  2. Add it to your INSTALLED_APPS inside your settings file:

    INSTALLED_APPS += ['progressiveimagefield']

How to use

Inside your models.py, simply:

from django.db import models

from progressiveimagefield.fields import ProgressiveImageField

class MyModel(models.Model):
    # Other fields here
    img = ProgressiveImageField(upload_to="somewhere")

Inside your base.html template:

{% load static %}

<!DOCTYPE html>
<html>
    <head>
        <!-- other meta tags here etc -->
        <link rel="stylesheet" media="all" href="{% static 'progressiveimagefield/css/pif.css' %}">
    </head>
    <body>
        {% block content %}{% endblock %}
        <script src="{% static 'progressiveimagefield/js/pif.js' %}"></script>
    </body>
</html>

Finally, inside another HTML template where you want to render your image progressively, you have two options depending on which template engine is used to render your template:

  • Using the DTL (Django Template Language)

    {% load progressive_tags %}
    
    {% block content %}
        {% render_progressive_field instance.img %}
    {% endblock %}
    
  • Using the Jinja2 Template Language

  1. Add the filter inside the file (i.e jinja.py) where Jinja2 Environment is defined

    from jinja2 import Environment
    
    def environment(**options):
        env = Environment(**options)
        env.filters.update({
            'progressive': 'progressiveimagefield.jinja.progressive',
        })
        return env
    
  2. Add the dotted path to the above function in your settings’s TEMPLATES setting OPTIONS dict as the value to the environment key. OK, here is the code:

    TEMPLATES = [
        {
            'BACKEND': 'django.template.backends.jinja2.Jinja2',
            'DIRS': # setting for DIRS here,
            'APP_DIRS': True,
            'OPTIONS': {
                'environment': 'path.to.jinja.environment.function',
            },
        },
        ...
    ]
    
  3. Use it in your HTML template like this (just like a regular Django filter):

    {% block content %}
        {{ instance.img|progressive }}
    {% endblock %}
    

Testing

In order to test this application, you should

  1. Clone the repo
  2. Create a virtualenv (mkvirtualenv -p $(which python3.6) progressiveimagefield) and activate it (once created, it’ll be activated by default)
  3. Install the requirements (pip install -r tests/test_requirements.txt)
  4. Run python runtests.py

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_progressiveimagefield-0.1.4-py3-none-any.whl (11.1 kB) Copy SHA256 hash SHA256 Wheel py3 Nov 7, 2018
django-progressiveimagefield-0.1.4.tar.gz (7.7 kB) Copy SHA256 hash SHA256 Source None Nov 7, 2018

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