Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(136)

Unified Diff: recipe_engine/third_party/requests/docs/user/authentication.rst

Issue 2164713003: Vendor requests. (Closed) Base URL: https://chromium.googlesource.com/external/github.com/luci/recipes-py@master
Patch Set: Fix deps.pyl Created 4 years, 5 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
Index: recipe_engine/third_party/requests/docs/user/authentication.rst
diff --git a/recipe_engine/third_party/requests/docs/user/authentication.rst b/recipe_engine/third_party/requests/docs/user/authentication.rst
deleted file mode 100644
index 2779e9c85a13e4b753c58659acdd6886b61f8b6d..0000000000000000000000000000000000000000
--- a/recipe_engine/third_party/requests/docs/user/authentication.rst
+++ /dev/null
@@ -1,128 +0,0 @@
-.. _authentication:
-
-Authentication
-==============
-
-This document discusses using various kinds of authentication with Requests.
-
-Many web services require authentication, and there are many different types.
-Below, we outline various forms of authentication available in Requests, from
-the simple to the complex.
-
-
-Basic Authentication
---------------------
-
-Many web services that require authentication accept HTTP Basic Auth. This is
-the simplest kind, and Requests supports it straight out of the box.
-
-Making requests with HTTP Basic Auth is very simple::
-
- >>> from requests.auth import HTTPBasicAuth
- >>> requests.get('https://api.github.com/user', auth=HTTPBasicAuth('user', 'pass'))
- <Response [200]>
-
-In fact, HTTP Basic Auth is so common that Requests provides a handy shorthand
-for using it::
-
- >>> requests.get('https://api.github.com/user', auth=('user', 'pass'))
- <Response [200]>
-
-Providing the credentials in a tuple like this is exactly the same as the
-``HTTPBasicAuth`` example above.
-
-
-netrc Authentication
-~~~~~~~~~~~~~~~~~~~~
-
-If no authentication method is given with the ``auth`` argument, Requests will
-attempt to get the authentication credentials for the URL's hostname from the
-user's netrc file. The netrc file overrides raw HTTP authentication headers
-set with `headers=`.
-
-If credentials for the hostname are found, the request is sent with HTTP Basic
-Auth.
-
-
-Digest Authentication
----------------------
-
-Another very popular form of HTTP Authentication is Digest Authentication,
-and Requests supports this out of the box as well::
-
- >>> from requests.auth import HTTPDigestAuth
- >>> url = 'http://httpbin.org/digest-auth/auth/user/pass'
- >>> requests.get(url, auth=HTTPDigestAuth('user', 'pass'))
- <Response [200]>
-
-
-OAuth 1 Authentication
-----------------------
-
-A common form of authentication for several web APIs is OAuth. The ``requests-oauthlib``
-library allows Requests users to easily make OAuth authenticated requests::
-
- >>> import requests
- >>> from requests_oauthlib import OAuth1
-
- >>> url = 'https://api.twitter.com/1.1/account/verify_credentials.json'
- >>> auth = OAuth1('YOUR_APP_KEY', 'YOUR_APP_SECRET',
- 'USER_OAUTH_TOKEN', 'USER_OAUTH_TOKEN_SECRET')
-
- >>> requests.get(url, auth=auth)
- <Response [200]>
-
-For more information on how to OAuth flow works, please see the official `OAuth`_ website.
-For examples and documentation on requests-oauthlib, please see the `requests_oauthlib`_
-repository on GitHub
-
-
-Other Authentication
---------------------
-
-Requests is designed to allow other forms of authentication to be easily and
-quickly plugged in. Members of the open-source community frequently write
-authentication handlers for more complicated or less commonly-used forms of
-authentication. Some of the best have been brought together under the
-`Requests organization`_, including:
-
-- Kerberos_
-- NTLM_
-
-If you want to use any of these forms of authentication, go straight to their
-GitHub page and follow the instructions.
-
-
-New Forms of Authentication
----------------------------
-
-If you can't find a good implementation of the form of authentication you
-want, you can implement it yourself. Requests makes it easy to add your own
-forms of authentication.
-
-To do so, subclass :class:`AuthBase <requests.auth.AuthBase>` and implement the
-``__call__()`` method::
-
- >>> import requests
- >>> class MyAuth(requests.auth.AuthBase):
- ... def __call__(self, r):
- ... # Implement my authentication
- ... return r
- ...
- >>> url = 'http://httpbin.org/get'
- >>> requests.get(url, auth=MyAuth())
- <Response [200]>
-
-When an authentication handler is attached to a request,
-it is called during request setup. The ``__call__`` method must therefore do
-whatever is required to make the authentication work. Some forms of
-authentication will additionally add hooks to provide further functionality.
-
-Further examples can be found under the `Requests organization`_ and in the
-``auth.py`` file.
-
-.. _OAuth: http://oauth.net/
-.. _requests_oauthlib: https://github.com/requests/requests-oauthlib
-.. _Kerberos: https://github.com/requests/requests-kerberos
-.. _NTLM: https://github.com/requests/requests-ntlm
-.. _Requests organization: https://github.com/requests
« no previous file with comments | « recipe_engine/third_party/requests/docs/user/advanced.rst ('k') | recipe_engine/third_party/requests/docs/user/install.rst » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698