A generic, spec-compliant, thorough implementation of the OAuth request-signing logic for Python 2.7 and 3.4+.
.. image:: https://travis-ci.org/oauthlib/oauthlib.svg?branch=master :target: https://travis-ci.org/oauthlib/oauthlib :alt: Travis .. image:: https://coveralls.io/repos/oauthlib/oauthlib/badge.svg?branch=master :target: https://coveralls.io/r/oauthlib/oauthlib :alt: Coveralls .. image:: https://img.shields.io/pypi/pyversions/oauthlib.svg :target: https://pypi.org/project/oauthlib/ :alt: Download from PyPI .. image:: https://img.shields.io/pypi/l/oauthlib.svg :target: https://pypi.org/project/oauthlib/ :alt: License .. image:: https://app.fossa.io/api/projects/git%2Bgithub.com%2Foauthlib%2Foauthlib.svg?type=shield :target: https://app.fossa.io/projects/git%2Bgithub.com%2Foauthlib%2Foauthlib?ref=badge_shield :alt: FOSSA Status .. image:: https://img.shields.io/readthedocs/oauthlib.svg :target: https://oauthlib.readthedocs.io/en/latest/index.html :alt: Read the Docs .. image:: https://badges.gitter.im/oauthlib/oauthlib.svg :target: https://gitter.im/oauthlib/Lobby :alt: Chat on Gitter
OAuth often seems complicated and difficult-to-implement. There are several prominent libraries for handling OAuth requests, but they all suffer from one or both of the following:
OAuth 1.0 spec
_, AKA RFC 5849.OAuth 2.0 spec
_, AKA RFC 6749... _OAuth 1.0 spec
: https://tools.ietf.org/html/rfc5849
.. _OAuth 2.0 spec
: https://tools.ietf.org/html/rfc6749
OAuthLib is a framework which implements the logic of OAuth1 or OAuth2 without assuming a specific HTTP request object or web framework. Use it to graft OAuth client support onto your favorite HTTP library, or provide support onto your favourite web framework. If you're a maintainer of such a library, write a thin veneer on top of OAuthLib and get OAuth support for very little effort.
Full documentation is available on Read the Docs
. All contributions are very
welcome! The documentation is still quite sparse, please open an issue for what
you'd like to know, or discuss it in our Gitter community
, or even better, send a
pull request!
.. _Gitter community
: https://gitter.im/oauthlib/Lobby
.. _Read the Docs
: https://oauthlib.readthedocs.io/en/latest/index.html
Then you might be more interested in using requests
_ which has OAuthLib
powered OAuth support provided by the requests-oauthlib
_ library.
.. _requests
: https://github.com/requests/requests
.. _requests-oauthlib
: https://github.com/requests/requests-oauthlib
The following packages provide OAuth support using OAuthLib.
django-oauth-toolkit
, which includes Django REST framework
support.flask-oauthlib
_ and Flask-Dance
_.pyramid-oauthlib
_.bottle-oauthlib
_.If you have written an OAuthLib package that supports your favorite framework, please open a Pull Request, updating the documentation.
.. _django-oauth-toolkit
: https://github.com/evonove/django-oauth-toolkit
.. _flask-oauthlib
: https://github.com/lepture/flask-oauthlib
.. _Django REST framework
: http://django-rest-framework.org
.. _Flask-Dance
: https://github.com/singingwolfboy/flask-dance
.. _pyramid-oauthlib
: https://github.com/tilgovi/pyramid-oauthlib
.. _bottle-oauthlib
: https://github.com/thomsonreuters/bottle-oauthlib
Patching OAuth support onto an http request framework? Creating an OAuth provider extension for a web framework? Simply using OAuthLib to Get Things Done or to learn?
No matter which we'd love to hear from you in our Gitter community
_ or if you have
anything in particular you would like to have, change or comment on don't
hesitate for a second to send a pull request or open an issue. We might be quite
busy and therefore slow to reply but we love feedback!
Chances are you have run into something annoying that you wish there was documentation for, if you wish to gain eternal fame and glory, and a drink if we have the pleasure to run into eachother, please send a docs pull request =)
.. _Gitter community
: https://gitter.im/oauthlib/Lobby
OAuthLib is yours to use and abuse according to the terms of the BSD license. Check the LICENSE file for full details.
OAuthLib has been started and maintained several years by Idan Gazit and other
amazing AUTHORS
. Thanks to their wonderful work, the open-source community
creation has been possible and the project can stay active and reactive to users
requests.
.. _AUTHORS
: https://github.com/oauthlib/oauthlib/blob/master/AUTHORS
.. _community
: https://github.com/oauthlib/
OAuthLib is in active development, with the core of both OAuth1 and OAuth2
completed, for providers as well as clients. See supported features
_ for
details.
.. supported features
: https://oauthlib.readthedocs.io/en/latest/featurematrix.html
For a full changelog see CHANGELOG.rst
.