Skip to content

requests/requests-oauthlib

Folders and files

NameName
Last commit message
Last commit date
Mar 22, 2024
Apr 9, 2024
Mar 22, 2024
Apr 9, 2024
Mar 2, 2024
Nov 11, 2021
Jan 6, 2024
Mar 22, 2024
Jul 1, 2016
Jul 26, 2015
Jan 25, 2024
Jun 22, 2024
Mar 2, 2024
Nov 8, 2021
Feb 25, 2024
Oct 21, 2017
Mar 28, 2024
Apr 9, 2024

Repository files navigation

Requests-OAuthlib build-status coverage-status Documentation Status

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

The OAuth 1 workflow

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

Accessing protected resources using requests_oauthlib is as simple as:

>>> from requests_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.

Installation

To install requests and requests_oauthlib you can use pip:

pip install requests requests-oauthlib