blob: c0cbdbfab4c480b791e627ac20699b534e9e578b [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 Parrott53c7b172016-11-10 10:44:30 -080025Installing
26----------
Jon Wayne Parrott377f2932016-10-04 10:20:36 -070027
Jon Wayne Parrott53c7b172016-11-10 10:44:30 -080028google-auth can be installed with `pip`_::
Jon Wayne Parrott377f2932016-10-04 10:20:36 -070029
Jon Wayne Parrott53c7b172016-11-10 10:44:30 -080030 $ pip install --upgrade google-auth
31
32google-auth is open-source, so you can alternatively grab the source code from
33`GitHub`_ and install from source.
34
35.. _pip: https://pip.pypa.io
36.. _GitHub: https://github.com/GoogleCloudPlatform/google-auth-library-python
37
38Usage
39-----
40
41The :doc:`user-guide` is the place to go to learn how to use the library and
42accomplish common tasks.
43
44The :doc:`Module Reference <reference/modules>` documentation provides API-level documentation.
45
46License
47-------
48
49google-auth is made available under the Apache License, Version 2.0. For more
50details, see `LICENSE`_
51
52.. _LICENSE:
53 https://github.com/GoogleCloudPlatform/google-auth-library-python/LICENSE
54
55Contributing
56------------
57
58We happily welcome contributions, please see our `contributing`_ documentation
59for details.
60
61.. _contributing:
62 https://github.com/GoogleCloudPlatform/google-auth-library-python/CONTRIBUTING.rst