Skip to main content

Django wrapper for cloudimage.io

Project description

A Django wrapper for https://cloudimage.io

Installation

Install via pip:

pip install django-cloudimage

Usage

  1. Add to INSTALLED_APPS in settings.py 'cloudimage',
  2. Add the CLOUDIMAGE_TOKEN in settings.py
  3. Add the include to urlpatterns in urls.py urlpatterns = [ url(r'^media/', include('cloudimage.urls')), ]
  4. Load the template tag into a template {% load cloudimage %}
  5. Use the image tag. {% image 'path/to/image.jpg' width=100 %} Visit the CloudImage Docs for all of the options. Convert parameters to kwargs.

Options

Cache Control headers

It is highly recommended that if you use this package your site should be sitting behind a CDN. Not sure what this is, check out https://www.cloudflare.com/

Add to settings.py

To set an expiration timeout use an integer in seconds. For example, below the image is set to cache for an hour.

CLOUDIMAGE_CACHE_CONTROL = 3600

This will output Cache-Control max-age=3600 in the response header.

The advanced option

Any string you pass that doesn’t convert to an int will be set in the header.

CLOUDIMAGE_CACHE_CONTROL = "no-cache"

This will output Cache-Control no-cache in the response header.

Caveats

  • KISS
  • The origional image must be accessable via a URL, so RSZ.IO can access it. I use django-storages with AWS S3 to serve my media.
  • This is tested and used in production with Django 1.10 and 1.11 on Python 3.5 and 3.6. But this should work on older versions of Django and Python 2. Open an issue or pull request if not the case.

Versioning

The package is following the Major.Minor.BugFix philosophy. So breaking changes will increase the major number. New features will increase the minor number.

So it is safe to put this line in your requirements.txt

All new features, no breaking features

django-cloudimage>=1.0.0,<2.0

Just bugfixes

django-cloudimage>=1.0.0,<1.1

Release Notes

This project is using GitHub’s release feature. Find the release notes here https://github.com/g3rd/django-cloudimage/releases

Project details


Download files

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

Files for django-cloudimage, version 1.0.1
Filename, size File type Python version Upload date Hashes
Filename, size django_cloudimage-1.0.1-py2.py3-none-any.whl (7.6 kB) File type Wheel Python version py2.py3 Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page