Skip to main content

Doing the OAuth dance with style using Flask, requests, and oauthlib

Project description

Flask-Dance Build status Test coverage Documentation

Doing the OAuth dance with style using Flask, requests, and oauthlib. Currently, only OAuth consumers are supported, but this project could easily support OAuth providers in the future, as well. The full documentation for this project is hosted on ReadTheDocs, but this README will give you a taste of the features.

Flask-Dance currently provides pre-set OAuth configurations for the following popular websites:

  • Facebook

  • GitHub

  • Google

  • Twitter

  • JIRA

  • Dropbox

  • Meetup

  • Slack

  • Azure AD

Installation

Just the basics:

$ pip install Flask-Dance

Or if you’re planning on using the SQLAlchemy backend:

$ pip install Flask-Dance[sqla]

Quickstart

If you want your users to be able to log in to your app from any of the websites listed above, you’ve got it easy. Here’s an example using GitHub:

from flask import Flask, redirect, url_for
from werkzeug.contrib.fixers import ProxyFix
from flask_dance.contrib.github import make_github_blueprint, github

app = Flask(__name__)
app.wsgi_app = ProxyFix(app.wsgi_app)
app.secret_key = "supersekrit"
blueprint = make_github_blueprint(
    client_id="my-key-here",
    client_secret="my-secret-here",
)
app.register_blueprint(blueprint, url_prefix="/login")

@app.route("/")
def index():
    if not github.authorized:
        return redirect(url_for("github.login"))
    resp = github.get("/user")
    assert resp.ok
    return "You are @{login} on GitHub".format(login=resp.json()["login"])

if __name__ == "__main__":
    app.run()

If you’re itching to try it out, check out the flask-dance-github example repository, with detailed instructions for how to run this code.

The github object is a context local, just like flask.request. That means that you can import it in any Python file you want, and use it in the context of an incoming HTTP request. If you’ve split your Flask app up into multiple different files, feel free to import this object in any of your files, and use it just like you would use the requests module.

You can also use Flask-Dance with any OAuth provider you’d like, not just the pre-set configurations. See the documentation for how to use other OAuth providers.

Backends

By default, OAuth access tokens are stored in Flask’s session object. This means that if the user ever clears their browser cookies, they will have to go through the OAuth dance again, which is not good. You’re better off storing access tokens in a database or some other persistent store, and Flask-Dance has support for swapping out the storage backend. For example, if you’re using SQLAlchemy, just set it up like this:

from flask_sqlalchemy import SQLAlchemy
from flask_dance.consumer.backend.sqla import OAuthConsumerMixin, SQLAlchemyBackend

db = SQLAlchemy()

class User(db.Model):
    id = db.Column(db.Integer, primary_key=True)
    # ... other columns as needed

class OAuth(db.Model, OAuthConsumerMixin):
    user_id = db.Column(db.Integer, db.ForeignKey(User.id))
    user = db.relationship(User)

# get_current_user() is a function that returns the current logged in user
blueprint.backend = SQLAlchemyBackend(OAuth, db.session, user=get_current_user)

The SQLAlchemy backend seamlessly integrates with Flask-SQLAlchemy, as well as Flask-Login for user management, and Flask-Cache for caching.

Full Documentation

This README provides just a taste of what Flask-Dance is capable of. To see more, read the documentation on ReadTheDocs.

Project details


Download files

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

Source Distribution

Flask-Dance-0.10.1.tar.gz (1.1 MB view details)

Uploaded Source

Built Distributions

Flask_Dance-0.10.1-py2.py3-none-any.whl (32.3 kB view details)

Uploaded Python 2 Python 3

Flask_Dance-0.10.1-py2.7.egg (65.5 kB view details)

Uploaded Source

File details

Details for the file Flask-Dance-0.10.1.tar.gz.

File metadata

File hashes

Hashes for Flask-Dance-0.10.1.tar.gz
Algorithm Hash digest
SHA256 73b564f7fc91c6123ed564f921d4d25ee65fed9ca854502499e003980b3749a6
MD5 db81e1b83f27c5594e0b4cb8e74a520f
BLAKE2b-256 18843c0b00459c386439e458088ec783ad91add582c583d0f2b2c68de54894df

See more details on using hashes here.

Provenance

File details

Details for the file Flask_Dance-0.10.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for Flask_Dance-0.10.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 3992310e816b4c016429949168843383fd0fa0e41806ac9c26e5b15c2601e51c
MD5 2da4dbb1444a0751e248d9a05ddae25e
BLAKE2b-256 dde744676dc65bcc7de0941c443fc26db75bc066bc7020935c3e33f970e16b3f

See more details on using hashes here.

Provenance

File details

Details for the file Flask_Dance-0.10.1-py2.7.egg.

File metadata

File hashes

Hashes for Flask_Dance-0.10.1-py2.7.egg
Algorithm Hash digest
SHA256 50a3e38ea0e7e29c94f1f2caa6a80f8b10a2e8b92e4366658104e735e4956a3d
MD5 ce9bbc6d50e96f453a753e7e8cbc5a05
BLAKE2b-256 b1580cf7a57d1b11e65bf9f59e58bdece2cb162c5f2d7ceb25a1c75ce995777d

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page