Commit Graph

393 Commits

Author SHA1 Message Date
libbkmz 78e5262dbd Update advanced.rst 2013-08-19 00:01:37 +04:00
enkore 4ffc3e4d1f Remove superfluous double dot 2013-08-18 03:06:34 +02:00
David Pursehouse 62f0df4434 Add a simple example of custom authentication in the documentation
Refs #1471
2013-07-22 09:14:33 +09:00
David Pursehouse 5cdcf58b3b Wrap long lines in the authentication documentation 2013-07-22 09:08:47 +09:00
Kwpolska 2ef782b8e6 further treatment
Signed-off-by: Kwpolska <kwpolska@gmail.com>
2013-07-20 13:54:33 +02:00
Kwpolska b738c97ec3 session object should be uppercase
Signed-off-by: Kwpolska <kwpolska@gmail.com>
2013-07-20 13:39:50 +02:00
Kwpolska 022c370bcd fixed underline
Signed-off-by: Kwpolska <kwpolska@gmail.com>
2013-07-20 13:31:37 +02:00
Kwpolska 587385bfe0 Grammar fixes and such
Signed-off-by: Kwpolska <kwpolska@gmail.com>
2013-07-20 12:56:25 +02:00
Kwpolska ca033b83fe Some cosmetic updates to the docs
Signed-off-by: Kwpolska <kwpolska@gmail.com>
2013-07-20 12:12:57 +02:00
Cory Benfield 949a29c34f Merge pull request #1470 from Lukasa/carset
Remove charset from JSON types: not valid.
2013-07-19 06:45:56 -07:00
Cory Benfield be884341f4 Merge pull request #1465 from dpursehouse/doc-netrc-authentication
Improve documentation of netrc authentication
2013-07-19 06:45:17 -07:00
David Pursehouse c88fd8cc9d Move netrc authentication documentation under the Basic Auth section 2013-07-19 22:37:57 +09:00
Cory Benfield 8385fb397b Remove charset from JSON types: not valid. 2013-07-19 14:03:20 +01:00
s7v7nislands 39ad5e7388 merge 2013-07-19 17:12:01 +08:00
s7v7nislands 0df505bd7c fix doc 2013-07-19 17:04:53 +08:00
David Pursehouse 6f6a920a68 Improve documentation of netrc authentication
The documentation does not make it clear that when the credentials
from netrc are used, Requests authenticates with HTTP Basic Auth.

I just spent ages trying to figure out why it wasn't working, and
it was because although the credentials in the netrc were correct,
the server actually required HTTP Digest Auth.

Add a section in the authentication documentation to make it clear
that HTTP Basic Auth is used.
2013-07-19 17:30:54 +09:00
David Pursehouse 07ad75ee04 Fix #1322: Add note in docs about None not being sent as data
In the case:

  payload = {'key1': 'value1', 'key2': 'value2', 'key3': None}
  r = requests.get("http://httpbin.org", params=payload)

the parameter `key3` will not be sent as a parameter in the URL.

Mention this in the documentation.
2013-07-19 17:14:59 +09:00
Lukasz Balcerzak 805abee9b4 Fixed wrong method call at streaming example
405 is returned if POST request is performed to http://httpbin.org/stream/20
2013-06-27 13:37:39 +02:00
Cory Benfield d57a5efab3 Packaging warning, in via @andrewgross. 2013-06-22 15:02:18 +01:00
Kevin Burke a6415cf895 Link to the actual exception references
Sphinx has a neat cross-referencing feature where if you include the tilde
character in front of a :py: class, it'll link to the full object but provide
only the last part of class name in the text. For more info see
http://sphinx-doc.org/domains.html#cross-referencing-syntax
2013-06-12 15:53:09 -07:00
Josh Schneier 43a64d9515 fix doc typo 2013-06-09 11:14:14 -04:00
Kenneth Reitz cfd84d74ee Merge pull request #1392 from revolunet/patch-2
Update quickstart.rst
2013-06-08 03:16:21 -07:00
Cory Benfield 73425fbffb Remove development reference from docs sidebar. 2013-06-08 11:10:07 +01:00
Cory Benfield f53aed1611 Document blocking calls. 2013-06-08 11:09:39 +01:00
Julien Bouquillon 340931ba8e Update quickstart.rst
rephrase misleading info about `raise_for_status`
2013-05-29 12:57:49 +03:00
giacomo 8781b56a0e Fixed example in authentication docs 2013-05-02 18:16:19 +03:00
Kenneth Reitz 4f83ef8328 Merge pull request #1314 from duailibe/master
Fix small typo in the Support docs
2013-05-01 10:29:40 -07:00
amercader 505d2487e3 Fix API documentation issues
* 'Cookies' and 'Encodings' sections were not built because the
  reference to the functions was wrong.
