blob: 4be0c5d21c27196fdc28e7e628ac56da8fdd2786 [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
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 -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
15
16Installing
17----------
18
Jon Wayne Parrott2b773f32016-10-10 13:32:16 -070019You can install using `pip`_::
Jon Wayne Parrott377f2932016-10-04 10:20:36 -070020
Jon Wayne Parrott2b773f32016-10-10 13:32:16 -070021 $ pip install google-auth
Jon Wayne Parrott377f2932016-10-04 10:20:36 -070022
Jon Wayne Parrott2b773f32016-10-10 13:32:16 -070023.. _pip: https://pip.pypa.io/en/stable/
Jon Wayne Parrott377f2932016-10-04 10:20:36 -070024
25Documentation
26-------------
27
28Google Auth Python Library has usage and reference documentation at `google-auth.readthedocs.io <https://google-auth.readthedocs.io>`_.
29
30Maintainers
31-----------
32
33- `@jonparrott <https://github.com/jonparrott>`_ (Jon Wayne Parrott)
34- `@dhermes <https://github.com/dhermes>`_ (Danny Hermes)
Jon Wayne Parrott709953d2017-04-17 13:13:13 -070035- `@lukesneeringer <https://github.com/lukesneeringer>`_ (Luke Sneeringer)
Jon Wayne Parrott377f2932016-10-04 10:20:36 -070036
37Contributing
38------------
39
40Contributions to this library are always welcome and highly encouraged.
41
Jon Wayne Parrott246df812016-10-21 14:31:06 -070042See `CONTRIBUTING.rst`_ for more information on how to get started.
Jon Wayne Parrott377f2932016-10-04 10:20:36 -070043
Jon Wayne Parrott246df812016-10-21 14:31:06 -070044.. _CONTRIBUTING.rst: https://github.com/GoogleCloudPlatform/google-auth-library-python/blob/master/CONTRIBUTING.rst
Jon Wayne Parrott377f2932016-10-04 10:20:36 -070045
46License
47-------
48
Jon Wayne Parrott246df812016-10-21 14:31:06 -070049Apache 2.0 - See `the LICENSE`_ for more information.
Jon Wayne Parrott377f2932016-10-04 10:20:36 -070050
Jon Wayne Parrott246df812016-10-21 14:31:06 -070051.. _the LICENSE: https://github.com/GoogleCloudPlatform/google-auth-library-python/blob/master/LICENSE