Commit Graph

355 Commits

Author SHA1 Message Date
kennethreitz 008ab18a77 improve installation docs 2017-05-29 23:33:51 -04:00
kennethreitz 67831abaaf improve install docs 2017-05-29 23:33:25 -04:00
kennethreitz 35f2e55308 improve installation instructions 2017-05-29 23:26:15 -04:00
kennethreitz 84114419a0 improve install documentation syntax 2017-05-29 23:25:21 -04:00
kennethreitz 7f14db17c8 new requests namespace 2017-05-29 12:11:43 -04:00
kennethreitz 14c1102e0f new installation location 2017-05-29 12:08:28 -04:00
kennethreitz b9a004a22b improvements 2017-05-27 17:25:44 -04:00
kennethreitz 2e67c86075 merge 2017-05-27 17:24:06 -04:00
kennethreitz 6fb9b1ce53 fix lack of taste
Signed-off-by: Kenneth Reitz <me@kennethreitz.org>
2017-05-21 23:25:18 -07:00
Anthony Shaw 3cb7539981 Update advanced.rst
break client side certificates out into a sub header
2017-04-02 20:21:37 +10:00
Brian Schiller e0ba82949b Change apostrophe placement in advanced.rst
See Rule2a on http://www.grammarbook.com/punctuation/apostro.asp
2017-03-14 10:09:41 -05:00
Gary Wu 21972c4601 fix #3902 Add proposed documentation change for post data 2017-03-01 13:04:11 -06:00
Cory Benfield 08ce652b8b Say that we use a dictionary of strings. 2017-02-08 11:54:32 +00:00
Nick Coghlan 775d19ee05 Explicitly mention OpenID Connect
OAuth 2 is the authentication protocol underpinning OpenID Connect.

Mention that explicitly for the benefit of folks looking for information on using
requests with OpenID Connect that don't yet know that OAuth 2 is the
relevant underlying authentication protocol.
2017-01-10 15:31:20 +10:00
Nick Coghlan 4942b40496 Improve discoverability of OAuth 2 support
The previous summary gave the impression that requests-oauthlib only supports
OAuth 1.

This updates makes it clear that it also supports OAuth 2, and links directly to the
use case specific authentication flow guides.
2017-01-10 15:17:08 +10:00
Nate Prewitt f5c5536916 updating https demo urls 2017-01-04 15:23:23 -07:00
Nate Prewitt 4f9d0e0455 streaming doc clarification 2016-11-21 14:17:28 -07:00
Aidan Feldman ed3ba3dbb8 correct backtick formatting 2016-11-17 12:26:19 -05:00
Aidan Feldman 5562c0f097 clarify that the chunk_size is optional when streaming to a file 2016-11-17 12:21:58 -05:00
Greg McLeod b4d843bad2 Fixed readme typo - 'site' should be 'domain' 2016-11-15 22:27:45 -05:00
Mike Lissner cfb7fd8f28 Amplifies the timeout warning in the docs.
Partially addresses #3070.
2016-11-14 09:57:08 -08:00
Nate Prewitt d81ad06c64 documentation on encoding fallback for streaming 2016-11-14 09:52:40 -07:00
Nate Prewitt 71b8941f0e adding decoding requirement for Python 3 2016-11-14 09:43:19 -07:00
Bård Aase 388e949e83 Formatted the example to fix the color highlighting 2016-10-31 09:09:16 +01:00
Cory Benfield 02ab1ba5bd Let's use capitals. 2016-10-12 11:11:05 +01:00
Stewart Polley 341bed9e17 Add Documentation for custom methods 2016-10-08 06:22:07 +10:00
Om Prakash 06920cc266 fixes broken link on documentation page
Issue #3603
2016-09-28 16:34:02 +05:30
Richard van den Berg 2cd05271be Add persistent examples 2016-08-26 09:43:11 +02:00
Maik b5fac31688 Changes to documentation based on comments and correction of list of authors. 2016-08-17 22:03:18 +02:00
Maik Himstedt b26606cc3c Adding notes about Request's timeout behavior. 2016-08-17 20:27:00 +02:00
Nate Prewitt 1435cf5aff docs updates 2016-08-14 20:56:52 -06:00
Jiayuan Zhang 00f83fb0c6 fix grammer mistakes in Quickstart 2016-08-13 10:19:10 +08:00
Michael 07b7872df8 Add a bit about RequestsCookieJar to Cookies section 2016-08-03 13:03:34 -07:00
Zeusw cf938420f8 in python3.x not have StringIO
I think, should such an amendment.
2016-07-14 10:40:32 +08:00
Nate Prewitt 1cb3b797fe updating documentation to reflect decision of #3386 2016-07-07 07:44:20 -06:00
kennethreitz e12ee9407c Merge pull request #3297 from davidfischer/http-error-specifics
Note how HTTPErrors are raised
2016-06-08 23:57:44 -07:00
kennethreitz 6c9a0eff04 compensate for lack of taste 2016-06-09 00:38:53 -04:00
David Fischer 277d4a41ad Note how HTTPErrors are raised 2016-06-08 18:19:10 -07:00
Cory Benfield 7a404cf4ec Document header ordering. (#3295) 2016-06-08 11:44:33 -05:00
Ian Cordasco 3669b4216a Merge pull request #3173 from Lukasa/socks-proxy-docs
Add section on SOCKS proxies.
2016-05-05 12:18:27 -05:00
Cory Benfield 339e950dc7 Add section on SOCKS proxies. 2016-05-03 08:07:30 +01:00
Lukas Vacek 52facb2257 docs: Add a note about SSL c_rehash 2016-05-02 23:03:35 +02:00
Rémy HUBSCHER 70a344d8eb Update readthedocs links. 2016-04-28 12:39:10 +02:00
Kevin Burke e94c812c2d Clarify that SSL verification is on by default
Generally if a kwarg is present it indicates that an option other than the
default is being specified. Putting `verify=True` in the first code sample
for SSL confused me, because it seemed to indicate that you had to specify
`verify=True` to get SSL verification. The opposite is true; SSL verification
is turned on by default and you have to specify `verify=False` to opt out of
SSL verification.

Updates the docs to make this more clear. Furthermore, connections to
https://kennethreitz.com currently time out instead of presenting an invalid
certificate, so I replaced this domain with https://requestb.in, which presents
the same error message as is currently there.
2016-03-17 08:16:56 -07:00
kennethreitz ca303cda0a letters 2016-02-19 06:14:51 -05:00
kennethreitz f8af499700 improve further advanced.rst 2016-02-19 02:45:07 -05:00
kennethreitz f4445b3d4f improve advanced.rst 2016-02-19 02:42:22 -05:00
kennethreitz bf8c8312dd cleanup quickstart 2016-02-19 02:12:15 -05:00
kennethreitz f4f863f168 cleanup advanced.rst
single-quoted strings, yo!
2016-02-19 02:06:33 -05:00
kennethreitz e98d71de13 docs cleanup 2016-02-19 00:56:14 -05:00