Commit Graph

387 Commits

Author SHA1 Message Date
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
Antti Kaihola 9c92f757e6 Rolled multi-value form examples in documentation into one (#4700)
As suggested by @nateprewitt
2018-07-20 10:30:31 +03:00
Antti Kaihola 9a8eb131c9 Documentation for multivalued form-encoded element as a list (#4700) 2018-07-20 10:30:31 +03: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
Hackbright Student 35af0b077f add comment about json parameter changing content-type 2018-03-16 12:34:24 -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
Daniel Roseman 39446def39 Clarify behaviour of json parameter.
`json` is ignored if `data` or `files` is not empty.
2017-11-21 13:40:59 +00:00
Dave Shawley 7cc3d8dc6a docs/quickstart: clarify raw response reading. 2017-11-17 16:37:08 -05:00
Tal Einat 7f08ad3b6c Corrent HTTP -> HTML in quickstart doc 2017-11-16 09:59:00 +02: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 afaaae185c Update authentication.rst 2017-09-04 16:10:49 -04:00
kennethreitz 8af65a1eca Update quickstart.rst 2017-09-04 16:09:51 -04:00
kennethreitz c04b044b30 Update advanced.rst 2017-09-04 16:09:08 -04:00
kennethreitz 530198e0c0 Update install.rst 2017-09-04 16:08:22 -04:00
kennethreitz 8c57515696 Update intro.rst 2017-09-04 16:05:57 -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
kennethreitz 3cceee3459 Update install.rst 2017-08-27 23:16:32 -04: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 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