* 'Exceptions' section had a wrong anchor link ('module-requests', same
   one as the main heading).
* Remove 'decode_gzip' function, which is no longer present.
2013-04-30 16:15:56 +02:00
Chris Warrick c3bef6b0d9 A tiny typo, noticed while working on the Polish translation. 2013-04-27 14:52:35 +03:00
Kenneth Reitz 8f3f4e2744 milla 2013-04-20 00:22:13 -04:00
Kenneth Reitz 65b6ef6036 pt 2013-04-20 00:18:27 -04:00
Lucas Duailibe 1ca423ec80 Fix small typo in the Support docs 2013-04-18 20:59:17 -03:00
Kenneth Reitz ae5419db17 translations 2013-04-15 03:22:56 -04:00
Kenneth Reitz 9c2f9f61ef Translatoins 2013-04-15 03:22:48 -04:00
Kenneth Reitz 636476e704 Merge remote-tracking branch 'origin/master' 2013-04-15 03:21:40 -04:00
Kenneth Reitz aafca7acdc translations 2013-04-15 03:21:32 -04:00
Kenneth Reitz 9df450193f Merge pull request #1302 from ssbarnea/master
Documents the actual logging methods #1297
2013-04-13 20:25:47 -07:00
Kenneth Reitz 082029ff2e switch streaming requests to httpbin 2013-04-13 15:26:49 -04:00
Mike Helmick ed0242ae3a Fix Advanced docs Twitter Streaming example
Twitter API v1.1 Streaming now requires OAuth Authentication rather than XAuth.
I believe v1 is being blacked out sometime at the beginning of May.
2013-04-11 20:19:51 -04:00
Sorin Sbarnea fb49481ddf Updated documentation indicating that logging is done via requests.packages.urllib3 instead of requests.
modified:   docs/api.rst
2013-04-10 16:46:05 +01:00
Sorin Sbarnea 17ecb6891c * Documented the logging, requested in #1297
* Added build directory and *.egg to .gitignore
* Added sphinx as setup requirement in order to be able to build documentation with `pyhton setup.py build_sphinx`

modified:   .gitignore
modified:   docs/api.rst
modified:   setup.py
2013-04-10 16:15:28 +01:00
Cory Benfield e5f1053b30 Shell of Transport Adapter documentation. 2013-04-09 20:58:59 +01:00
Cory Benfield c73f653352 Add HTTPAdapter to API docs. 2013-04-09 19:54:47 +01:00
Sasha Laundy 8ebeb3dc3f Make json error message more specific 2013-04-08 13:03:13 -04:00
sursh dfa59c2d97 Fix markdown 2013-04-08 13:01:02 -03:00
sursh 511cc4c034 Make json error on empty response more specific 2013-04-08 13:00:27 -03:00
Ian Cordasco b9e5cce2d2 Add PreparedRequest recipe to the docs 2013-04-02 10:07:37 -04:00
Pascal Borreli 037b38badb Fixed typos 2013-04-01 18:02:18 +00:00
Kenneth Reitz ba25184ed5 sp 2013-03-26 16:38:11 -04:00
Kenneth Reitz ab19b79375 Rezzy the Request Sea Turtle 2013-03-26 16:32:20 -04:00