blob: 1b5f5d6f0afdb951398a232951f218da52329b4b [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>`.
17- Support for Google :mod:`Service Account credentials <google.oauth2.service_account>`.
18- Support for :mod:`Google Compute Engine credentials <google.auth.compute_engine>`.
19- Support for :mod:`Google App Engine standard credentials <google.auth.app_engine>`.
20- Support for various transports, including
21 :mod:`Requests <google.auth.transport.requests>`,
22 :mod:`urllib3 <google.auth.transport.urllib3>`, and
23 :mod:`gRPC <google.auth.transport.grpc>`.
Jon Wayne Parrott377f2932016-10-04 10:20:36 -070024
Jon Wayne Parrottcf934812017-06-07 09:47:18 -070025.. note:: ``oauth2client`` was recently deprecated in favor of this library. For more details on the deprecation, see :doc:`oauth2client-deprecation`.
26
Jon Wayne Parrott53c7b172016-11-10 10:44:30 -080027Installing
28----------
Jon Wayne Parrott377f2932016-10-04 10:20:36 -070029
Jon Wayne Parrott53c7b172016-11-10 10:44:30 -080030google-auth can be installed with `pip`_::
Jon Wayne Parrott377f2932016-10-04 10:20:36 -070031
Jon Wayne Parrott53c7b172016-11-10 10:44:30 -080032 $ pip install --upgrade google-auth
33
34google-auth is open-source, so you can alternatively grab the source code from
35`GitHub`_ and install from source.
36
michaelawyuddf3cec2017-10-13 10:20:44 -070037
38For more information on setting up your Python development environment, please refer to `Python Development Environment Setup Guide`_ for Google Cloud Platform.
39
40.. _`Python Development Environment Setup Guide`: https://cloud.google.com/python/setup
Jon Wayne Parrott53c7b172016-11-10 10:44:30 -080041.. _pip: https://pip.pypa.io
42.. _GitHub: https://github.com/GoogleCloudPlatform/google-auth-library-python
43
44Usage
45-----
46
47The :doc:`user-guide` is the place to go to learn how to use the library and
48accomplish common tasks.
49
50The :doc:`Module Reference <reference/modules>` documentation provides API-level documentation.
51
52License
53-------
54
55google-auth is made available under the Apache License, Version 2.0. For more
56details, see `LICENSE`_
57
58.. _LICENSE:
59 https://github.com/GoogleCloudPlatform/google-auth-library-python/LICENSE
60
61Contributing
62------------
63
64We happily welcome contributions, please see our `contributing`_ documentation
65for details.
66
67.. _contributing:
68 https://github.com/GoogleCloudPlatform/google-auth-library-python/CONTRIBUTING.rst