Flask-ObjectRocket
==================
A Flask / Flask-RESTful extension implementing support for user authentication with the ObjectRocket API.
#### install
This package is distributed on pypi. You can install it via pip:
```bash
pip install flask-objectrocket
```
#### configuration & usage
Configure this extension as you would any other Flask extension:
```python
from flask import Flask
from flask.ext.objectrocket import ObjectRocket
app = Flask(__name__)
app.config.from_pyfile('app-config.cfg')
# Initialize the extension with init_app.
objectrocket = ObjectRocket()
objectrocket.init_app(app)
# Or initialize the extension directly.
objectrocket = ObjectRocket(app)
```
The following Flask configuration attributes are available for this extension:
```python
# The ObjectRocket APIv2 URL (you should never have to change this).
OBJECTROCKET_BASE_URL = None
# Bind the authenticated user object to flask.g.user for request duration.
OBJECTROCKET_BIND_USER = True
# Cache the authenticated user's instances to flask.g.instances for request duration.
OBJECTROCKET_BIND_INSTANCES = True
```
Now that the extension is initialized, use it with [Flask-RESTful](http://flask-restful.readthedocs.org/en/latest/):
```python
from flask.ext.objectrocket import ObjectRocketResource
class MyResource(ObjectRocketResource):
"""All of this resource's handlers are now protected with ObjectRocket token authentication."""
def get(self):
...
def post(self):
...
```
If 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.
#### tests
`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.
#### license
Flask-ObjectRocket is distributed under MIT license, see `LICENSE` for more details.
Metadata
Release files for Flask-ObjectRocket 0.2.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| Flask_ObjectRocket-0.2.1-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details for Flask_ObjectRocket-0.2.1-py2.py3-none-any.whl |
Release files / Flask_ObjectRocket-0.2.1-py2.py3-none-any.whl
| Download URL | Flask_ObjectRocket-0.2.1-py2.py3-none-any.whl |
|---|---|
| Size | 5.7 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
22bf42a7d43c91ab3bfe75215a370cb78ac979d6c416a30b3fc3d527a6e56c05
|
|
BLAKE2b-256 checksum How to use checksums |
ff02778d89e3c9f4e800aeaa637a11dff0b574ade8d0fc96065545c59a1cf126
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for Flask-ObjectRocket 0.2.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.