Commit Graph

312 Commits

Author SHA1 Message Date
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
kennethreitz f6252c2203 improved installation instructions 2016-02-18 20:59:01 -05:00
Jochen Kupperschmidt 0d25f8a00c Fixed markup for/rendering of list in section "Custom Headers". 2016-01-30 14:45:07 +01:00
Cory Benfield 5887b136e3 Warn about encrypted keys in the docs. 2016-01-27 11:56:27 +00:00
Vincent Bernat f14f30817e advanced: use "client.*" to designate client certificate
Using "server.crt" is confusing as one may try to put the server certificate while this is really the client certificate that should be put here. Instead, use "client.cert", "client.key" and "client.pem".
2015-12-28 16:21:53 +01:00
Isa Hassen fcb8c8d33b Docs: clarify the precedence of auth= over netrc
This closes #2062 by clarifying in the docs which auth
header takes precedence:
1st auth=
2nd .netrc
3rd headers=

This precedence order is already tested in test_requests.py,
in the test_basicauth_with_netrc method. Perhaps we should
add further tests for non-basic auth schemes.
2015-12-21 11:52:45 -05:00
unknown de2a5f4332 Remove redundant json import. 2015-11-12 16:54:47 +03:00
Cory Benfield 0352ec0bd3 Add support for a directory of CAs 2015-11-05 13:21:21 +00:00
Ian Cordasco d290a9b4c6 Merge pull request #2825 from Lukasa/universal_newlines
Add warnings about text/binary mode files.
2015-10-24 09:37:16 -05:00
shagun Sodhani b675377dc2 added fix for #2826 2015-10-16 17:01:36 +05:30
Cory Benfield 7c55446b7e Add warnings about text/binary mode files. 2015-10-14 13:23:19 +01:00
Cory Benfield 139418475c Remove reference to ok. 2015-10-03 18:33:25 +01:00
Hosam Aly 443d07e0d3 Fix #2799: Update Quickstart documentation of Response.json() 2015-10-03 00:01:58 +01:00
Jim Browne 2cee3bb57a docs: move CA Certificates next to SSL Cert Verification 2015-09-11 10:50:23 -07:00
Jakub Wilk e9c94e0f06 docs: Fix typos 2015-09-10 22:45:59 +02:00
Cory Benfield 56ecdebcc5 Merge pull request #2741 from jasongrout/per-host-proxy
Implement per-host proxies
2015-09-06 15:02:40 +12:00
Maximilian Hils f4eaefa63e fix rfc quotation 2015-09-05 12:07:49 +02:00
Jason Grout 704a922fc2 Clarify documentation for per-host proxies
Make sure it's clear that a per-host proxy matches a scheme and exact
hostname.
2015-09-04 22:55:38 +00:00
Cory Benfield 7c958ee28e Document the string form of the verify parameter. 2015-08-31 10:26:06 +01:00
Jason Grout 618514231b Reword documentation for per-host proxies 2015-08-25 15:11:27 +00:00
Jason Grout 56844d1287 Add documentation for host-specific proxies 2015-08-25 14:53:52 +00:00
Baptiste Mispelon 7197afa887 Fixed minor rendering issue in documentation code blocks 2015-08-15 21:56:24 +02:00
Cory Benfield 98a59e4894 Merge pull request #2724 from smiley/master
Add documentation in "More complicated POST requests" (Quickstart) to resolve #2686
2015-08-14 15:30:00 -04:00
Smiley Barry b1de7e7287 Changed phrasing to be a little clearer. 2015-08-14 17:31:54 +03:00
Smiley Barry 5a9097dc4b Update quickstart.rst
Added note about the `json` parameter in `requests.post`.
2015-08-14 17:15:51 +03:00
Lukas Graf 1bb91653cc Docs: Clarify that method-level params are not persisted in sessions. 2015-08-08 01:57:06 +02:00
Lukas Graf 8f3ddbeefb Mention connection pooling in session docs. 2015-08-07 20:48:07 +02:00
Lukas Graf 75c1776bde Document use of sessions as context managers. 2015-08-07 20:48:03 +02:00
Christopher Peplin 6648defcdd Fix docs for passing a list of values for a query string
The special `[]` notation at the end of the field name is not necessary to get a field to appear with multiple values in the query string.
2015-07-18 18:50:29 -04:00
Ian Cordasco d0aecb271f Merge pull request #2506 from Lukasa/chunkeddocs
Expand on chunked handling.
2015-07-18 10:44:31 -05:00
Cory Benfield 2b5cdc56f3 Expand on chunk length 2015-07-18 16:41:29 +01:00
Peter Marsh beaa7e4180 Fix quickstart "Custom Headers" example intro
Previously this section prefaced an example with:

    For example, we didn't specify our content-type

But, the actual example set a custom user-agent header on the request. This
changes it to say "user-agent" instead which matches the given example.
2015-07-15 23:31:21 +01:00
Andrew Widdersheim 7ba130a0cb Docs: Add more section labels for referencing
Allows for sections to be linked from other projects using Intersphinx.
2015-05-26 09:16:24 -04:00
benjaminran 1b1866934b updated custom header precedence info with .netrc example 2015-04-05 14:23:10 -07:00
benjaminran 898465756a added custom header precedence info 2015-04-03 07:58:42 -07:00
Cory Benfield 84cc36017a Expand on chunked handling. 2015-03-18 21:31:55 +00:00
M.Yasoob Ullah Khalid ☺ 3711e04f37 edited the useragent string 2015-03-15 22:42:43 +05:00
M.Yasoob Ullah Khalid ☺ 6e2f1eb402 made the quickstart more reader friendly. Closes #2418 2015-03-15 01:02:09 +05:00
Priit Laes 4497a26c37 Document Response.iter_lines() reentrancy issues 2015-03-07 12:00:41 +02:00
requiredfield ed73d9e45d document combination of repeated response headers 2015-02-20 12:20:18 -06:00
Nicholas Avenell 291b6b24b7 Update to use readthedocs.org instead of rtfd.org
https://toolbelt.rtfd.org causes an SSL error because the wildcard SSL cert is for *.readthedocs.org.
2015-02-06 13:46:38 +00:00
Tom S 53f33eb473 quickstart: using a list as a value in query params 2015-02-03 09:19:30 +00:00
rakesh 508f4b1ca5 Updated the broken link to twitter streaming API documentation 2014-12-09 01:59:55 +05:30
Dan Michael O. Heggø 8b03f60278 Docs: Add more section labels for referencing
so sections can be linked from other projects using Intersphinx
2014-11-17 11:39:33 +01:00