simple-flask-google-login 0.3.0

Convenience utility for implementing Google login with Flask.

Simple Flask Google Login

Written by Alvin Wan for educational purposes. See the accompanying tutorial on How third-party login works.

Convenience utility for implementing Google login with Flask.

This is more useful as a template than as an installable library. Either way, it's an easy way to get up and running with Google login without much work.

Get Started

Install the utility with pip.

pip install simple-flask-google-login

Initialize the utility's manager with the Flask app.

from simple_flask_google_login import SimpleFlaskGoogleLogin

SimpleFlaskGoogleLogin(app)

Alternatively, initialize with the app after construction.

manager = SimpleFlaskGoogleLogin()
manager.init_app(app)

Note that you need 4 prerequisites in order for this to work:

1. Client Credentials: This application by default expects client_secrets.json to be in the same directory as the application. This is the file downloaded from the Google developers console. You can change this by passing the client_secrets_path argument to the SimpleFlaskGoogleLogin constructor.
2. https: You must use SSL. Simply add app.run(ssl_context='adhoc', ...).
3. Secret Key: Your app must have a secret key set.
4. Accepted Redirect URI: On the Google developer console, your Oauth2 client must list the redirect URI https://127.0.0.1:5000 as an accepted redirect URI. This is the default redirect URI. You can change this by passing the redirect_uri argument to the SimpleFlaskGoogleLogin constructor.

Here's a minimal example with all of these elements.

from flask import Flask, session
from simple_flask_google_login import SimpleFlaskGoogleLogin


app = Flask("Google Login App")
app.secret_key = "YourSecretKeyHere"  # Secret key is needed for OAuth 2.0
SimpleFlaskGoogleLogin(app)


@app.route("/")
def index():
    if 'name' in session:
        return f"Hello {session['name']}! <a href='/logout'>Logout</a>"
    return "<a href='/login'>Login</a>"


if __name__ == "__main__":
    app.run(ssl_context='adhoc')

And you're done! This is all you need. Now, load the /login URL for your application to start the login flow. Load the /logout URL to logout. For a minimal example, see the examples/ directory.

Advanced user? Keep reading. Here are several customizations you can make with this utility out of the box.

Advanced: Customize Google Login

You can change any of the usual Google login configurations:

• Client secrets path: This should be a JSON downloaded from the OAuth2 client in your Google developers console. The file will contain both a client ID and a secret.
• Scopes: This is the list of scopes that your application is requesting access to. By default, the application only requests "basic" information such as name and email address.
• Redirect URI: This is the URI that Google will send a GET request to, with the login code attached to it. This must be an https URL -- no IP addresses or custom URL protocols (i.e., deeplinks). By default, this is your application's login callback page.

manager = SimpleFlaskGoogleLogin(
    client_secrets_path='/path/to/client_secrets.json',
    scopes=['profile', 'email'],
    redirect_uri='https://example.com/login/callback'
)

Advanced: Customize routes

You can rename any of the routes. For example, say you want to use /login for a general login page with several options. You could then redefine these routes to be /google/login, for example.

manager = SimpleFlaskGoogleLogin()
manager.init_app(app, login_endpoint='/google/login')
# creates a login route at `/google/login`

You can add custom handlers to all of the endpoints, to customize different behaviors. For example, open a new browser with the authorization URL, instead of opening in the current tab.

import webbrowser

def handler(authorization_url):
    webbrowser.open(authorization_url)
    return f"If redirect fails, click <a href='{authorization_url}'>here</a>."

manager = SimpleFlaskGoogleLogin(authorization_url_handler=handler)

Finally, you can ask the manager to completely skip an endpoint and write one from scratch, by "naming" the endpoint None.

manager = SimpleFlaskGoogleLogin()
manager.init_app(app, login_endpoint=None)

Why create this?

My previous favorite Flask-GoogleLogin is now deprecated, and I'm too lazy to relearn oauth2 every time I want to support Google login. This library is at least quick starter code. Granted, there are many other implementations, but I wanted a super barebones one -- not one mixed and matched with SQL and flask-login and a slew of other random libraries.