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, including the full list of supported OAuth providers, but this README will give you a taste of the features.

Installation

Just the basics:

$ pip install Flask-Dance

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

$ pip install Flask-Dance[sqla]

Quickstart

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

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

app = Flask(__name__)
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 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.

Storages

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 token storage. For example, if you’re using SQLAlchemy, set it up like this:

from flask_sqlalchemy import SQLAlchemy
from flask_dance.consumer.storage.sqla import OAuthConsumerMixin, SQLAlchemyStorage

db = SQLAlchemy()

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

class OAuth(OAuthConsumerMixin, db.Model):
    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.storage = SQLAlchemyStorage(OAuth, db.session, user=get_current_user)

The SQLAlchemy storage seamlessly integrates with Flask-SQLAlchemy, as well as Flask-Login for user management, and Flask-Caching 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-3.1.0.tar.gz (1.4 MB view details)

Uploaded Source

Built Distributions

Flask_Dance-3.1.0-py3.8.egg (116.5 kB view details)

Uploaded Source

Flask_Dance-3.1.0-py2.py3-none-any.whl (52.2 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: Flask-Dance-3.1.0.tar.gz
  • Upload date:
  • Size: 1.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Python-urllib/3.8

File hashes

Hashes for Flask-Dance-3.1.0.tar.gz
Algorithm Hash digest
SHA256 d240f2509db7a9e95482dc4ba79ad1ffc631ec993da99bdfe9988cfe5b816734
MD5 9380a6f958795d2604024e596a80994e
BLAKE2b-256 668108ba19da7a4661bccac43604e49ad258c67d05fc0b32ac3e9a8e7c268afc

See more details on using hashes here.

Provenance

File details

Details for the file Flask_Dance-3.1.0-py3.8.egg.

File metadata

  • Download URL: Flask_Dance-3.1.0-py3.8.egg
  • Upload date:
  • Size: 116.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Python-urllib/3.8

File hashes

Hashes for Flask_Dance-3.1.0-py3.8.egg
Algorithm Hash digest
SHA256 b4603d19f49ea820d05b133ecfc16e664cd5fe8dba6dbf4ae40bfe91503ae33a
MD5 53f4c56983e8ffcc318c5523f3c9199f
BLAKE2b-256 601f9b068c9c24f443e6d23d76ae76686b34e99368624c07a2d637fbb5b07e5f

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for Flask_Dance-3.1.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 6fc8b53994de627981b7c1073144604279f1f71003a20aa26b2defdc7d3d8772
MD5 16220eb7bd010e7d7f323b8d16339a23
BLAKE2b-256 32b8b3a0e1c6b069cc302487a4cece0bf7aeae9deec62079a476c17badb30c6c

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