Add basic user guide by theacodes · Pull Request #79 · googleapis/google-auth-library-python

theacodes · 2016-11-08T22:20:31Z

These are staged here: http://temp.theadora.io/google-auth/index.html

Resolves #44.

docs/index.rst

+- Support for various transports, including
+  :mod:`Requests <google.auth.transport.requests>`,
+  :mod:`urllib3 <google.auth.transport.urllib3>`, and
+  :mod:`gRPC <google.auth.transport.grpc>`.


docs/index.rst

+Installing
+----------
+
+google-auth can be installed with `pip <https://pip.pypa.io>`_::


docs/index.rst

+
+google-auth can be installed with `pip <https://pip.pypa.io>`_::
+
+    $ pip install google-auth


docs/user-guide.rst

+User Guide
+==========
+
+.. currentmodule:: google.auth


docs/user-guide.rst

+user accounts are obtained by asking the user to authorize access to their data.
+These types of credentials are used in cases where your application needs access
+to a user's data in another service, such as accessing a user's documents in
+Google Drive.


docs/user-guide.rst

+User credentials are typically obtained via `OAuth 2.0`_. This library does not
+provide any support for *obtaining* user credentials, however, you can use user
+credentials with this library. You can use libraries such as `oauthlib`_ or
+`oauth2client`_ to obtain the access token. After you have an access token, you


docs/user-guide.rst

+.. _Requests: http://docs.python-requests.org/en/master/
+.. _Session: http://docs.python-requests.org/en/master/user/advanced/#session-objects
+
+Urllib3


docs/user-guide.rst

+    import google.auth.transport.grpc
+    import google.auth.transport.requests
+
+    http_request = google.auth.transport.requests.Request()


docs/user-guide.rst

+        credentials, 'pubsub.googleapis.com:443', http_request)
+
+.. note:: Even though gRPC is its own transport, you still need to use one of
+    the other HTTP transports with gRPC. The reason is that most credential


docs/user-guide.rst

+        ssl_credentials, google_auth_credentials)
+
+    channel = grpc.secure_channel(
+        'pubsub.googleapis.com:443', composite_credentials)


dhermes · 2016-11-10T18:41:45Z

LGTM

Add basic user guide

728ba47

theacodes added this to the 1.0.0 milestone Nov 8, 2016

theacodes assigned dhermes Nov 8, 2016

dhermes reviewed Nov 9, 2016

View reviewed changes

Address review comments

546ad15

theacodes merged commit 53c7b17 into master Nov 10, 2016

theacodes deleted the usage-docs branch November 10, 2016 18:45

theacodes unassigned dhermes Oct 11, 2018


		google-auth can be installed with `pip <https://pip.pypa.io>`_::

		$ pip install google-auth

Conversation

theacodes commented Nov 8, 2016

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

dhermes commented Nov 10, 2016

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants