skip to navigation
skip to content

Not Logged In

Flask-Images 1.1.0

Dynamic image resizing for Flask.

Latest Version: 1.1.3

[![Build Status](https://travis-ci.org/mikeboers/Flask-Images.png?branch=master)](https://travis-ci.org/mikeboers/Flask-Images)

Dynamic image resizing for Flask.

This extension adds a resized_img_src function to the template context, which creates a URL to dynamically resize an image. This function takes either a path to a local image (either absolute, or relative to the IMAGES_PATH) or an URL to a remote image, and returns a URL that will serve a resized version on demand.

Alternatively, this responds to url_for('images', filename='...', **kw) to ease transition from Flask's static files.

For example:

~~~ <img src="{{resized_img_src('logo.png', width=100)}}" /> <img src="{{resized_img_src('photo.jpeg', width=400, height=300, mode='crop', quality=95)}}" /> OR <img src="{{url_for('images', filename='logo.png', width=100)}}" /> <img src="{{url_for('images.crop', filename='photo.jpeg', width=400, height=300, quality=95)}}" /> ~~~

Specify behaviour with keyword arguments:

  • mode: one of 'fit', 'crop', 'pad', or None:
    • 'fit': as large as possible while fitting within the given dimensions;
    • 'crop': as large as possible while fitting into the given aspect ratio;
    • 'pad': as large as possible while fitting within the given dimensions, and padding to the given dimensions with a background colour;
    • None: resize to the specific dimensions without preserving aspect ratio.
  • width and height: pixel dimensions; at least one is required.

  • format: The file extension to use (as accepted by PIL); defaults to the input image's extension.

  • quality: JPEG quality; defaults to 75.

  • background: Background colour for padding; currently only accepts 'white' and defaults to black.

Installation

From PyPI:

~~~bash pip install Flask-Images ~~~

From GitHub:

~~~bash git clone git@github.com:mikeboers/Flask-Images pip install -e Flask-Images ~~~

Configuration

Configure Flask-Images via the following keys in the Flask config:

  • IMAGES_URL: The url to mount Flask-Images to; defaults to '/imgsizer'.
  • IMAGES_NAME: The name of the registered endpoint.
  • IMAGES_PATH: The paths to search relative to app.root_path for images.
  • IMAGES_CACHE: Where to store resized images; defaults to '/tmp/flask-images'.
  • IMAGES_MAX_AGE: How long to tell the browser to cache missing results; defaults to 3600. Usually, we will set a max age of one year, and cache bust via the modification time of the source image.
 
File Type Py Version Uploaded on Size
Flask-Images-1.1.0.tar.gz (md5) Source 2013-12-06 5KB
  • Downloads (All Versions):
  • 419 downloads in the last day
  • 638 downloads in the last week
  • 961 downloads in the last month