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

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.8.3.tar.gz (99.5 kB view details)

Uploaded Source

Built Distributions

Flask_Dance-0.8.3-py2.py3-none-any.whl (30.2 kB view details)

Uploaded Python 2 Python 3

Flask_Dance-0.8.3-py2.7.egg (60.4 kB view details)

Uploaded Source

File details

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

File metadata

  • Download URL: Flask-Dance-0.8.3.tar.gz
  • Upload date:
  • Size: 99.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for Flask-Dance-0.8.3.tar.gz
Algorithm Hash digest
SHA256 48ff475f85a32777c2a9e0500416f607627cb22f3b8e84f9db4db3193e06a31d
MD5 ac45fa15f0cdb87cc8ef5414eda029b9
BLAKE2b-256 c334a044aff95f7444e38c8db695b6c88d0afdd9b2308f24ec9aa8a93df47a6e

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for Flask_Dance-0.8.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 9d412f23ffe2e27c9aad8042907bf9bc2a0ba618edd3e4d9bc355ccb64c6fa5e
MD5 ef88b71c171025de3dd8d7fd5eff5520
BLAKE2b-256 bde7efce82b26ba030b27126fcacda1955e30d1522678c089d1b949902fcf484

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for Flask_Dance-0.8.3-py2.7.egg
Algorithm Hash digest
SHA256 6f626aa461bd9f87075a60dd774d5975190590bd1f632d2eea67f2889528462b
MD5 7d76b075baec8e9f8412619147a856e2
BLAKE2b-256 7d05dbc7ac7c3a53277bba980a37b14b33fd8ff45639b8035b249c7e585258cb

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