Skip to content
This repository was archived by the owner on Mar 6, 2026. It is now read-only.

Commit 22d9094

Browse files
hiranya911Jon Wayne Parrott
authored andcommitted
Documentation Update: Added instructions for using the library in App Engine (#172)
* Added instructions on setting up the google.auth library in App Engine * Fixed some formatting issues * Adding a link to requests-toolbelt * Fixed reference * Fixed the link formatting
1 parent 78fec2c commit 22d9094

1 file changed

Lines changed: 25 additions & 0 deletions

File tree

docs/user-guide.rst

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,10 +127,35 @@ credentials one of two ways:
127127

128128
credentials = app_engine.Credentials()
129129

130+
In order to make authenticated requests in the App Engine environment using the
131+
credentials and transports provided by this library, you need to follow a few
132+
additional steps:
133+
134+
#. If you are using the :mod:`google.auth.transport.requests` transport, vendor
135+
in the `requests-toolbelt`_ library into you app, and enable the App Engine
136+
monkeypatch. Refer `App Engine documentation`_ for more details on this.
137+
#. To make HTTPS calls, enable the ``ssl`` library for you app by adding the
138+
following configuration to the ``app.yaml`` file::
139+
140+
libraries:
141+
- name: ssl
142+
version: latest
143+
144+
#. Enable billing for you App Engine project. Then enable socket support for
145+
your app. This can be achieved by setting an environment variable in the
146+
``app.yaml`` file::
147+
148+
env_variables:
149+
GAE_USE_SOCKETS_HTTPLIB : 'true'
150+
130151
.. _App Engine standard environment:
131152
https://cloud.google.com/appengine/docs/python
132153
.. _App Engine App Identity API:
133154
https://cloud.google.com/appengine/docs/python/appidentity/
155+
.. _requests-toolbelt:
156+
https://toolbelt.readthedocs.io/en/latest/
157+
.. _App Engine documentation:
158+
https://cloud.google.com/appengine/docs/standard/python/issue-requests
134159

135160
User credentials
136161
++++++++++++++++

0 commit comments

Comments
 (0)