README.rst

Flask-Redislite

Using Flask with Redislite, also redis-collections and rq.

Installation

Using pip

pip install Flask-Redislite

Usage

Choose the path for your Redislite data file, then include to your application config

REDISLITE_PATH = '<path/to/redis/file.rdb>'

Create new redis instance within your application

from flask import Flask
from flask_redislite import FlaskRedis

app = Flask(__name__)

rdb = FlaskRedis(app)
# with redis-collections:
# rdb = FlaskRedis(app, collection = True)

Then use it on your view

rdb.connection.set('foo1', 'bar1')
print rdb.connection.get('foo1')

# redis-collections
collection = rdb.collection
d = collection.dict('123456')
d['foo'] = 'bar'
print d

RQ

To use Flask-Redislite with RQ, you need to start RQ worker as a new process

from flask import Flask
from flask_redislite import FlaskRedis

app = Flask(__name__)

rdb = FlaskRedis(app, rq=True)

# Your other extensions load here
# ex: lm = LoginManager()
# ...

with app.app_context():
    rdb.start_worker()

# your codes
# ex: views function

app.run()

Then within your view enqueue the jobs:

import time

def simple_job():
    time.sleep(2)
    return 12345

queue = rdb.queue
queue['default'].enqueue(simple_job, ttl=60, result_ttl=60, job_id='321')
sleep(5)
print queue['default'].fetch_job('321').result