Metadata-Version: 1.1
Name: Flask-Redis-Helper
Version: 1.0.0
Summary: Redis support for Flask without breaking PyCharm inspections.
Home-page: https://github.com/Robpol86/Flask-Redis-Helper
Author: @Robpol86
Author-email: robpol86@gmail.com
License: MIT
Description: 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, 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).
        
        .. image:: https://img.shields.io/appveyor/ci/Robpol86/Flask-Redis-Helper.svg?style=flat-square
           :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
           :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
           :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
           :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
           :target: https://pypi.python.org/pypi/Flask-Redis-Helper/
           :alt: Downloads
        
        Attribution
        -----------
        
        Inspired by `Flask-SQLAlchemy <http://pythonhosted.org/Flask-SQLAlchemy/>`_ and
        `Flask-And-Redis <https://github.com/playpauseandstop/Flask-And-Redis>`_.
        
        Supported Platforms
        -------------------
        
        * OSX and Linux.
        * Python 2.6, 2.7, 3.3, 3.4
        * `Flask <http://flask.pocoo.org/>`_ 0.10.1
        * `Redis <http://redis.io/>`_ 2.9.1
        * `Celery <http://www.celeryproject.org/>`_ 3.1.11
        
        Quickstart
        ----------
        
        Install:
        
        .. code:: bash
        
            pip install Flask-Redis-Helper
        
        
        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
        ---------
        
        1.0.0
        `````
        
        * Windows support.
        * Removed dependency on ``six``.
        
        0.1.3
        `````
        
        * Support trailing slashes.
        
        0.1.2
        `````
        
        * Minor code restructuring.
        
        0.1.1
        `````
        
        * Added Python 2.6 and 3.x support.
        
        0.1.0
        `````
        
        * Initial release.
        
Keywords: flask celery redis
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Framework :: Flask
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Topic :: Software Development :: Libraries
