kennethreitz
63e18ff2cc
working!
2019-04-19 10:39:50 -04:00
kennethreitz
0e4eb5683b
refactor
2019-04-18 15:39:34 -04:00
kennethreitz
e14c28a109
merge
2019-04-18 15:15:11 -04:00
b0ad2499c8
Prefer https:// for URLs throughout project
2018-09-30 17:14:40 -05:00
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
19919b44c4
Add documentation for available status codes
...
There was no way to determine what actual names were available outside
of looking at the source code. They were not listed in the documentation
or accessible through the interactive help.
In addition, doing `pydoc requests.status_codes` displayed some pretty
unhelpful information - the utf-8 encoding string was included in the
module name, there was no description, and internal variables used for
initialisation leaked into the module scope:
DATA
code = 511
codes = <lookup 'status_codes'>
title = 'network_authentication'
titles = ('network_authentication_required', 'network_auth', ...
This change prevents the internal variables from leaking, adds a
docstring (which has the side-effect of correcting the module name), and
appends information on the allowed status code names to the docstring
when the module is initialised.
The improved module documentation is then used in the API documentation
to provide another easy reference to the complete list of status codes.
2017-11-21 16:11:34 -05:00
7b76bd5866
remove HTTPProxyAuth in favor of the proxies parameter
2016-12-16 15:14:58 -07:00
7f88aca8f7
Merge branch 'master' into proposed/3.0.0
2016-11-15 17:16:04 +00:00
b5ca0c8d58
correct module for cookiejar_from_dict in docs
2016-11-02 14:59:08 -06:00
b2f6173a38
Merge remote-tracking branch 'upstream/master' into proposed/3.0.0
...
Conflicts:
requests/__init__.py
requests/sessions.py
tests/test_requests.py
2016-09-06 09:46:02 -05:00
1435cf5aff
docs updates
2016-08-14 20:56:52 -06:00
1cb3b797fe
updating documentation to reflect decision of #3386
2016-07-07 07:44:20 -06:00
ecfb85f85e
Merge remote-tracking branch 'upstream/master' into proposed/3.0.0
...
Conflicts:
AUTHORS.rst
requests/__init__.py
requests/sessions.py
tests/test_requests.py
2016-06-03 08:42:01 -05:00
f0d5a1f230
Fix autofunction Reference
...
`request.codes` is a class (`LookupDict`), not a function.
2016-03-08 23:57:54 -05:00
kennethreitz
9f33a0cd3c
refactor API documentation
2016-02-18 20:41:04 -05:00
kennethreitz
a0b7bdd187
Merge commit '1881851' into v3.0.0
2016-02-01 23:57:29 -05:00
75c7e5f1c3
Update example for Python 2/3 compatible.
2016-01-22 13:48:22 +09:00
ceb88ac077
Fix api doc of debug logging for Python 3
2016-01-22 12:47:18 +09:00
f8d2fb83a3
Rename {Missing,Invalid}Schema to *Scheme
...
Schemes are what they're called, not schemas.
Conflicts:
requests/models.py
2016-01-05 12:20:20 -05:00
1bb91653cc
Docs: Clarify that method-level params are not persisted in sessions.
2015-08-08 01:57:06 +02:00
f4ec3d2309
Clean up cookie docs and display them.
2014-12-24 14:33:14 +00:00
34ea836d77
tildes
2014-08-29 12:08:03 -07:00
81d6b3e435
s/behavior/behaviour
2014-08-29 11:51:09 -07:00
dfa41afd43
Document Timeout behaviour
2014-08-29 11:50:11 -07:00
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
49ecffb86e
Add authentication classes to the API document
...
Change-Id: Ic1464f246602b809f3c29fbafd6f36b747d5d5df
2014-07-18 15:15:54 +09:00
cde5a4a5d5
Add Timeout exception in API documentation
...
The Timeout exception is referenced from quickstart.rst but does
not get hyperlinked.
Change-Id: I69ad881bf9d2475c6239ac7b17f68ddbce0d03cd
2014-07-15 18:27:38 +09:00
03f444e601
Timeout documentation changes.
2014-03-03 20:23:59 +00:00
a17f5592f8
Added link to @Lukasa's blog - the source material
2013-09-24 18:59:04 -07:00
fbb8d32c4e
Added migrating to 2.x docs
2013-09-24 18:35:22 -07:00
3440fca2e8
clearly describe r.raw in Body Content Workflow
2013-09-12 13:13:51 +04:00
10b6d77945
remove extra mention of dangerous r.raw
2013-09-12 10:20:47 +04:00
ca033b83fe
Some cosmetic updates to the docs
...
Signed-off-by: Kwpolska <kwpolska@gmail.com >
2013-07-20 12:12:57 +02:00
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
c3bef6b0d9
A tiny typo, noticed while working on the Polish translation.
2013-04-27 14:52:35 +03:00
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
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
c73f653352
Add HTTPAdapter to API docs.
2013-04-09 19:54:47 +01:00
7e7c275504
Session isn't advertised as a context manager
2013-03-02 08:59:19 -08:00
73abf84ace
Capitalize s in Session
2013-03-02 08:51:55 -08:00
7eba5ffe48
Logic on streaming responses was changed in 1.0
...
* prefetch=False in 0.x is now stream=True
2013-03-02 08:44:14 -08:00
1d2ee524d8
Initial docs patch for migrating from pre 1.0
2013-03-01 23:21:08 -08:00
911e8aec8d
developer interface
2012-12-23 01:50:23 -05:00
9f89ebe0de
request sessions
2012-12-23 01:49:44 -05:00
526a0befc7
cleaup api docs
2012-12-23 01:47:35 -05:00
3ddcc99131
docs update
2012-12-23 01:40:07 -05:00
aa3347b2a3
request
2012-12-23 01:14:27 -05:00
b3fbc810d2
no async anymore
2012-12-23 01:02:32 -05:00
0792acc130
Update documentation on Sessions.
...
This resolves issue #870 . Better documentation here should be considered
for further work.
2012-11-17 10:57:26 +00:00
a64a62088a
Fixing status codes. Somehow these were wrong.
2011-11-14 09:44:43 +01:00
kennethreitz
Jon Dufresne