https://github.com/robpol86/flask-redis-helper
Redis support for Flask without breaking PyCharm inspections.
https://github.com/robpol86/flask-redis-helper
Last synced: 4 months ago
JSON representation
Redis support for Flask without breaking PyCharm inspections.
- Host: GitHub
- URL: https://github.com/robpol86/flask-redis-helper
- Owner: Robpol86
- License: mit
- Archived: true
- Created: 2014-05-31T22:53:36.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2015-06-05T02:53:55.000Z (almost 10 years ago)
- Last Synced: 2025-01-20T16:35:39.474Z (4 months ago)
- Language: Python
- Size: 259 KB
- Stars: 6
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
==================
Flask-Redis-Helper
==================
Yet another Redis extension for Flask. ``Flask-Redis-Helper`` doesn't break PyCharm autocomplete/inspections and handles
the Flask application context the same way SQLAlchemy does.
* Python 2.6, 2.7, PyPy, PyPy3, 3.3, and 3.4 supported on Linux and OS X.
* Python 2.7, 3.3, and 3.4 supported on Windows (both 32 and 64 bit versions of Python).
Tested on Windows XP and Windows 10 technical preview.
.. image:: https://img.shields.io/appveyor/ci/Robpol86/Flask-Redis-Helper/master.svg?style=flat-square&label=AppVeyor%20CI
:target: https://ci.appveyor.com/project/Robpol86/Flask-Redis-Helper
:alt: Build Status Windows
.. image:: https://img.shields.io/travis/Robpol86/Flask-Redis-Helper/master.svg?style=flat-square&label=Travis%20CI
:target: https://travis-ci.org/Robpol86/Flask-Redis-Helper
:alt: Build Status
.. image:: https://img.shields.io/codecov/c/github/Robpol86/Flask-Redis-Helper/master.svg?style=flat-square&label=Codecov
:target: https://codecov.io/github/Robpol86/Flask-Redis-Helper
:alt: Coverage Status
.. image:: https://img.shields.io/pypi/v/Flask-Redis-Helper.svg?style=flat-square&label=Latest
:target: https://pypi.python.org/pypi/Flask-Redis-Helper/
:alt: Latest Version
.. image:: https://img.shields.io/pypi/dm/Flask-Redis-Helper.svg?style=flat-square&label=PyPI%20Downloads
:target: https://pypi.python.org/pypi/Flask-Redis-Helper/
:alt: Downloads
Attribution
===========
Inspired by `Flask-SQLAlchemy `_ and
`Flask-And-Redis `_.
Supported Libraries
===================
* `Flask `_ 0.10.1
* `Redis `_ 2.9.1
* `Celery `_ 3.1.11
Quickstart
==========
Install:
.. code:: bash
pip install Flask-Redis-Helper
Examples
========
Basic Example
-------------
.. code:: python
from flask import Flask
from flask.ext.redis import Redis
app = Flask(__name__)
app.config['REDIS_URL'] = 'redis://localhost'
redis = Redis(app)
Factory Example
---------------
.. code:: python
# extensions.py
from flask.ext.redis import Redis
redis = Redis()
redis_cache = Redis()
.. code:: python
# application.py
from flask import Flask
from extensions import redis, redis_cache
def create_app():
app = Flask(__name__)
app.config['REDIS_URL'] = 'redis://localhost/0'
app.config['REDIS_CACHE_URL'] = 'redis://localhost/1'
redis.init_app(app)
redis_cache.init_app(app, config_prefix='REDIS_CACHE')
return app
.. code:: python
# manage.py
from application import create_app
app = create_app()
app.run()
Configuration
-------------
``Flask-Redis-Helper`` subclasses ``StrictRedis`` and adds the init_app() method for delayed initialization (for
applications that instantiate extensions in a separate file, but run init_app() in the same file Flask() was
instantiated).
The following config settings are searched for in the Flask application's configuration dictionary:
* ``REDIS_URL`` -- URL to Redis server. May be a network URL or Unix socket URL. Individual components may be overridden
by settings below (like setting REDIS_DB). URLs must start with redis://, file://, or redis+socket:// (Celery
compatibility). redis:// handles ambiguous URLs (like redis://localhost and redis://my_socket_file) by
prioritizing network URL interpretations over socket URLs. Use the file:// or redis+socket:// URL schemes to
force socket URL interpretations over network URLs.
* ``REDIS_SOCKET`` -- UNIX socket file path. If specified, disables REDIS_HOST and REDIS_PORT settings.
* ``REDIS_HOST`` -- the Redis server's hostname/IP. Default is localhost.
* ``REDIS_PORT`` -- TCP port number. Default is 6379.
* ``REDIS_PASSWORD`` -- password. Default is None.
* ``REDIS_DB`` -- DB instance (e.g. 1). Must be an integer. Default is 0.
Changelog
=========
This project adheres to `Semantic Versioning `_.
1.0.0 - 2014-12-22
------------------
Added
* Windows support.
Removed
* Dependency on ``six``.
0.1.3 - 2014-08-24
------------------
Added
* Support trailing slashes.
0.1.2 - 2014-08-10
------------------
Changed
* Minor code restructuring.
0.1.1 - 2014-07-14
------------------
Added
* Python 2.6 and 3.x support.
0.1.0 - 2014-06-01
------------------
* Initial release.