Skip to main content

No project description provided

Project description

Simple OAuth library to work with sanic. Basically, just rewrited version of aioauth_client with async/await syntax and some optimization. Can be used only with python 3.5/3.6.

Available providers (in alphabetic order):

  • Amazon

  • BitBucket

  • BitBucket v2

  • Discord (thanks to @smlbiobot)

  • Eventbrite

  • Facebook

  • Flickr

  • Foursquare

  • Github

  • GitLab

  • Google

  • LinkedIn

  • Meetup

  • ok.ru

  • Pinterest

  • Plurk

  • Tumblr

  • Twitter

  • Vimeo

  • vk.com

  • Yahoo

  • Yandex

Requirements

  • python >= 3.6

Installation

Just install via pip:

pip install sanic_oauth

Note, that to use blueprint correctly, you need to additionally install sanic and sanic-session.

Usage

Simple way for use this is blueprint with oauth configuration.

But, before use it you need to:

  1. Create aiohttp.ClientSession and bind to app like async_session variable.

  2. Create session interface from sanic-session package and bind it to app like session_interface variable.

  3. Configure app.config settings. You should pass OAUTH_PROVIDER, OAUTH_REDIRECT_URI, OAUTH_SCOPE and another settings, for example, OAUTH_CLIENT_ID, OAUTH_CLIENT_SECRET. Every setting with OAUTH prefix will be passed to oauth provider construction.

  4. Apply blueprint

  5. Add decorator login_required to routes, that required oauth.

You can see example for more details.

Advanced usage

If you don’t like current blueprint, you always can use providers directly and implements you own logic, like in old_example.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

sanic_oauth-0.2.1-py2.py3-none-any.whl (13.2 kB view hashes)

Uploaded Python 2 Python 3

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