Installation

pip install flask-heroku-auth

Configuration

To enable regex routes within your application

from flask import Flask
from flask_heroku_auth import HerokuAuth

app = Flask(__name__)
HerokuAuth(app)

or

from flask import Flask
from flask_heroku_auth import HerokuAuth

auth = HerokuAuth()

def create_app():
    app = Flask(__name__)
    auth.init_app(app)
    return app

From here, it is a matter of decorating the appropriate routes.

For example, the following would implement authentication via the Heroku OAuth facility

@app.route('/')
@auth.oauth
def index():
    return "Ok"

On the other hand, you may wish to authenticate via the Heroku API Key facility. In this case, the credentials are sent through with every request as an ‘Authorization’ header

@app.route('/')
@auth.api
def index():
    return "Ok"

You can also restrict access to a Heroku user who has an @heroku.com email address.

@app.route('/')
@auth.oauth
@auth.herokai_only
def index():
    return "Ok"

0.0.5 (14/11/2012)

• Introduced a template filter for the current user.

0.0.4 (1/11/2012)

• Minor Tweaks.

0.0.3 (16/09/2012)

• User field is now not required for sudo operations.

0.0.2 (24/08/2012)

• Checking for ‘herokai_only’ now occurs only if the user is logged in.

0.0.1 (24/08/2012)

• Conception

• Initial Commit of Package to GitHub.