Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

User authentication with the ObjectRocket API.

Project 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)

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.
Release History

Release History

This version
History Node

0.2.1

History Node

0.2.0

History Node

0.1.0

Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
Flask_ObjectRocket-0.2.1-py2.py3-none-any.whl (5.7 kB) Copy SHA256 Checksum SHA256 py2.py3 Wheel Apr 6, 2016

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting