Metadata-Version: 1.1
Name: Flask-Redis
Version: 0.0.5
Summary: Redis Extension for Flask Applications
Home-page: http://github.com/rhyselsmore/flask-redis
Author: Rhys Elsmore
Author-email: me@rhys.io
License: Copyright 2013 Rhys Elsmore

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
Description: Flask-Redis
        ===========
        
        
        .. image:: https://travis-ci.org/rhyselsmore/flask-redis.png?branch=master
                :target: https://travis-ci.org/rhyselsmore/flask-redis
        
        .. image:: https://pypip.in/d/Flask-Redis/badge.png
                :target: https://crate.io/packages/Flask-Redis/
        
        Add Redis Support to Flask.
        
        Built on top of `redis-py <https://github.com/andymccurdy/redis-py>`_.
        
        Currently a single namespace within the configuration is supported.
        
        .. code-block:: python
        
            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
        
        .. code-block:: python
        
            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
        ------------
        
        .. code-block:: bash
        
            pip install flask-redis
        
        Or if you *must* use easy_install:
        
        .. code-block:: bash
        
            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
        
        .. code-block:: python
        
            REDIS_URL = "redis://:password@localhost:6379/0"
        
        or you are able to declare the following
        
        .. code-block:: python
        
            REDIS_HOST = "localhost"
            REDIS_PASSWORD = "password"
            REDIS_PORT = 6379
            REDIS_DATABASE = 5
        
        To create the redis instance within your application
        
        .. code-block:: python
        
            from flask import Flask
            from flask_redis import Redis
        
            app = Flask(__name__)
            redis_store = Redis(app)
        
        or
        
        .. code-block:: python
        
            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
        -----
        
        .. code-block:: python
        
            from core import redis_store
        
            @app.route('/')
            def index():
                return redis_store.get('potato','Not Set')
        
        **Protip:** The `redis-py <https://github.com/andymccurdy/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 <https://github.com/andymccurdy/redis-py>`_ documentation.
        
        Advanced features, such as Lua scripting, pipelines and callbacks are detailed within the projects README.
        
        Contribute
        ----------
        
        #. 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.
        #. Fork `the repository`_ on Github to start making your changes to the **master** branch (or branch off of it).
        #. Write a test which shows that the bug was fixed or that the feature works as expected.
        #. Send a pull request and bug the maintainer until it gets merged and published.
        
        .. _`the repository`: http://github.com/rhyselsmore/flask-redis
        
        History
        =======
        
        0.0.5 (17/2/2014)
        ----------------
        
        - Improved support for the config prefix.
        
        0.0.4 (17/2/2014)
        ----------------
        
        - Added support for config_prefix, allowing multiple DBs.
        
        0.0.3 (6/7/2013)
        ----------------
        
        - Added TravisCI Testing for Flask 0.9/0.10.
        - Added Badges to README.
        
        0.0.2 (6/7/2013)
        ----------------
        
        - Implemented a very simple test.
        - Fixed some documentation issues.
        - Included requirements.txt for testing.
        - Included task file including some basic methods for tests.
        
        0.0.1 (5/7/2013)
        ----------------
        
        - Conception
        - Initial Commit of Package to GitHub.
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Software Development :: Libraries :: Python Modules
