{ "info": { "author": "Anthony Josiah Dodd", "author_email": "dodd.anthonyjosiah@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Environment :: Web Environment", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Natural Language :: English", "Operating System :: OS Independent", "Programming Language :: Python", "Topic :: Internet :: WWW/HTTP :: Dynamic Content", "Topic :: Software Development :: Libraries :: Python Modules" ], "description": "[![Circle CI](https://circleci.com/gh/objectrocket/Flask-ObjectRocket.svg?style=svg)](https://circleci.com/gh/objectrocket/Flask-ObjectRocket) [![codecov.io](https://codecov.io/github/objectrocket/Flask-ObjectRocket/coverage.svg?branch=master)](https://codecov.io/github/objectrocket/Flask-ObjectRocket?branch=master) [![Coverage Status](https://coveralls.io/repos/github/objectrocket/Flask-ObjectRocket/badge.svg?branch=master)](https://coveralls.io/github/objectrocket/Flask-ObjectRocket?branch=master)\n\nFlask-ObjectRocket\n==================\nA Flask / Flask-RESTful extension implementing support for user authentication with the ObjectRocket API.\n\n#### install\nThis package is distributed on pypi. You can install it via pip:\n```bash\npip install flask-objectrocket\n```\n\n#### configuration & usage\nConfigure this extension as you would any other Flask extension:\n\n```python\nfrom flask import Flask\nfrom flask.ext.objectrocket import ObjectRocket\n\napp = Flask(__name__)\napp.config.from_pyfile('app-config.cfg')\n\n# Initialize the extension with init_app.\nobjectrocket = ObjectRocket()\nobjectrocket.init_app(app)\n\n# Or initialize the extension directly.\nobjectrocket = ObjectRocket(app)\n```\n\nThe following Flask configuration attributes are available for this extension:\n```python\n# The ObjectRocket APIv2 URL (you should never have to change this).\nOBJECTROCKET_BASE_URL = None\n# Bind the authenticated user object to flask.g.user for request duration.\nOBJECTROCKET_BIND_USER = True\n# Cache the authenticated user's instances to flask.g.instances for request duration.\nOBJECTROCKET_BIND_INSTANCES = True\n```\n\nNow that the extension is initialized, use it with [Flask-RESTful](http://flask-restful.readthedocs.org/en/latest/):\n\n```python\nfrom flask.ext.objectrocket import ObjectRocketResource\n\nclass MyResource(ObjectRocketResource):\n \"\"\"All of this resource's handlers are now protected with ObjectRocket token authentication.\"\"\"\n\n def get(self):\n ...\n\n def post(self):\n ...\n```\n\nIf you are not using Flask-RESTful, you can also use the [objectrocket_authentication](https://github.com/objectrocket/Flask-ObjectRocket/blob/master/flask_objectrocket.py) decorator and the [ObjectRocketUser](https://github.com/objectrocket/Flask-ObjectRocket/blob/master/flask_objectrocket.py) class directly.\n\n#### tests\n`tox` should get you where you need to be. As of this writing, test coverage is at `100%`. It is a good idea to keep it that way.\n\n#### license\nFlask-ObjectRocket is distributed under MIT license, see `LICENSE` for more details.", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/objectrocket/flask-objectrocket", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "Flask-ObjectRocket", "package_url": "https://pypi.org/project/Flask-ObjectRocket/", "platform": "any", "project_url": "https://pypi.org/project/Flask-ObjectRocket/", "project_urls": { "Homepage": "https://github.com/objectrocket/flask-objectrocket" }, "release_url": "https://pypi.org/project/Flask-ObjectRocket/0.2.1/", "requires_dist": [ "Flask-RESTful (>=0.3,<1.0)", "objectrocket (>=0.4,<1.0)" ], "requires_python": "", "summary": "User authentication with the ObjectRocket API.", "version": "0.2.1" }, "last_serial": 2049316, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "01d58772beb169cb8aa616b111ddb8c0", "sha256": "fb21b22c3228db8928c4444828c1695c58d40212afb149157817875e776532a8" }, "downloads": -1, "filename": "Flask_ObjectRocket-0.1.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "01d58772beb169cb8aa616b111ddb8c0", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 3433, "upload_time": "2016-02-20T02:14:40", "url": "https://files.pythonhosted.org/packages/95/83/08667b3b39a00cf8f32b3438aec626bcdb4cee3109b5b6e0de0bf821143f/Flask_ObjectRocket-0.1.0-py2.py3-none-any.whl" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "a75b84619bccccc229ccd3e43997ab7b", "sha256": "7c4327ba557dba1446333d72460a7f7f11e893d54f38a288d1c28a1beacab732" }, "downloads": -1, "filename": "Flask_ObjectRocket-0.2.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "a75b84619bccccc229ccd3e43997ab7b", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 3863, "upload_time": "2016-02-20T06:07:50", "url": "https://files.pythonhosted.org/packages/76/e0/6edf6e2c3d8b3449f4b338ceaf578d93ec3a44cd1ac51479e4ff8cb7dc0c/Flask_ObjectRocket-0.2.0-py2.py3-none-any.whl" } ], "0.2.1": [ { "comment_text": "", "digests": { "md5": "8b5e0ed3933abcd1831baa3e8547a120", "sha256": "22bf42a7d43c91ab3bfe75215a370cb78ac979d6c416a30b3fc3d527a6e56c05" }, "downloads": -1, "filename": "Flask_ObjectRocket-0.2.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "8b5e0ed3933abcd1831baa3e8547a120", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 5718, "upload_time": "2016-04-06T15:02:24", "url": "https://files.pythonhosted.org/packages/ff/02/778d89e3c9f4e800aeaa637a11dff0b574ade8d0fc96065545c59a1cf126/Flask_ObjectRocket-0.2.1-py2.py3-none-any.whl" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "8b5e0ed3933abcd1831baa3e8547a120", "sha256": "22bf42a7d43c91ab3bfe75215a370cb78ac979d6c416a30b3fc3d527a6e56c05" }, "downloads": -1, "filename": "Flask_ObjectRocket-0.2.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "8b5e0ed3933abcd1831baa3e8547a120", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 5718, "upload_time": "2016-04-06T15:02:24", "url": "https://files.pythonhosted.org/packages/ff/02/778d89e3c9f4e800aeaa637a11dff0b574ade8d0fc96065545c59a1cf126/Flask_ObjectRocket-0.2.1-py2.py3-none-any.whl" } ] }