Jon Wayne Parrott | 24d87e8 | 2017-01-11 13:29:02 -0800 | [diff] [blame] | 1 | Google Auth Python Library |
| 2 | ========================== |
Jon Wayne Parrott | 377f293 | 2016-10-04 10:20:36 -0700 | [diff] [blame] | 3 | |
ylil93 | cd93111 | 2019-07-25 16:21:13 -0700 | [diff] [blame] | 4 | |build| |docs| |pypi| |compat_check_pypi| |compat_check_github| |
Jon Wayne Parrott | 377f293 | 2016-10-04 10:20:36 -0700 | [diff] [blame] | 5 | |
| 6 | This library simplifies using Google's various server-to-server authentication |
| 7 | mechanisms to access Google APIs. |
| 8 | |
| 9 | .. |build| image:: https://travis-ci.org/GoogleCloudPlatform/google-auth-library-python.svg?branch=master |
Jon Wayne Parrott | 90c1c1b | 2016-12-14 12:43:30 -0800 | [diff] [blame] | 10 | :target: https://travis-ci.org/GoogleCloudPlatform/google-auth-library-python |
Jon Wayne Parrott | 377f293 | 2016-10-04 10:20:36 -0700 | [diff] [blame] | 11 | .. |docs| image:: https://readthedocs.org/projects/google-auth/badge/?version=latest |
| 12 | :target: https://google-auth.readthedocs.io/en/latest/ |
Jon Wayne Parrott | 90c1c1b | 2016-12-14 12:43:30 -0800 | [diff] [blame] | 13 | .. |pypi| image:: https://img.shields.io/pypi/v/google-auth.svg |
Jon Wayne Parrott | 377f293 | 2016-10-04 10:20:36 -0700 | [diff] [blame] | 14 | :target: https://pypi.python.org/pypi/google-auth |
ylil93 | cd93111 | 2019-07-25 16:21:13 -0700 | [diff] [blame] | 15 | .. |compat_check_pypi| image:: https://python-compatibility-tools.appspot.com/one_badge_image?package=google-auth |
| 16 | :target: https://python-compatibility-tools.appspot.com/one_badge_target?package=google-auth |
| 17 | .. |compat_check_github| image:: https://python-compatibility-tools.appspot.com/one_badge_image?package=git%2Bgit%3A//github.com/googleapis/google-auth-library-python.git |
| 18 | :target: https://python-compatibility-tools.appspot.com/one_badge_target?package=git%2Bgit%3A//github.com/googleapis/google-auth-library-python.git |
Jon Wayne Parrott | 377f293 | 2016-10-04 10:20:36 -0700 | [diff] [blame] | 19 | |
| 20 | Installing |
| 21 | ---------- |
| 22 | |
Jon Wayne Parrott | 2b773f3 | 2016-10-10 13:32:16 -0700 | [diff] [blame] | 23 | You can install using `pip`_:: |
Jon Wayne Parrott | 377f293 | 2016-10-04 10:20:36 -0700 | [diff] [blame] | 24 | |
Jon Wayne Parrott | 2b773f3 | 2016-10-10 13:32:16 -0700 | [diff] [blame] | 25 | $ pip install google-auth |
Jon Wayne Parrott | 377f293 | 2016-10-04 10:20:36 -0700 | [diff] [blame] | 26 | |
Jon Wayne Parrott | 2b773f3 | 2016-10-10 13:32:16 -0700 | [diff] [blame] | 27 | .. _pip: https://pip.pypa.io/en/stable/ |
Jon Wayne Parrott | 377f293 | 2016-10-04 10:20:36 -0700 | [diff] [blame] | 28 | |
michaelawyu | ddf3cec | 2017-10-13 10:20:44 -0700 | [diff] [blame] | 29 | For more information on setting up your Python development environment, please refer to `Python Development Environment Setup Guide`_ for Google Cloud Platform. |
| 30 | |
| 31 | .. _`Python Development Environment Setup Guide`: https://cloud.google.com/python/setup |
| 32 | |
Christopher Wilcox | 3f73694 | 2018-12-14 12:24:38 -0800 | [diff] [blame] | 33 | Supported Python Versions |
| 34 | ^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 35 | Python >= 3.4 |
| 36 | |
| 37 | Deprecated Python Versions |
| 38 | ^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 39 | Python == 2.7. Python 2.7 support will be removed on January 1, 2020. |
| 40 | |
Jon Wayne Parrott | 377f293 | 2016-10-04 10:20:36 -0700 | [diff] [blame] | 41 | Documentation |
| 42 | ------------- |
| 43 | |
| 44 | Google Auth Python Library has usage and reference documentation at `google-auth.readthedocs.io <https://google-auth.readthedocs.io>`_. |
| 45 | |
| 46 | Maintainers |
| 47 | ----------- |
| 48 | |
Christopher Wilcox | 5f65d27 | 2018-09-19 10:35:40 -0700 | [diff] [blame] | 49 | - `@theacodes <https://github.com/theacodes>`_ (Thea Flowers) |
Jon Wayne Parrott | 377f293 | 2016-10-04 10:20:36 -0700 | [diff] [blame] | 50 | - `@dhermes <https://github.com/dhermes>`_ (Danny Hermes) |
Jon Wayne Parrott | 709953d | 2017-04-17 13:13:13 -0700 | [diff] [blame] | 51 | - `@lukesneeringer <https://github.com/lukesneeringer>`_ (Luke Sneeringer) |
Jon Wayne Parrott | 377f293 | 2016-10-04 10:20:36 -0700 | [diff] [blame] | 52 | |
| 53 | Contributing |
| 54 | ------------ |
| 55 | |
| 56 | Contributions to this library are always welcome and highly encouraged. |
| 57 | |
Jon Wayne Parrott | 246df81 | 2016-10-21 14:31:06 -0700 | [diff] [blame] | 58 | See `CONTRIBUTING.rst`_ for more information on how to get started. |
Jon Wayne Parrott | 377f293 | 2016-10-04 10:20:36 -0700 | [diff] [blame] | 59 | |
Jon Wayne Parrott | 246df81 | 2016-10-21 14:31:06 -0700 | [diff] [blame] | 60 | .. _CONTRIBUTING.rst: https://github.com/GoogleCloudPlatform/google-auth-library-python/blob/master/CONTRIBUTING.rst |
Jon Wayne Parrott | 377f293 | 2016-10-04 10:20:36 -0700 | [diff] [blame] | 61 | |
| 62 | License |
| 63 | ------- |
| 64 | |
Jon Wayne Parrott | 246df81 | 2016-10-21 14:31:06 -0700 | [diff] [blame] | 65 | Apache 2.0 - See `the LICENSE`_ for more information. |
Jon Wayne Parrott | 377f293 | 2016-10-04 10:20:36 -0700 | [diff] [blame] | 66 | |
Jon Wayne Parrott | 246df81 | 2016-10-21 14:31:06 -0700 | [diff] [blame] | 67 | .. _the LICENSE: https://github.com/GoogleCloudPlatform/google-auth-library-python/blob/master/LICENSE |