| Jon Wayne Parrott | 53c7b17 | 2016-11-10 10:44:30 -0800 | [diff] [blame] | 1 | google-auth |
| 2 | =========== |
| Jon Wayne Parrott | 377f293 | 2016-10-04 10:20:36 -0700 | [diff] [blame] | 3 | |
| 4 | .. toctree:: |
| Jon Wayne Parrott | 53c7b17 | 2016-11-10 10:44:30 -0800 | [diff] [blame] | 5 | :hidden: |
| Jon Wayne Parrott | 377f293 | 2016-10-04 10:20:36 -0700 | [diff] [blame] | 6 | :maxdepth: 2 |
| 7 | |
| Jon Wayne Parrott | 53c7b17 | 2016-11-10 10:44:30 -0800 | [diff] [blame] | 8 | user-guide |
| 9 | Reference <reference/modules> |
| Jon Wayne Parrott | 377f293 | 2016-10-04 10:20:36 -0700 | [diff] [blame] | 10 | |
| Jon Wayne Parrott | 53c7b17 | 2016-11-10 10:44:30 -0800 | [diff] [blame] | 11 | google-auth is the Google authentication library for Python. This library |
| 12 | provides the ability to authenticate to Google APIs using various methods. It |
| 13 | also provides integration with several HTTP libraries. |
| Jon Wayne Parrott | 377f293 | 2016-10-04 10:20:36 -0700 | [diff] [blame] | 14 | |
| Jon Wayne Parrott | 53c7b17 | 2016-11-10 10:44:30 -0800 | [diff] [blame] | 15 | - 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 Parrott | 377f293 | 2016-10-04 10:20:36 -0700 | [diff] [blame] | 24 | |
| Jon Wayne Parrott | cf93481 | 2017-06-07 09:47:18 -0700 | [diff] [blame] | 25 | .. note:: ``oauth2client`` was recently deprecated in favor of this library. For more details on the deprecation, see :doc:`oauth2client-deprecation`. |
| 26 | |
| Jon Wayne Parrott | 53c7b17 | 2016-11-10 10:44:30 -0800 | [diff] [blame] | 27 | Installing |
| 28 | ---------- |
| Jon Wayne Parrott | 377f293 | 2016-10-04 10:20:36 -0700 | [diff] [blame] | 29 | |
| Jon Wayne Parrott | 53c7b17 | 2016-11-10 10:44:30 -0800 | [diff] [blame] | 30 | google-auth can be installed with `pip`_:: |
| Jon Wayne Parrott | 377f293 | 2016-10-04 10:20:36 -0700 | [diff] [blame] | 31 | |
| Jon Wayne Parrott | 53c7b17 | 2016-11-10 10:44:30 -0800 | [diff] [blame] | 32 | $ pip install --upgrade google-auth |
| 33 | |
| 34 | google-auth is open-source, so you can alternatively grab the source code from |
| 35 | `GitHub`_ and install from source. |
| 36 | |
| michaelawyu | ddf3cec | 2017-10-13 10:20:44 -0700 | [diff] [blame^] | 37 | |
| 38 | For 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 Parrott | 53c7b17 | 2016-11-10 10:44:30 -0800 | [diff] [blame] | 41 | .. _pip: https://pip.pypa.io |
| 42 | .. _GitHub: https://github.com/GoogleCloudPlatform/google-auth-library-python |
| 43 | |
| 44 | Usage |
| 45 | ----- |
| 46 | |
| 47 | The :doc:`user-guide` is the place to go to learn how to use the library and |
| 48 | accomplish common tasks. |
| 49 | |
| 50 | The :doc:`Module Reference <reference/modules>` documentation provides API-level documentation. |
| 51 | |
| 52 | License |
| 53 | ------- |
| 54 | |
| 55 | google-auth is made available under the Apache License, Version 2.0. For more |
| 56 | details, see `LICENSE`_ |
| 57 | |
| 58 | .. _LICENSE: |
| 59 | https://github.com/GoogleCloudPlatform/google-auth-library-python/LICENSE |
| 60 | |
| 61 | Contributing |
| 62 | ------------ |
| 63 | |
| 64 | We happily welcome contributions, please see our `contributing`_ documentation |
| 65 | for details. |
| 66 | |
| 67 | .. _contributing: |
| 68 | https://github.com/GoogleCloudPlatform/google-auth-library-python/CONTRIBUTING.rst |