Commit Graph

152 Commits

Author SHA1 Message Date
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 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 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
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
Cory Benfield 0352ec0bd3 Add support for a directory of CAs 2015-11-05 13:21:21 +00:00
Cory Benfield 7c55446b7e Add warnings about text/binary mode files. 2015-10-14 13:23:19 +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
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
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
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
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
Cory Benfield 84cc36017a Expand on chunked handling. 2015-03-18 21:31:55 +00:00
Priit Laes 4497a26c37 Document Response.iter_lines() reentrancy issues 2015-03-07 12:00:41 +02: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
Jan Kundrát 3635b1501d docs: Clarify how to pass a custom set of CAs
This new wording makes it hopefully easier to find how to override the
system-provided list of trusted CAs. I failed to find this through some googling
and had to resort to asking on IRC previously.
2014-09-25 20:06:04 +02:00
Martin Jul 0924069b68 Moved multiple files upload example to advanced section. 2014-09-16 11:54:31 +02:00
kennethreitz 359659cf4b Merge pull request #2203 from Lukasa/remove_certifi
Remove hard certifi dependency and document.
2014-09-05 08:11:57 -07:00
Cory Benfield 9c6ae1dc0b Link to Mozilla trust store. 2014-09-04 19:44:37 +01:00
Cory Benfield a77054f90f Remove hard certifi dependency and document. 2014-09-04 19:40:15 +01:00
kennethreitz 07bbe214aa Merge pull request #2187 from kevinburke/more-docs
Document Timeout behaviour
2014-09-04 11:39:12 -07:00
Kevin Burke 81d6b3e435 s/behavior/behaviour 2014-08-29 11:51:09 -07:00
Kenneth Reitz 1fcda912db Revert "Documentation update : connection keep alive"
This reverts commit 1b2602344f.

Conflicts:
	docs/user/advanced.rst
2014-08-29 10:30:49 -04:00
Kevin Burke c2aeaa3959 Add support for connect timeouts
Modifies the timeout interface to also accept a tuple (connect, read) which
would be used to set individual connect and read timeouts for Requests. Adds
Advanced documentation explaining the interface and providing guidance for
timeout values.
2014-08-23 15:12:29 -07:00
Cory Benfield 1c20d01f10 Cleanup grammar from previous commit. 2014-08-22 11:50:37 +01:00
tat3657 1b2602344f Documentation update : connection keep alive 2014-08-22 10:39:05 +02:00
Espartaco Palma 698b93b86d Docs: Using print() function instead print command on advanced & quickstart user docs 2014-07-18 11:44:57 -05:00
David Pursehouse 44e426e4ff More line wrapping
Change-Id: I950c3da727fb97b58d96a872b0d2ed718cc60ba8
2014-07-18 16:35:54 +09:00
David Pursehouse 2a6303e018 Docs: Fix :class: and :meth: directives
A few instances of the directives were malformed and did not
result in hyperlinks in the generated HTML.

Change-Id: I94d93de928ee4ff24a48797baf2ac77598a20704
2014-07-16 10:50:57 +09:00
Udi Oron 6dc13f2194 removed unneeded parentheses from if clause 2014-07-15 19:56:47 +03:00
Tshepang Lekhonkhobe 36b6c37496 Fix broken link 2014-07-14 16:13:23 +02:00
Cory Benfield a2413e010f Ensure that we open files in binary mode. 2014-05-28 16:59:57 +01:00
Paweł Romanowski a7e7241616 Fix typo in advanced.rst docs
`Sesssion` -> `Session`
2014-05-13 10:11:40 +02:00
Aaron Iles 8a0bae45c2 Move SNI documentation to FAQ
Relocate documentation on Server-Name-Indication from the advanced
section to the frequently asked questions. This is minus details on
enabling SNI on Python2, which is instead captured by linking to Stack
Overflow.
2014-02-02 22:19:10 +11:00
Aaron Iles b5b8198fd1 Document requirements for SNI support on Python2
A section for Request's advanced usage guide on what Server Name
Indication is, its purpose, and how to enable it on Python2.
2014-02-02 20:14:05 +11:00