1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
|
.. Requests-OAuthlib documentation master file, created by
sphinx-quickstart on Fri May 10 11:49:01 2013.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Requests-OAuthlib: OAuth for Humans
===================================
Requests-OAuthlib uses the Python
`Requests <https://github.com/kennethreitz/requests/>`_ and
`OAuthlib <https://github.com/idan/oauthlib/>`_ libraries to provide an
easy-to-use Python interface for building OAuth1 and OAuth2 clients.
Overview
--------
A simple Flask application which connects to the Github OAuth2 API looks
approximately like this:
.. code-block:: python
from requests_oauthlib import OAuth2Session
from flask import Flask, request, redirect, session, url_for
from flask.json import jsonify
# This information is obtained upon registration of a new GitHub
client_id = "<your client key>"
client_secret = "<your client secret>"
authorization_base_url = 'https://github.com/login/oauth/authorize'
token_url = 'https://github.com/login/oauth/access_token'
@app.route("/login")
def login():
github = OAuth2Session(client_id)
authorization_url, state = github.authorization_url(authorization_base_url)
# State is used to prevent CSRF, keep this for later.
session['oauth_state'] = state
return redirect(authorization_url)
@app.route("/callback")
def callback():
github = OAuth2Session(client_id, state=session['oauth_state'])
token = github.fetch_token(token_url, client_secret=client_secret,
authorization_response=request.url)
return jsonify(github.get('https://api.github.com/user').json())
The above is a truncated example. A full working example is available here:
:ref:`real_example`
Installation
============
Requests-OAuthlib can be installed with `pip <https://pip.pypa.io/>`_: ::
$ pip install requests_oauthlib
Getting Started:
================
.. toctree::
:maxdepth: 2
oauth1_workflow
oauth2_workflow
examples/examples
api
contributing
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
|
