README.md

Basic OAuth 2.0 Support for Web.py

Implement basic OAuth 2.0 support for web.py. Inspired by simpleauth.

Supported providers:

• Google (OAuth 2.0)

  • Doc:

    • Using OAuth 2.0 for Web Server Applications

    • Using OAuth 2.0 for Login

  • Create App & Get client ID/Secret:

    • Google Cloud Console

  • Scopes:

    • https://www.googleapis.com/auth/userinfo.profile: Userinfo - Profile

    • https://www.googleapis.com/auth/userinfo.email: Userinfo - Email

    • Reference: List of Google OAuth Scopes

• Facebook (OAuth 2.0)

  • Doc:

    • The Login Flow for Web (without JavaScript SDK)

  • Create App & Get client ID/Secret:

    • Facebook Developers

  • Scopes:

    • email: Provides access to the primary email address of the user in the email property.

    • user_about_me: Provides access to the "About Me" section of the profile in the about property

    • Reference: Permissions

Dependency

• Web.py: see Web.py Install Guide to install web.py.

Usage & Example

1. Create app & get client id/secret from providers. (Google: Google Cloud Console, Facebook: Facebook Developers)

2. Put auth.py in your project root dir, and also add your project root dir to sys path. auth.py handles OAuth 2.0 process for you, and you do not need to modify this script.

3. In you main python script, create a request handler by subclassing auth.handler. Set url routing and client id/secret. Please refer to login.py for a complete example.

4. You can run the example (remember to modify app id/secret and callback_uri function in the exmaple) by the following bash command:

$ python login.py

References

• SimpleAuth

• Facebook login on top of webpy

• Facebook OAuth Example

Other

This project is released in public domain, see UNLICENSE