Skip to main content

A Django template tag library which allows to download external images, store them locally and return the local path to locally stored image to a desired context variable

Project description

Fetch external images directly from templates.

A Django template tag library which allows to download external images, store them locally and return the local path to locally stored image to a desired context variable, along with width and height attributes of the image fetched. Caches the fetched images locally for the given time (set in settings).

You could, for example, use this app to solve the problems with displaying of a mixed content (assets loaded from HTTP and HTTPS sources).

Prerequisites

  • Django 1.8, 1.9, 1.10

  • Python >=2.7, >=3.4

Installation

  1. Install django-eximagination

Latest stable version on PyPI:

pip install django-eximagination

Latest stable version from GitHub:

pip install https://github.com/barseghyanartur/django-eximagination/archive/stable.tar.gz

  1. Add eximagination to INSTALLED_APPS.

INSTALLED_APPS = (
    # ...
    'eximagination',
    # ...
)
  1. Configure

By default, django-eximagination expects your files to be stored in /media/external_images directory. If location varies, redefine the directories in your Django settings, make sure the path is writable and that www-data (or whatever is applicable) has rights to write into it.

import os

BASE_DIR = os.path.dirname(os.path.dirname(__file__))
MEDIA_ROOT = os.path.join(BASE_DIR, '..', '..', 'media')
EXIMAGINATION_MEDIA_ROOT = os.path.join(MEDIA_ROOT, 'external_images')
EXIMAGINATION_MEDIA_URL = '/media/external_images'
EXIMAGINATION_MEDIA_RELATIVE_ROOT = 'external_images/'
# After 30 days we re-fetch the file anyway.
EXIMAGINATION_EXPIRATION_INTERVAL = 2592000

Usage example (in a Django template)

See the example directory for working code example.

Example #1:

{% load eximaginate %}

<img src="{{ MEDIA_URL }}{% eximaginate 'http://www.google.com/intl/en/images/logo.gif' %}">

Example #2:

{% load eximaginate thumbnail %}

{% eximaginate 'http://www.google.com/intl/en/images/logo.gif' as original %}

<img src="{% thumbnail original 100x100 %}">

In both cases there are two additional context variables added:

  • ei_width - Width of the image

  • ei_height - Height of the image

Testing

Simply type:

./runtests.py

or use tox:

tox

or use tox to check specific env:

tox -e py35

or run Django tests:

./manage.py test eximagination --settings=settings.testing

License

GPL 2.0/LGPL 2.1

Support

For any issues contact me at the e-mail given in the Author section or open an issue on BitBucket/GitHub.

Author

Artur Barseghyan <artur.barseghyan@gmail.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-eximagination-0.8.3.tar.gz (7.6 kB view details)

Uploaded Source

Built Distribution

django_eximagination-0.8.3-py2.py3-none-any.whl (13.7 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file django-eximagination-0.8.3.tar.gz.

File metadata

File hashes

Hashes for django-eximagination-0.8.3.tar.gz
Algorithm Hash digest
SHA256 6f913f0266be1ba9ba03470a2e3da85d45e5c12e4f9500508ce9590559072f7d
MD5 16f26e6a93ccc4ab12263b699d05ce86
BLAKE2b-256 44ee8069f2da4bf3824b1b58ad83337be797a98ae7f87d634d96fd4e82fc830c

See more details on using hashes here.

File details

Details for the file django_eximagination-0.8.3-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for django_eximagination-0.8.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 0f10a43549f5f239777cbbce1d1fd624206f5d91ae48a78b3cefad32e356f204
MD5 6447ad92a928a627d14268a6978d6f9c
BLAKE2b-256 febd0e1a44e70e50ac2389fec944687215258f6672f441a350b273d9d36e19f2

See more details on using hashes here.

Supported by

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