{ "info": { "author": "Scott Crespo", "author_email": "sccrespo@gmail.com", "bugtrack_url": null, "classifiers": [], "description": "# CloeePy-Redis\nRedis Plugin for the CloeePy Framework\n\nAttaches a Redis connection to CloeePy application context.\n\n## Installation\n\n`pip install CloeePy-Redis`\n\n## Configuration\n\n### Configuration Basics\nCloeePy-Redis configuration must be placed under `CloeePy.Plugins.cloeepy_redis` in your config file.\nThe parameters are simply the available `Redis-Py.StrictRedis` connection parameters. For more\ninformation on possible configurations please see [Redis-Py's Documentation](http://redis-py.readthedocs.io/en/latest/)\n\n```\nCloeePy:\n ...\n Plugins:\n cloeepy_redis:\n host: localhost\n port: \"6379\"\n password: \"secret\"\n```\n\n### Customize Plugin Namespace\n\nBy default, your Redis connection is available on the CloeePy application context as\n`app.redis`. Optionally you can specify a different namespace by which you access\nthe redis connection via `pluginNamespace`.\n\n```\n...\nPlugins:\n cloeepy_redis:\n pluginNamespace: customRedisNS\n host: localhost\n port: \"6379\"\n password: \"secret\"\n\n```\n\nThen, you would access your Redis connection on the application context like so:\n\n```\napp = CloeePy()\nresult = app.customRedisNS.ping()\napp.log.info(result)\n```\n\n### Optional Environment Variables\n\nIt's best practice NOT to store sensitive data, such as database usernames and passwords,\nin plain-text configuration files. Thus, CloeePy-Redis supports configuring your\npassword via environment variable.\n\nYou need to set the following:\n\n- Password: `CLOEEPY_REDIS_PASSWORD`\n\nBy doing so, you can omit `password` in your configuration file.\n\n\n## Usage\n```\nimport os\nfrom cloeepy import CloeePy\n\nif __name__ == \"__main__\":\n # Required: set config path as environment variable\n os.environ[\"CLOEEPY_CONFIG_PATH\"] = \"./example-config.yml\"\n\n # instantiate application instance\n app = CloeePy()\n\n # Make Redis call and log to stdout\n app.log.info(app.redis.ping())\n```\n", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/cloeeai/CloeePy-Redis", "keywords": "mini framework cloee cloeepy redis", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "CloeePy-Redis", "package_url": "https://pypi.org/project/CloeePy-Redis/", "platform": "", "project_url": "https://pypi.org/project/CloeePy-Redis/", "project_urls": { "Homepage": "https://github.com/cloeeai/CloeePy-Redis" }, "release_url": "https://pypi.org/project/CloeePy-Redis/0.0.0/", "requires_dist": null, "requires_python": "", "summary": "Plugin for CloeePy Framework", "version": "0.0.0" }, "last_serial": 3622767, "releases": { "0.0.0": [ { "comment_text": "", "digests": { "md5": "012229ec48d666f8a0de7d1b5cf91112", "sha256": "71c9f96fe672b01347effc7709b1626ed9019a929003cfb6cd6740144c76535e" }, "downloads": -1, "filename": "CloeePy-Redis-0.0.0.tar.gz", "has_sig": false, "md5_digest": "012229ec48d666f8a0de7d1b5cf91112", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3653, "upload_time": "2018-02-27T19:22:06", "url": "https://files.pythonhosted.org/packages/a5/24/636d7d45521758a8d04d17189b48a2a781e63fe13ff482a30948b794c9c5/CloeePy-Redis-0.0.0.tar.gz" } ], "0.0.0-rc1": [ { "comment_text": "", "digests": { "md5": "cd69ff02150ecbf2d19877a9e86c9172", "sha256": "f6e7b4ad11e1b8bba6707343b62ba32a3e16183c64917cdf6b82af33b671ed0f" }, "downloads": -1, "filename": "CloeePy-Redis-0.0.0-rc1.tar.gz", "has_sig": false, "md5_digest": "cd69ff02150ecbf2d19877a9e86c9172", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3661, "upload_time": "2018-02-27T19:15:55", "url": "https://files.pythonhosted.org/packages/da/6f/1d52d09390188f7320df119854dc27abfd1d0f300f60c1ee6bb560383ee8/CloeePy-Redis-0.0.0-rc1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "012229ec48d666f8a0de7d1b5cf91112", "sha256": "71c9f96fe672b01347effc7709b1626ed9019a929003cfb6cd6740144c76535e" }, "downloads": -1, "filename": "CloeePy-Redis-0.0.0.tar.gz", "has_sig": false, "md5_digest": "012229ec48d666f8a0de7d1b5cf91112", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3653, "upload_time": "2018-02-27T19:22:06", "url": "https://files.pythonhosted.org/packages/a5/24/636d7d45521758a8d04d17189b48a2a781e63fe13ff482a30948b794c9c5/CloeePy-Redis-0.0.0.tar.gz" } ] }