Skip to content

Commit

Permalink
Remove oauthlib modules from documentation, update user guide (#139)
Browse files Browse the repository at this point in the history
  • Loading branch information
Jon Wayne Parrott committed Mar 22, 2017
1 parent 41a2bba commit d47281b
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 24 deletions.
7 changes: 0 additions & 7 deletions docs/reference/google.oauth2.flow.rst

This file was deleted.

7 changes: 0 additions & 7 deletions docs/reference/google.oauth2.oauthlib.rst

This file was deleted.

2 changes: 0 additions & 2 deletions docs/reference/google.oauth2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@ Submodules
.. toctree::

google.oauth2.credentials
google.oauth2.flow
google.oauth2.id_token
google.oauth2.oauthlib
google.oauth2.service_account

18 changes: 10 additions & 8 deletions docs/user-guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -157,24 +157,26 @@ URI to allow the credentials to be automatically refreshed::
client_secret='client_secret')


This library has some helpers for integrating with `requests-oauthlib`_ to
provide support for obtaining user credentials. You can use
:func:`google.oauth2.oauthlib.credentials_from_session` to obtain
There is a separate library, `google-auth-oauthlib`_, that has some helpers
for integrating with `requests-oauthlib`_ to provide support for obtaining
user credentials. You can use
:func:`google_auth_oauthlib.helpers.credentials_from_session` to obtain
:class:`google.oauth2.credentials.Credentials` from a
:class:`requests_oauthlib.OAuth2Session` as above::

import google.oauth2.oauthlib
from google_auth_oauthlib.helpers import credentials_from_session

google_auth_credentials = google.oauth2.oauthlib.credentials_from_session(
oauth2session)
google_auth_credentials = credentials_from_session(oauth2session)

You can also use :class:`google.oauth2.flow.Flow` to perform the OAuth 2.0
Authorization Grant Flow to obtain credentials using `requests-oauthlib`_.
You can also use :class:`google_auth_oauthlib.flow.Flow` to perform the OAuth
2.0 Authorization Grant Flow to obtain credentials using `requests-oauthlib`_.

.. _OAuth 2.0:
https://developers.google.com/identity/protocols/OAuth2
.. _oauthlib:
https://oauthlib.readthedocs.io/en/latest/
.. _google-auth-oauthlib:
https://pypi.python.org/pypi/google-auth-oauthlib
.. _requests-oauthlib:
https://requests-oauthlib.readthedocs.io/en/latest/

Expand Down

0 comments on commit d47281b

Please sign in to comment.