Skip to main content

OAuthlib authentication support for Aiohttp.

Project description

This project provides first-class OAuth library support for Aiohttp.

Installation

To install requests and async-oauthlib you can use pip:

$ pip install requests Async-OAuthlib

The OAuth 1 workflow

OAuth 1 can seem overly complicated and it sure has its quirks. Luckily, async_oauthlib hides most of these and let you focus at the task at hand.

Accessing protected resources using async_oauthlib is as simple as:

>>> from async_oauthlib import OAuth1Session
>>> twitter = OAuth1Session('client_key',
                            client_secret='client_secret',
                            resource_owner_key='resource_owner_key',
                            resource_owner_secret='resource_owner_secret')
>>> url = 'https://api.twitter.com/1/account/settings.json'
>>> r = twitter.get(url)

Before accessing resources you will need to obtain a few credentials from your provider (e.g. Twitter) and authorization from the user for whom you wish to retrieve resources for. You can read all about this in the full OAuth 1 workflow guide on RTD.

The OAuth 2 workflow

OAuth 2 is generally simpler than OAuth 1 but comes in more flavours. The most common being the Authorization Code Grant, also known as the WebApplication flow.

Fetching a protected resource after obtaining an access token can be extremely simple. However, before accessing resources you will need to obtain a few credentials from your provider (e.g. Google) and authorization from the user for whom you wish to retrieve resources for. You can read all about this in the full OAuth 2 workflow guide on RTD.

>>> from async_oauthlib import OAuth2Session
>>> target = OAuth2Session()
>>> response = await target.request()

History

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

Async-OAuthlib-0.0.9.tar.gz (533.9 kB view hashes)

Uploaded Source

Built Distribution

Async_OAuthlib-0.0.9-py2.py3-none-any.whl (21.1 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