Commit Graph

194 Commits

Author SHA1 Message Date
Nihaal 9cdf294107 Updated references to previous requests/requests GitHub path 2019-08-19 21:33:18 +01:00
Min ho Kim 5f576ad22f Fix typos 2019-07-20 01:46:08 +10:00
Tom Christie 6f6d0164a9 Add requests-async link to "non-blocking" docs.
Links to https://github.com/encode/requests-async for an asyncio non-blocking option.
2019-03-27 10:09:19 +00:00
Andrew Bonney 827bbe2a7e docs: correct error in 'merge_environment_settings' usage
Resolves #4959
2019-02-04 13:28:12 +00:00
Jon Dufresne b0ad2499c8 Prefer https:// for URLs throughout project 2018-09-30 17:14:40 -05:00
Jon Dufresne 5aa6a9b654 In docs, use intersphinx to link to Python documentation
The intersphinx extension can generate automatic links to the
documentation of objects in other projects. It was already used for
urllib3. For complete details on intersphinx, see:

http://www.sphinx-doc.org/en/master/ext/intersphinx.html
2018-08-11 17:31:43 -07:00
Jon Dufresne 35a1874912 Update Python 2 doc links to Python 3
The Python 3 docs are better maintained and are the future of Python
development.
2018-06-09 20:29:41 -07:00
Nick Timkovich 919c168cdb Certifi.io broken
http://certifi.io/ -> https://certifiio.readthedocs.io/
2018-05-14 09:55:33 -05:00
Victor Shih 71e402fe40 Spelling. 2018-05-07 10:51:53 -07:00
Jon Dufresne 165804b25e Update all pypi.python.org URLs to pypi.org
For details on the new PyPI, see the blog post:

https://pythoninsider.blogspot.ca/2018/04/new-pypi-launched-legacy-pypi-shutting.html
2018-04-18 20:28:19 -07:00
Jon Dufresne 265ef609d5 Remove remaining references to removed, vendored packages (#4499)
As the vendored packages were removing in version 2.16, all remaining
doc references should be replaced with newer practices.
2018-02-17 08:15:54 -06:00
Jon Dufresne 9c0db92249 Clarify docs that Requests always uses certs from certifi
Since commit 0d7de6430e, certifi is always
used for certificates. Certify became a hard dependency of the package
in 628633143d.

Now update the docs to clarify that Request will always use certificates
from certifi.
2018-02-14 05:47:34 -08:00
Jon Dufresne e8205c0131 Trim trialing white space throughout the project
Many editors clean up trailing white space on save. By removing it all
in one go, it helps keep future diffs cleaner by avoiding spurious white
space changes on unrelated lines.
2018-02-05 06:23:53 -08:00
Jon Dufresne 030dcce20c Prefer https over http for links in the documentation
- Fixed Read the Docs links
- Fixed GitHub links
- Fixed PyPI links
2018-01-06 11:23:50 -08:00
Alex Chan c5ed41e00a Add an example of two hooks 2017-10-24 07:27:55 +01:00
Alex Chan 40c5a8b0c2 Clarify that a Session can have multiple hooks 2017-10-23 13:25:46 +01:00
Alex Chan 87f3b0a559 Switch to using dict literals, it's 2017 2017-10-23 13:25:31 +01:00
Alex Chan 2c4849defe Add something to the docs about hooks on Session() 2017-10-23 08:30:35 +01:00
kennethreitz c04b044b30 Update advanced.rst 2017-09-04 16:09:08 -04:00
kennethreitz 8be8105c42 Update advanced.rst 2017-09-04 15:53:26 -04:00
Pascal Van Acker ac9a3e5320 fixed syntax for code block for prepared requests 2017-08-28 11:14:05 +02:00
Pascal Van Acker 785c733415 Add environment info to prepared requests
When using prepared requests, the environment is not taken into account. This should be reflected in the documentation.
2017-08-28 10:58:44 +02:00
NikosVlagoidis 218978601f Fix issue #3863 2017-08-09 20:18:43 +03:00
NikosVlagoidis cb9620780f Update advanced.rst 2017-08-09 18:52:26 +03:00
Nikolaos Vlagoidis 963c78853f Fixes issue #3863 2017-08-09 15:38:45 +03:00
Ed Morley 4847f5b8cd Allow Requests.Response to be used as a context manager
This saves having to wrap the call to requests with
`contextlib.closing()`, allowing it to be used directly in a
`with` statement, like so:

```
with requests.get('http://httpbin.org/get', stream=True) as r:
    # Do things with the response here.
```

Fixes #4136.
2017-06-06 23:30:47 +01:00
kennethreitz 7f14db17c8 new requests namespace 2017-05-29 12:11:43 -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
Nate Prewitt f5c5536916 updating https demo urls 2017-01-04 15:23:23 -07: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
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
kennethreitz 6c9a0eff04 compensate for lack of taste 2016-06-09 00:38:53 -04: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 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