blob: 4287c3db3eb5642edcbb0846d4ace0b71293dda8 [file] [log] [blame]
Jon Wayne Parrott53c7b172016-11-10 10:44:30 -08001google-auth
2===========
Jon Wayne Parrott377f2932016-10-04 10:20:36 -07003
4.. toctree::
Jon Wayne Parrott53c7b172016-11-10 10:44:30 -08005 :hidden:
Jon Wayne Parrott377f2932016-10-04 10:20:36 -07006 :maxdepth: 2
7
Jon Wayne Parrott53c7b172016-11-10 10:44:30 -08008 user-guide
9 Reference <reference/modules>
Jon Wayne Parrott377f2932016-10-04 10:20:36 -070010
Jon Wayne Parrott53c7b172016-11-10 10:44:30 -080011google-auth is the Google authentication library for Python. This library
12provides the ability to authenticate to Google APIs using various methods. It
13also provides integration with several HTTP libraries.
Jon Wayne Parrott377f2932016-10-04 10:20:36 -070014
Jon Wayne Parrott53c7b172016-11-10 10:44:30 -080015- Support for Google :func:`Application Default Credentials <google.auth.default>`.
16- Support for signing and verifying :mod:`JWTs <google.auth.jwt>`.
salrashid1237a8641a2019-08-07 14:31:33 -070017- Support for creating `Google ID Tokens <user-guide.html#identity-tokens>`__.
Arlan Jaska4255b102018-02-08 15:51:26 -080018- Support for verifying and decoding :mod:`ID Tokens <google.oauth2.id_token>`.
Jon Wayne Parrott53c7b172016-11-10 10:44:30 -080019- Support for Google :mod:`Service Account credentials <google.oauth2.service_account>`.
salrashid1231fbc6792018-11-09 11:05:34 -080020- Support for Google :mod:`Impersonated Credentials <google.auth.impersonated_credentials>`.
Jon Wayne Parrott53c7b172016-11-10 10:44:30 -080021- Support for :mod:`Google Compute Engine credentials <google.auth.compute_engine>`.
22- Support for :mod:`Google App Engine standard credentials <google.auth.app_engine>`.
23- Support for various transports, including
24 :mod:`Requests <google.auth.transport.requests>`,
25 :mod:`urllib3 <google.auth.transport.urllib3>`, and
26 :mod:`gRPC <google.auth.transport.grpc>`.
Jon Wayne Parrott377f2932016-10-04 10:20:36 -070027
Jon Wayne Parrottcf934812017-06-07 09:47:18 -070028.. note:: ``oauth2client`` was recently deprecated in favor of this library. For more details on the deprecation, see :doc:`oauth2client-deprecation`.
29
Jon Wayne Parrott53c7b172016-11-10 10:44:30 -080030Installing
31----------
Jon Wayne Parrott377f2932016-10-04 10:20:36 -070032
Jon Wayne Parrott53c7b172016-11-10 10:44:30 -080033google-auth can be installed with `pip`_::
Jon Wayne Parrott377f2932016-10-04 10:20:36 -070034
Jon Wayne Parrott53c7b172016-11-10 10:44:30 -080035 $ pip install --upgrade google-auth
36
37google-auth is open-source, so you can alternatively grab the source code from
38`GitHub`_ and install from source.
39
michaelawyuddf3cec2017-10-13 10:20:44 -070040
41For more information on setting up your Python development environment, please refer to `Python Development Environment Setup Guide`_ for Google Cloud Platform.
42
43.. _`Python Development Environment Setup Guide`: https://cloud.google.com/python/setup
Jon Wayne Parrott53c7b172016-11-10 10:44:30 -080044.. _pip: https://pip.pypa.io
45.. _GitHub: https://github.com/GoogleCloudPlatform/google-auth-library-python
46
47Usage
48-----
49
50The :doc:`user-guide` is the place to go to learn how to use the library and
51accomplish common tasks.
52
53The :doc:`Module Reference <reference/modules>` documentation provides API-level documentation.
54
55License
56-------
57
58google-auth is made available under the Apache License, Version 2.0. For more
59details, see `LICENSE`_
60
61.. _LICENSE:
Thea Flowersce54cc32018-05-24 13:09:47 -070062 https://github.com/GoogleCloudPlatform/google-auth-library-python/blob/master/LICENSE
Jon Wayne Parrott53c7b172016-11-10 10:44:30 -080063
64Contributing
65------------
66
67We happily welcome contributions, please see our `contributing`_ documentation
68for details.
69
70.. _contributing:
Thea Flowersce54cc32018-05-24 13:09:47 -070071 https://github.com/GoogleCloudPlatform/google-auth-library-python/blob/master/CONTRIBUTING.rst