blob: 3d7ba76afa8302a69837dffeafb3a291e108f26e [file] [log] [blame]
Jon Wayne Parrott24d87e82017-01-11 13:29:02 -08001Google Auth Python Library
2==========================
Jon Wayne Parrott377f2932016-10-04 10:20:36 -07003
ylil93cd931112019-07-25 16:21:13 -07004|build| |docs| |pypi| |compat_check_pypi| |compat_check_github|
Jon Wayne Parrott377f2932016-10-04 10:20:36 -07005
6This library simplifies using Google's various server-to-server authentication
7mechanisms to access Google APIs.
8
9.. |build| image:: https://travis-ci.org/GoogleCloudPlatform/google-auth-library-python.svg?branch=master
Jon Wayne Parrott90c1c1b2016-12-14 12:43:30 -080010 :target: https://travis-ci.org/GoogleCloudPlatform/google-auth-library-python
Jon Wayne Parrott377f2932016-10-04 10:20:36 -070011.. |docs| image:: https://readthedocs.org/projects/google-auth/badge/?version=latest
12 :target: https://google-auth.readthedocs.io/en/latest/
Jon Wayne Parrott90c1c1b2016-12-14 12:43:30 -080013.. |pypi| image:: https://img.shields.io/pypi/v/google-auth.svg
Jon Wayne Parrott377f2932016-10-04 10:20:36 -070014 :target: https://pypi.python.org/pypi/google-auth
ylil93cd931112019-07-25 16:21:13 -070015.. |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 Parrott377f2932016-10-04 10:20:36 -070019
20Installing
21----------
22
Jon Wayne Parrott2b773f32016-10-10 13:32:16 -070023You can install using `pip`_::
Jon Wayne Parrott377f2932016-10-04 10:20:36 -070024
Jon Wayne Parrott2b773f32016-10-10 13:32:16 -070025 $ pip install google-auth
Jon Wayne Parrott377f2932016-10-04 10:20:36 -070026
Jon Wayne Parrott2b773f32016-10-10 13:32:16 -070027.. _pip: https://pip.pypa.io/en/stable/
Jon Wayne Parrott377f2932016-10-04 10:20:36 -070028
michaelawyuddf3cec2017-10-13 10:20:44 -070029For 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 Wilcox3f736942018-12-14 12:24:38 -080033Supported Python Versions
34^^^^^^^^^^^^^^^^^^^^^^^^^
35Python >= 3.4
36
37Deprecated Python Versions
38^^^^^^^^^^^^^^^^^^^^^^^^^^
39Python == 2.7. Python 2.7 support will be removed on January 1, 2020.
40
Jon Wayne Parrott377f2932016-10-04 10:20:36 -070041Documentation
42-------------
43
44Google Auth Python Library has usage and reference documentation at `google-auth.readthedocs.io <https://google-auth.readthedocs.io>`_.
45
Bu Sun Kimae3bafd2019-10-02 14:05:04 -070046Current Maintainers
47-------------------
48- `@busunkim96 <https://github.com/busunkim96>`_ (Bu Sun Kim)
49
50Authors
51-------
Jon Wayne Parrott377f2932016-10-04 10:20:36 -070052
Christopher Wilcox5f65d272018-09-19 10:35:40 -070053- `@theacodes <https://github.com/theacodes>`_ (Thea Flowers)
Jon Wayne Parrott377f2932016-10-04 10:20:36 -070054- `@dhermes <https://github.com/dhermes>`_ (Danny Hermes)
Jon Wayne Parrott709953d2017-04-17 13:13:13 -070055- `@lukesneeringer <https://github.com/lukesneeringer>`_ (Luke Sneeringer)
Jon Wayne Parrott377f2932016-10-04 10:20:36 -070056
57Contributing
58------------
59
60Contributions to this library are always welcome and highly encouraged.
61
Jon Wayne Parrott246df812016-10-21 14:31:06 -070062See `CONTRIBUTING.rst`_ for more information on how to get started.
Jon Wayne Parrott377f2932016-10-04 10:20:36 -070063
Jon Wayne Parrott246df812016-10-21 14:31:06 -070064.. _CONTRIBUTING.rst: https://github.com/GoogleCloudPlatform/google-auth-library-python/blob/master/CONTRIBUTING.rst
Jon Wayne Parrott377f2932016-10-04 10:20:36 -070065
66License
67-------
68
Jon Wayne Parrott246df812016-10-21 14:31:06 -070069Apache 2.0 - See `the LICENSE`_ for more information.
Jon Wayne Parrott377f2932016-10-04 10:20:36 -070070
Jon Wayne Parrott246df812016-10-21 14:31:06 -070071.. _the LICENSE: https://github.com/GoogleCloudPlatform/google-auth-library-python/blob/master/LICENSE