Getting started

Installation

1
 $ pip install Flask-Imagine

Configuration example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
 from flask import Flask
 from flask.ext.imagine import Imagine

 app = Flask(__name__)

 app.config['IMAGINE_ADAPTER'] = {
     'name': 'fs',
     'source_folder': 'images',
     'cache_folder': 'cache'
 }

 app.config['IMAGINE_FILTER_SETS'] = {
     'filter_set_name': {
         'cache': True,
         'filters': {
             # Filters initialization parameters
         }
     }
 }

Dynamic filter sets configuration

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
 from flask import Flask
 from flask.ext.imagine import Imagine

 app = Flask(__name__)

 app.config['IMAGINE_ADAPTER'] = {
     'name': 'fs',
     'source_folder': 'images',
     'cache_folder': 'cache'
 }

 imagine = Imagine(app)

 # Add filter set
 imagine.add_filter_set(
     'filter_set_name',
     [
         Filter(parameter='value')  # List of preconfigured filters
     ],
     cached=True
 )

 # Update existing filter set
 imagine.update_filter_set(
     'filter_set_name',
     [
         NewFilter(parameter='value')  # List of preconfigured filters
     ],
     cached=False
 )

 # Remove existing filter set
 imagine.remove_filter_set('filter_set_name')