{"id":15187618,"url":"https://github.com/robpol86/flask-redis-helper","last_synced_at":"2025-10-02T02:31:32.727Z","repository":{"id":17563362,"uuid":"20366714","full_name":"Robpol86/Flask-Redis-Helper","owner":"Robpol86","description":"Redis support for Flask without breaking PyCharm inspections.","archived":true,"fork":false,"pushed_at":"2015-06-05T02:53:55.000Z","size":265,"stargazers_count":6,"open_issues_count":1,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-20T16:35:39.474Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Robpol86.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-05-31T22:53:36.000Z","updated_at":"2023-01-28T11:30:29.000Z","dependencies_parsed_at":"2022-09-11T03:10:59.963Z","dependency_job_id":null,"html_url":"https://github.com/Robpol86/Flask-Redis-Helper","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Robpol86%2FFlask-Redis-Helper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Robpol86%2FFlask-Redis-Helper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Robpol86%2FFlask-Redis-Helper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Robpol86%2FFlask-Redis-Helper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Robpol86","download_url":"https://codeload.github.com/Robpol86/Flask-Redis-Helper/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":234929139,"owners_count":18908881,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-09-27T18:40:57.874Z","updated_at":"2025-10-02T02:31:32.451Z","avatar_url":"https://github.com/Robpol86.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"==================\nFlask-Redis-Helper\n==================\n\nYet another Redis extension for Flask. ``Flask-Redis-Helper`` doesn't break PyCharm autocomplete/inspections and handles\nthe Flask application context the same way SQLAlchemy does.\n\n* Python 2.6, 2.7, PyPy, PyPy3, 3.3, and 3.4 supported on Linux and OS X.\n* Python 2.7, 3.3, and 3.4 supported on Windows (both 32 and 64 bit versions of Python).\n\nTested on Windows XP and Windows 10 technical preview.\n\n.. image:: https://img.shields.io/appveyor/ci/Robpol86/Flask-Redis-Helper/master.svg?style=flat-square\u0026label=AppVeyor%20CI\n   :target: https://ci.appveyor.com/project/Robpol86/Flask-Redis-Helper\n   :alt: Build Status Windows\n\n.. image:: https://img.shields.io/travis/Robpol86/Flask-Redis-Helper/master.svg?style=flat-square\u0026label=Travis%20CI\n   :target: https://travis-ci.org/Robpol86/Flask-Redis-Helper\n   :alt: Build Status\n\n.. image:: https://img.shields.io/codecov/c/github/Robpol86/Flask-Redis-Helper/master.svg?style=flat-square\u0026label=Codecov\n   :target: https://codecov.io/github/Robpol86/Flask-Redis-Helper\n   :alt: Coverage Status\n\n.. image:: https://img.shields.io/pypi/v/Flask-Redis-Helper.svg?style=flat-square\u0026label=Latest\n   :target: https://pypi.python.org/pypi/Flask-Redis-Helper/\n   :alt: Latest Version\n\n.. image:: https://img.shields.io/pypi/dm/Flask-Redis-Helper.svg?style=flat-square\u0026label=PyPI%20Downloads\n   :target: https://pypi.python.org/pypi/Flask-Redis-Helper/\n   :alt: Downloads\n\nAttribution\n===========\n\nInspired by `Flask-SQLAlchemy \u003chttp://pythonhosted.org/Flask-SQLAlchemy/\u003e`_ and\n`Flask-And-Redis \u003chttps://github.com/playpauseandstop/Flask-And-Redis\u003e`_.\n\nSupported Libraries\n===================\n\n* `Flask \u003chttp://flask.pocoo.org/\u003e`_ 0.10.1\n* `Redis \u003chttp://redis.io/\u003e`_ 2.9.1\n* `Celery \u003chttp://www.celeryproject.org/\u003e`_ 3.1.11\n\nQuickstart\n==========\n\nInstall:\n\n.. code:: bash\n\n    pip install Flask-Redis-Helper\n\nExamples\n========\n\nBasic Example\n-------------\n\n.. code:: python\n\n    from flask import Flask\n    from flask.ext.redis import Redis\n\n    app = Flask(__name__)\n    app.config['REDIS_URL'] = 'redis://localhost'\n    redis = Redis(app)\n\nFactory Example\n---------------\n\n.. code:: python\n\n    # extensions.py\n    from flask.ext.redis import Redis\n\n    redis = Redis()\n    redis_cache = Redis()\n\n.. code:: python\n\n    # application.py\n    from flask import Flask\n    from extensions import redis, redis_cache\n\n    def create_app():\n        app = Flask(__name__)\n        app.config['REDIS_URL'] = 'redis://localhost/0'\n        app.config['REDIS_CACHE_URL'] = 'redis://localhost/1'\n        redis.init_app(app)\n        redis_cache.init_app(app, config_prefix='REDIS_CACHE')\n        return app\n\n.. code:: python\n\n    # manage.py\n    from application import create_app\n\n    app = create_app()\n    app.run()\n\nConfiguration\n-------------\n\n``Flask-Redis-Helper`` subclasses ``StrictRedis`` and adds the init_app() method for delayed initialization (for\napplications that instantiate extensions in a separate file, but run init_app() in the same file Flask() was\ninstantiated).\n\nThe following config settings are searched for in the Flask application's configuration dictionary:\n\n* ``REDIS_URL`` -- URL to Redis server. May be a network URL or Unix socket URL. Individual components may be overridden\n  by settings below (like setting REDIS_DB). URLs must start with redis://, file://, or redis+socket:// (Celery\n  compatibility). redis:// handles ambiguous URLs (like redis://localhost and redis://my_socket_file) by\n  prioritizing network URL interpretations over socket URLs. Use the file:// or redis+socket:// URL schemes to\n  force socket URL interpretations over network URLs.\n\n* ``REDIS_SOCKET`` -- UNIX socket file path. If specified, disables REDIS_HOST and REDIS_PORT settings.\n* ``REDIS_HOST`` -- the Redis server's hostname/IP. Default is localhost.\n* ``REDIS_PORT`` -- TCP port number. Default is 6379.\n* ``REDIS_PASSWORD`` -- password. Default is None.\n* ``REDIS_DB`` -- DB instance (e.g. 1). Must be an integer. Default is 0.\n\nChangelog\n=========\n\nThis project adheres to `Semantic Versioning \u003chttp://semver.org/\u003e`_.\n\n1.0.0 - 2014-12-22\n------------------\n\nAdded\n    * Windows support.\n\nRemoved\n    * Dependency on ``six``.\n\n0.1.3 - 2014-08-24\n------------------\n\nAdded\n    * Support trailing slashes.\n\n0.1.2 - 2014-08-10\n------------------\n\nChanged\n    * Minor code restructuring.\n\n0.1.1 - 2014-07-14\n------------------\n\nAdded\n    * Python 2.6 and 3.x support.\n\n0.1.0 - 2014-06-01\n------------------\n\n* Initial release.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frobpol86%2Fflask-redis-helper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frobpol86%2Fflask-redis-helper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frobpol86%2Fflask-redis-helper/lists"}