Skip to content

Commit d47281b

Browse files
author
Jon Wayne Parrott
authored
Remove oauthlib modules from documentation, update user guide (#139)
1 parent 41a2bba commit d47281b

File tree

4 files changed

+10
-24
lines changed

4 files changed

+10
-24
lines changed

docs/reference/google.oauth2.flow.rst

Lines changed: 0 additions & 7 deletions
This file was deleted.

docs/reference/google.oauth2.oauthlib.rst

Lines changed: 0 additions & 7 deletions
This file was deleted.

docs/reference/google.oauth2.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@ Submodules
1212
.. toctree::
1313

1414
google.oauth2.credentials
15-
google.oauth2.flow
1615
google.oauth2.id_token
17-
google.oauth2.oauthlib
1816
google.oauth2.service_account
1917

docs/user-guide.rst

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -157,24 +157,26 @@ URI to allow the credentials to be automatically refreshed::
157157
client_secret='client_secret')
158158

159159

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

166-
import google.oauth2.oauthlib
167+
from google_auth_oauthlib.helpers import credentials_from_session
167168

168-
google_auth_credentials = google.oauth2.oauthlib.credentials_from_session(
169-
oauth2session)
169+
google_auth_credentials = credentials_from_session(oauth2session)
170170

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

174174
.. _OAuth 2.0:
175175
https://developers.google.com/identity/protocols/OAuth2
176176
.. _oauthlib:
177177
https://oauthlib.readthedocs.io/en/latest/
178+
.. _google-auth-oauthlib:
179+
https://pypi.python.org/pypi/google-auth-oauthlib
178180
.. _requests-oauthlib:
179181
https://requests-oauthlib.readthedocs.io/en/latest/
180182

0 commit comments

Comments
 (0)