blob: afc47880f92cbab20cfd0c6642568daa98a60cca [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 Kime61a8732019-11-11 11:26:00 -08004|docs| |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 Parrott377f2932016-10-04 10:20:36 -07009.. |docs| image:: https://readthedocs.org/projects/google-auth/badge/?version=latest
10 :target: https://google-auth.readthedocs.io/en/latest/
Jon Wayne Parrott90c1c1b2016-12-14 12:43:30 -080011.. |pypi| image:: https://img.shields.io/pypi/v/google-auth.svg
Jon Wayne Parrott377f2932016-10-04 10:20:36 -070012 :target: https://pypi.python.org/pypi/google-auth
13
14Installing
15----------
16
Jon Wayne Parrott2b773f32016-10-10 13:32:16 -070017You can install using `pip`_::
Jon Wayne Parrott377f2932016-10-04 10:20:36 -070018
Jon Wayne Parrott2b773f32016-10-10 13:32:16 -070019 $ pip install google-auth
Jon Wayne Parrott377f2932016-10-04 10:20:36 -070020
Jon Wayne Parrott2b773f32016-10-10 13:32:16 -070021.. _pip: https://pip.pypa.io/en/stable/
Jon Wayne Parrott377f2932016-10-04 10:20:36 -070022
michaelawyuddf3cec2017-10-13 10:20:44 -070023For more information on setting up your Python development environment, please refer to `Python Development Environment Setup Guide`_ for Google Cloud Platform.
24
25.. _`Python Development Environment Setup Guide`: https://cloud.google.com/python/setup
26
Christopher Wilcox3f736942018-12-14 12:24:38 -080027Supported Python Versions
28^^^^^^^^^^^^^^^^^^^^^^^^^
29Python >= 3.4
30
31Deprecated Python Versions
32^^^^^^^^^^^^^^^^^^^^^^^^^^
33Python == 2.7. Python 2.7 support will be removed on January 1, 2020.
34
Jon Wayne Parrott377f2932016-10-04 10:20:36 -070035Documentation
36-------------
37
38Google Auth Python Library has usage and reference documentation at `google-auth.readthedocs.io <https://google-auth.readthedocs.io>`_.
39
Bu Sun Kimae3bafd2019-10-02 14:05:04 -070040Current Maintainers
41-------------------
42- `@busunkim96 <https://github.com/busunkim96>`_ (Bu Sun Kim)
43
44Authors
45-------
Jon Wayne Parrott377f2932016-10-04 10:20:36 -070046
Christopher Wilcox5f65d272018-09-19 10:35:40 -070047- `@theacodes <https://github.com/theacodes>`_ (Thea Flowers)
Jon Wayne Parrott377f2932016-10-04 10:20:36 -070048- `@dhermes <https://github.com/dhermes>`_ (Danny Hermes)
Jon Wayne Parrott709953d2017-04-17 13:13:13 -070049- `@lukesneeringer <https://github.com/lukesneeringer>`_ (Luke Sneeringer)
Jon Wayne Parrott377f2932016-10-04 10:20:36 -070050
51Contributing
52------------
53
54Contributions to this library are always welcome and highly encouraged.
55
Jon Wayne Parrott246df812016-10-21 14:31:06 -070056See `CONTRIBUTING.rst`_ for more information on how to get started.
Jon Wayne Parrott377f2932016-10-04 10:20:36 -070057
Jon Wayne Parrott246df812016-10-21 14:31:06 -070058.. _CONTRIBUTING.rst: https://github.com/GoogleCloudPlatform/google-auth-library-python/blob/master/CONTRIBUTING.rst
Jon Wayne Parrott377f2932016-10-04 10:20:36 -070059
60License
61-------
62
Jon Wayne Parrott246df812016-10-21 14:31:06 -070063Apache 2.0 - See `the LICENSE`_ for more information.
Jon Wayne Parrott377f2932016-10-04 10:20:36 -070064
Jon Wayne Parrott246df812016-10-21 14:31:06 -070065.. _the LICENSE: https://github.com/GoogleCloudPlatform/google-auth-library-python/blob/master/LICENSE