Skip to main content

Redis Extension for Flask Applications

Project description

https://travis-ci.org/rhyselsmore/flask-redis.png?branch=master https://pypip.in/d/Flask-Redis/badge.png

Add Redis Support to Flask.

Built on top of redis-py.

Contributors

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 containing the database

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

To create the redis instance within your application

from flask import Flask
from flask.ext.redis import FlaskRedis

app = Flask(__name__)
redis_store = FlaskRedis(app)

or

from flask import Flask
from flask.ext.redis import FlaskRedis

redis_store = FlaskRedis()

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

or perhaps you want to use StrictRedis

from flask import Flask
from flask.ext.redis import FlaskRedis
from redis import StrictRedis

app = Flask(__name__)
redis_store = FlaskRedis.from_custom_provider(StrictRedis, app)

or maybe you want to use mockredis to make your unit tests simpler. As of mockredis 2.9.0.10, it does not have the from_url() classmethod that FlaskRedis depends on, so we wrap it and add our own.

from flask import Flask
from flask.ext.redis import FlaskRedis
from mockredis import MockRedis



class MockRedisWrapper(MockRedis):
    '''A wrapper to add the `from_url` classmethod'''
    @classmethod
    def from_url(cls, *args, **kwargs):
        return cls()

def create_app():
    app = Flask(__name__)
    if app.testing:
        redis_store = FlaskRedis.from_custom_provider(MockRedisWrapper)
    else:
        redis_store = FlaskRedis()
    redis_store.init_app(app)
    return app

Usage

FlaskRedis proxies attribute access to an underlying Redis connection. So treat it as if it were a regular Redis instance.

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.

Contribute

  1. Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug. There is a Contributor Friendly tag for issues that should be ideal for people who are not very familiar with the codebase yet.

  2. Fork the repository on Github to start making your changes to the master branch (or branch off of it).

  3. Write a test which shows that the bug was fixed or that the feature works as expected.

  4. Send a pull request and bug the maintainer until it gets merged and published.

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

Flask-Redis-0.1.0.zip (12.8 kB view hashes)

Uploaded Source

Built Distributions

Flask_Redis-0.1.0-py3-none-any.whl (8.7 kB view hashes)

Uploaded Python 3

Flask_Redis-0.1.0-py2-none-any.whl (8.7 kB view hashes)

Uploaded Python 2

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