blob: 6e67161738963521ae2a1f2a4c85f1e033429614 [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
Bu Sun Kim1b9de8d2020-01-22 16:09:31 -08004|pypi|
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
Jon Wayne Parrott90c1c1b2016-12-14 12:43:30 -08009.. |pypi| image:: https://img.shields.io/pypi/v/google-auth.svg
Jon Wayne Parrott377f2932016-10-04 10:20:36 -070010 :target: https://pypi.python.org/pypi/google-auth
11
12Installing
13----------
14
Jon Wayne Parrott2b773f32016-10-10 13:32:16 -070015You can install using `pip`_::
Jon Wayne Parrott377f2932016-10-04 10:20:36 -070016
Jon Wayne Parrott2b773f32016-10-10 13:32:16 -070017 $ pip install google-auth
Jon Wayne Parrott377f2932016-10-04 10:20:36 -070018
Jon Wayne Parrott2b773f32016-10-10 13:32:16 -070019.. _pip: https://pip.pypa.io/en/stable/
Jon Wayne Parrott377f2932016-10-04 10:20:36 -070020
michaelawyuddf3cec2017-10-13 10:20:44 -070021For more information on setting up your Python development environment, please refer to `Python Development Environment Setup Guide`_ for Google Cloud Platform.
22
23.. _`Python Development Environment Setup Guide`: https://cloud.google.com/python/setup
24
Christopher Wilcox3f736942018-12-14 12:24:38 -080025Supported Python Versions
26^^^^^^^^^^^^^^^^^^^^^^^^^
Tres Seaver560cf1e2021-08-03 16:35:54 -040027Python >= 3.6
Christopher Wilcox3f736942018-12-14 12:24:38 -080028
Tres Seaver560cf1e2021-08-03 16:35:54 -040029Unsupported Python Versions
30^^^^^^^^^^^^^^^^^^^^^^^^^^^
31- Python == 2.7: The last version of this library with support for Python 2.7
32 was `google.auth == 1.34.0`.
33
34- Python 3.5: The last version of this library with support for Python 3.5
35 was `google.auth == 1.23.0`.
Christopher Wilcox3f736942018-12-14 12:24:38 -080036
Jon Wayne Parrott377f2932016-10-04 10:20:36 -070037Documentation
38-------------
39
Bu Sun Kim1b9de8d2020-01-22 16:09:31 -080040Google Auth Python Library has usage and reference documentation at https://googleapis.dev/python/google-auth/latest/index.html.
Jon Wayne Parrott377f2932016-10-04 10:20:36 -070041
Bu Sun Kimae3bafd2019-10-02 14:05:04 -070042Current Maintainers
43-------------------
44- `@busunkim96 <https://github.com/busunkim96>`_ (Bu Sun Kim)
45
46Authors
47-------
Jon Wayne Parrott377f2932016-10-04 10:20:36 -070048
Christopher Wilcox5f65d272018-09-19 10:35:40 -070049- `@theacodes <https://github.com/theacodes>`_ (Thea Flowers)
Jon Wayne Parrott377f2932016-10-04 10:20:36 -070050- `@dhermes <https://github.com/dhermes>`_ (Danny Hermes)
Jon Wayne Parrott709953d2017-04-17 13:13:13 -070051- `@lukesneeringer <https://github.com/lukesneeringer>`_ (Luke Sneeringer)
Jon Wayne Parrott377f2932016-10-04 10:20:36 -070052
53Contributing
54------------
55
56Contributions to this library are always welcome and highly encouraged.
57
Jon Wayne Parrott246df812016-10-21 14:31:06 -070058See `CONTRIBUTING.rst`_ for more information on how to get started.
Jon Wayne Parrott377f2932016-10-04 10:20:36 -070059
Anthonios Parthenioub86480e2021-08-25 12:41:18 -040060.. _CONTRIBUTING.rst: https://github.com/googleapis/google-auth-library-python/blob/main/CONTRIBUTING.rst
Jon Wayne Parrott377f2932016-10-04 10:20:36 -070061
62License
63-------
64
Jon Wayne Parrott246df812016-10-21 14:31:06 -070065Apache 2.0 - See `the LICENSE`_ for more information.
Jon Wayne Parrott377f2932016-10-04 10:20:36 -070066
Anthonios Parthenioub86480e2021-08-25 12:41:18 -040067.. _the LICENSE: https://github.com/googleapis/google-auth-library-python/blob/main/LICENSE