https://github.com/requests/requests-oauthlib

OAuthlib support for Python-Requests!
https://github.com/requests/requests-oauthlib

oauth-client oauth2-client python python-requests

Last synced: 11 days ago
JSON representation

OAuthlib support for Python-Requests!

• Host: GitHub
• URL: https://github.com/requests/requests-oauthlib
• Owner: requests
• License: isc
• Created: 2012-11-23T10:19:44.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2024-08-14T13:48:47.000Z (3 months ago)
• Last Synced: 2024-10-03T09:18:34.788Z (about 1 month ago)
• Topics: oauth-client, oauth2-client, python, python-requests
• Language: Python
• Homepage: https://requests-oauthlib.readthedocs.org/
• Size: 563 KB
• Stars: 1,718
• Watchers: 52
• Forks: 424
• Open Issues: 116
• Metadata Files:
  • Readme: README.rst
  • Changelog: HISTORY.rst
  • Contributing: docs/contributing.rst
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Security: SECURITY.md
  • Authors: AUTHORS.rst

Awesome Lists containing this project

• best-of-web-python - GitHub - 39% open · ⏱️ 20.04.2024): (Authorization & Authentication)
• awesome-repositories - requests/requests-oauthlib - OAuthlib support for Python-Requests! (Python)

README

        
Requests-OAuthlib |build-status| |coverage-status| |docs|

=========================================================

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:

.. code-block:: pycon

    >>> 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:

.. code-block:: bash

    pip install requests requests-oauthlib

.. |build-status| image:: https://github.com/requests/requests-oauthlib/actions/workflows/run-tests.yml/badge.svg

   :target: https://github.com/requests/requests-oauthlib/actions

.. |coverage-status| image:: https://img.shields.io/coveralls/requests/requests-oauthlib.svg

   :target: https://coveralls.io/r/requests/requests-oauthlib

.. |docs| image:: https://readthedocs.org/projects/requests-oauthlib/badge/

   :alt: Documentation Status

   :scale: 100%

   :target: https://requests-oauthlib.readthedocs.io/