Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-auth-library-python / 3f73694f01e0c60f8cda59a6102247a5bf2ee173 / . / README.rst
blob: 00dbfef62f0ddb291c5b78dc71f4c82a031d7df8 [file] [log] [blame]
Jon Wayne Parrott24d87e82017-01-11 13:29:02 -0800[diff] [blame]1Google Auth Python Library
2==========================
Jon Wayne Parrott377f2932016-10-04 10:20:36 -0700[diff] [blame]3
4|build| |docs| |pypi|
5
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 -0800[diff] [blame]10 :target: https://travis-ci.org/GoogleCloudPlatform/google-auth-library-python
Jon Wayne Parrott377f2932016-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 Parrott90c1c1b2016-12-14 12:43:30 -0800[diff] [blame]13.. |pypi| image:: https://img.shields.io/pypi/v/google-auth.svg
Jon Wayne Parrott377f2932016-10-04 10:20:36 -0700[diff] [blame]14 :target: https://pypi.python.org/pypi/google-auth
15
16Installing
17----------
18
Jon Wayne Parrott2b773f32016-10-10 13:32:16 -0700[diff] [blame]19You can install using `pip`_::
Jon Wayne Parrott377f2932016-10-04 10:20:36 -0700[diff] [blame]20
Jon Wayne Parrott2b773f32016-10-10 13:32:16 -0700[diff] [blame]21 $ pip install google-auth
Jon Wayne Parrott377f2932016-10-04 10:20:36 -0700[diff] [blame]22
Jon Wayne Parrott2b773f32016-10-10 13:32:16 -0700[diff] [blame]23.. _pip: https://pip.pypa.io/en/stable/
Jon Wayne Parrott377f2932016-10-04 10:20:36 -0700[diff] [blame]24
michaelawyuddf3cec2017-10-13 10:20:44 -0700[diff] [blame]25For more information on setting up your Python development environment, please refer to `Python Development Environment Setup Guide`_ for Google Cloud Platform.
26
27.. _`Python Development Environment Setup Guide`: https://cloud.google.com/python/setup
28
Christopher Wilcox3f736942018-12-14 12:24:38 -0800[diff] [blame^]29Supported Python Versions
30^^^^^^^^^^^^^^^^^^^^^^^^^
31Python >= 3.4
32
33Deprecated Python Versions
34^^^^^^^^^^^^^^^^^^^^^^^^^^
35Python == 2.7. Python 2.7 support will be removed on January 1, 2020.
36
Jon Wayne Parrott377f2932016-10-04 10:20:36 -0700[diff] [blame]37Documentation
38-------------
39
40Google Auth Python Library has usage and reference documentation at `google-auth.readthedocs.io <https://google-auth.readthedocs.io>`_.
41
42Maintainers
43-----------
44
Christopher Wilcox5f65d272018-09-19 10:35:40 -0700[diff] [blame]45- `@theacodes <https://github.com/theacodes>`_ (Thea Flowers)
Jon Wayne Parrott377f2932016-10-04 10:20:36 -0700[diff] [blame]46- `@dhermes <https://github.com/dhermes>`_ (Danny Hermes)
Jon Wayne Parrott709953d2017-04-17 13:13:13 -0700[diff] [blame]47- `@lukesneeringer <https://github.com/lukesneeringer>`_ (Luke Sneeringer)
Jon Wayne Parrott377f2932016-10-04 10:20:36 -0700[diff] [blame]48
49Contributing
50------------
51
52Contributions to this library are always welcome and highly encouraged.
53
Jon Wayne Parrott246df812016-10-21 14:31:06 -0700[diff] [blame]54See `CONTRIBUTING.rst`_ for more information on how to get started.
Jon Wayne Parrott377f2932016-10-04 10:20:36 -0700[diff] [blame]55
Jon Wayne Parrott246df812016-10-21 14:31:06 -0700[diff] [blame]56.. _CONTRIBUTING.rst: https://github.com/GoogleCloudPlatform/google-auth-library-python/blob/master/CONTRIBUTING.rst
Jon Wayne Parrott377f2932016-10-04 10:20:36 -0700[diff] [blame]57
58License
59-------
60
Jon Wayne Parrott246df812016-10-21 14:31:06 -0700[diff] [blame]61Apache 2.0 - See `the LICENSE`_ for more information.
Jon Wayne Parrott377f2932016-10-04 10:20:36 -0700[diff] [blame]62
Jon Wayne Parrott246df812016-10-21 14:31:06 -0700[diff] [blame]63.. _the LICENSE: https://github.com/GoogleCloudPlatform/google-auth-library-python/blob/master/LICENSE