Flask-Redis

Add Redis Support to Flask.

Built on top of redis-py.

Currently a single namespace within the configuration is supported.

REDIS_URL="redis://localhost"

with the Redis instance automatically loading config from this namespace.

In the future, the ability to declare multiple Redis namespaces will be available

REDIS_CACHE_URL="redis://localhost/0"
REDIS_METRICS_URL="redis://localhost/0"

redis_cache = Redis(config_prefix="REDIS_CACHE")
redis_metrics = Redis(config_prefix="REDIS_METRICS")

Installation

pip install flask-redis

Or if you must use easy_install:

alias easy_install="pip install $1"
easy_install flask-redis

Configuration

Your configuration should be declared within your Flask config. You can declare via a Redis URL

REDIS_URL = "redis://:password@localhost:6379/0"

or you are able to declare the following

REDIS_HOST = "localhost"
REDIS_PASSWORD = "password"
REDIS_PORT = 6379
REDIS_DATABASE = 5

To create the redis instance within your application

from flask import Flask
from flask_redis import Redis

app = Flask(__name__)
redis_store = Redis(app)

or

from flask import Flask
from flask_redis import Redis

redis_store = Redis()

def create_app():
    app = Flask(__name__)
    redis_store.init_app(app)
    return app

Usage

from core import redis_store

@app.route('/')
def index():
    return redis_store.get('potato','Not Set')

Protip: The redis-py package currently holds the 'redis' namespace, so if you are looking to make use of it, your Redis object shouldn't be named 'redis'.

For detailed instructions regarding the usage of the client, check the redis-py documentation.

Advanced features, such as Lua scripting, pipelines and callbacks are detailed within the projects README.