Skip to content
OAuthlib support for Python-Requests!
Branch: master
Clone or download
singingwolfboy Merge pull request #368 from singingwolfboy/black
Require code formatting with `black`
Latest commit c80b2b6 Feb 25, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs Reformatted with `black` Feb 25, 2019
requests_oauthlib Reformatted with `black` Feb 25, 2019
tests Reformatted with `black` Feb 25, 2019
.gitignore Remove dependency of unmaintained nose Dec 26, 2018
.travis.yml Require code formatting with `black` Feb 25, 2019
AUTHORS.rst Update HISTORY.rst, add myself to AUTHORS.rst Sep 10, 2014
HISTORY.rst Put Instagram compliance fix in HISTORY Feb 22, 2019
LICENSE
MANIFEST.in Prune .pyc files when creating a release Jul 26, 2015
README.rst
requirements.txt
setup.cfg
setup.py
tox.ini Merge pull request #346 from jdufresne/nose Dec 27, 2018

README.rst

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
You can’t perform that action at this time.