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

Uploaded Source

Built Distributions

Flask_Dance-3.3.1-py2.py3-none-any.whl (55.7 kB view details)

Uploaded Python 2 Python 3

Flask_Dance-3.3.1-py2.7.egg (123.0 kB view details)

Uploaded Source

File details

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

File metadata

  • Download URL: Flask-Dance-3.3.1.tar.gz
  • Upload date:
  • Size: 131.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.6.1 requests/2.25.1 setuptools/51.0.0 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.9.2

File hashes

Hashes for Flask-Dance-3.3.1.tar.gz
Algorithm Hash digest
SHA256 6a570e051fe40148698080c65b815704641bf05091fbb9becae549b8d8e1e33b
MD5 8ef28f70638a03f34c0ad4c8ea47818e
BLAKE2b-256 b3c51287e459d80aa57c73f4e015ca6fc3148af332df272f7c04af106329b93a

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: Flask_Dance-3.3.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 55.7 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.6.1 requests/2.25.1 setuptools/51.0.0 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.9.2

File hashes

Hashes for Flask_Dance-3.3.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 cd2955a46cf3b72ff9b0b5a6521df5aed05dd5189eb312a5d27a9e2e4983ce29
MD5 038c8d6c875415152ad49f32e52c7b9f
BLAKE2b-256 dc19326c399eb907bf46ebf6dda57352378176d852d1cb3edc8c277aa7e32e4e

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: Flask_Dance-3.3.1-py2.7.egg
  • Upload date:
  • Size: 123.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.6.1 requests/2.25.1 setuptools/51.0.0 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.9.2

File hashes

Hashes for Flask_Dance-3.3.1-py2.7.egg
Algorithm Hash digest
SHA256 4a0fbfc6c2f9356d8d1dda9c91fa1359d641324e597d8097b7f39a441561f4d6
MD5 d2c8aae65780ad229408ac31cd877ff6
BLAKE2b-256 cab5197259ccbb4a56559a959b6856708fac404e2099d477625aa25f0a2cea11

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