Commit Graph

78 Commits

Author SHA1 Message Date
Tom Christie
ddc4885543
Update advanced.md 2019-12-06 11:35:29 +00:00
Tom Christie
1e23855709
Warn if cert / verify / trust_env are passed to client.request() (#597)
* Add cert and verify warnings on Client.request

* Resolve typo

Co-Authored-By: Florimond Manca <florimond.manca@gmail.com>

* Resolve typo

Co-Authored-By: Florimond Manca <florimond.manca@gmail.com>

* trust_env should be set on client init

* Update docs for per-Client SSL settings

* Update requests compat docs
2019-12-06 11:29:22 +00:00
Tom Christie
8d8ea8bbba
Add Client.stream() method. (#600)
* Add Client.stream() method.

* Add top-level stream API

* Documentation
2019-12-05 17:25:43 +00:00
Tom Christie
fc95c7e71e
stream -> stream_bytes, raw -> stream_raw (#599) 2019-12-05 11:39:28 +00:00
Tom Christie
f8794cb3ce
Improve backend docs, particularly wrt. autodetection (#595)
* Improve backend docs, particularly wrt. autodetection

* Resolve typo.
2019-12-05 10:27:16 +00:00
Tom Christie
2f54b200de
Allow default+override timeout style (#593)
* Allow styles like: httpx.Timeout(5.0, pool_timeout=None)

* Update timeout docs

* Minor tweaks to sub headings in timeout docs

* Fixing up Timeout docs

* RequestTimeout -> TimeoutException

* Tweak timeout docs
2019-12-05 09:38:48 +00:00
Tom Christie
81edb1b45b
Update index.md 2019-12-04 17:21:42 +00:00
Tom Christie
c08ae7796f
Alpha note, and recommendations on pinning versions (#590) 2019-12-04 11:57:02 +00:00
Tom Christie
c033ed1b65
TimeoutConfig -> Timeout (#591) 2019-12-04 11:39:45 +00:00
Tom Christie
5076952202
Rename http2 switch (#586)
* Simplify HTTP version config, and switch HTTP/2 off by default

* HTTP/2 docs

* HTTP/2 interlinking in docs

* Add concurrency auto-detection

* Add sniffio

* Rename HTTP2 switch on client

* http_2 -> http2
2019-12-02 19:52:29 +00:00
Tom Christie
30229f1652
Better HTTP/2 defaults. (#584)
* Simplify HTTP version config, and switch HTTP/2 off by default

* HTTP/2 docs

* HTTP/2 interlinking in docs
2019-12-02 17:07:04 +00:00
Mattwmaster58
33cb39733f Clarify multipart documentation (#580)
*Clarify multipart behvaiour
2019-12-02 11:56:25 +00:00
Tom Christie
871b0b5cb9
Update advanced.md 2019-11-30 21:46:07 +00:00
Tom Christie
7d45db068b
Link to ASGI docs (#577) 2019-11-30 18:38:27 +00:00
Tom Christie
fdaa01275a
Add Response.is_error (#574) 2019-11-30 17:43:48 +00:00
Florimond Manca
8d55d78574 Drop nox in favor of vanilla scripts (#566)
* Drop nox in favor of vanilla scripts

* Use named stages

* Fix attrs dependency resolution madness

* Add missing mkautodoc dev dependency

* Add missing install step on windows build

* Explicitly define stage order so that timed out Windows build runs last

* Add missing dev dependency on Black

* Clean up contributing guide

* Separate docs into docs-build and docs-serve
2019-11-30 11:50:13 +00:00
Tom Christie
296c9b459e
Drop erronous references to AsyncClient (#559) 2019-11-28 12:33:53 +00:00
Tom Christie
00e150f6a5
Client handles redirect + auth (#552)
* Drop sync client

* Drop unused imports

* Async only

* Update tests/test_decoders.py

Co-Authored-By: Florimond Manca <florimond.manca@gmail.com>

* Linting

* Update docs for async-only

* Import sorting

* Add async notes to docs

* Update README for 0.8 async switch

* Move auth away from middleware where possible

* Drop middleware sub-package

* Client.dispatcher -> Client.dispatch

* Docs tweak

* Linting

* Fix type checking issue

* Import ordering

* Fix up docstrings

* Minor docs fixes

* Linting

* Remove unused import
2019-11-27 12:10:10 +00:00
Tom Christie
206c5372a6
Drop sync (#544)
Drop sync client
2019-11-27 10:43:42 +00:00
Florimond Manca
926d6cd6e4
Document when to use AsyncClient (#534)
* Document when to use AsyncClient

* Strip advice on reverting to Requests
2019-11-22 09:19:39 +01:00
Jonas Lundberg
f0e6acb6e2 Add Unix Domain Sockets section to advanced docs page (#542) 2019-11-20 08:48:58 +01:00
Jonas Lundberg
2dbcaf859f Document mocking compatibility (#537) 2019-11-18 12:16:06 +00:00
Florimond Manca
95b2b24302
Add docs on SSL certificates (#510)
* Add docs on SSL certificates

* Update docs on verify and cert params

* Tweak wording

* Tweak wording about localhost

* Remove advanced warning

* Rephrase introduction of local HTTPS section
2019-11-07 10:46:36 +01:00
Florimond Manca
08069e9368
Add DEBUG logs of HTTP requests (#502) 2019-11-06 22:56:25 +01:00
Florimond Manca
07586f97e8
Convert debug logs to trace logs (#500)
* Convert debug logs to trace logs

* Update environment variables docs

* Update logging test
2019-11-02 22:40:15 +01:00
Tom Christie
1ce3cc3269 First pass at autodoc support (#464)
* First pass at autodoc support

* Add mkautodoc requirement for docs builds

* Linting

* pip install httpx when building docs, to make it available to mkautodoc

* Fix code example in docstring slightly

* Use latest mkautodoc to resolve rendering of code snippets in docstrings

* Fill in 'Helper functions' API docs

* First pass at documenting Client

* Add autodoc for Client

* Update to mkautodoc 0.1

* Fix typos
2019-10-30 16:21:39 +01:00
Yeray Diaz Diaz
9ec2cfc5dc
Multipart files tweaks (#482)
* Allow filenames as None in multipart encoding

* Allow str file contents in multipart encode

* Some formatting changes on `advanced.md`

* Document multipart file encoding in the advanced docs

* Update docs/advanced.md

Co-Authored-By: Florimond Manca <florimond.manca@gmail.com>
2019-10-20 13:25:00 +01:00
Florimond Manca
ad38db82f9
Document client-level configuration (#488)
* Document client-level configuration

* Fix typo
2019-10-19 15:05:26 +02:00
Yeray Diaz Diaz
09db6ec935 Drop proxies parameter from the high level API (#485)
* Drop `proxies` argument from high level API

* Update state of Digest auth in docs

* Add note on not supporting proxies at request level

* Grammar tweak

Co-Authored-By: Florimond Manca <florimond.manca@gmail.com>
2019-10-19 14:51:27 +02:00
Florimond Manca
074cd25b04
Document client block-usage and close() (#487)
* Document client context manager vs close() usage

* Convert client snippets to use context-managed syntax
2019-10-19 13:52:44 +02:00
Mateusz Woś
2984499f28 Add timeout fine-tunning advanced docs section (#476)
* Add timeout fine-tunning advanced docs section

* Rephrase part of timeout documentation
2019-10-16 18:27:45 +02:00
Can Sarıgöl
84731c8be5 Cache netrc authentication per-client (#400) 2019-10-16 08:31:47 -05:00
Florimond Manca
5e4f54d643
Add test script (#451) 2019-10-12 18:14:44 +02:00
Seth Michael Larson
a80c43294b
Add hints for debugging CI issues (#399) 2019-10-10 07:05:22 -05:00
Florimond Manca
65b8593c7c Allow serving docs via nox (#450) 2019-10-10 07:02:17 -05:00
thebigmunch
391786696a Fix some grammar in Advanced docs (#461) 2019-10-09 20:01:37 +02:00
ImPerat0R_
97a104abc3 Add language syntax highlighting in Quickstart (#466) 2019-10-09 18:34:54 +02:00
Jt Miclat
31730e7095 Add documentation for requests.Session compatibility (#449) 2019-10-05 19:20:18 -05:00
nwalsh1995
f504399781 Fix link to parallel page from async page (#440) 2019-10-03 20:08:27 -05:00
Davit Tovmasyan
2f2a4e4ef0 Document the files parameter on .post(), .patch(), and .put() (#409) (#414) 2019-10-03 19:47:19 -05:00
Jt Miclat
85fa89c49c Document compatibility difference for get, delete, head, and options (#418) 2019-10-03 19:46:24 -05:00
Kyle Galbraith
b65bce5924 Fix typos, spelling issues, and grammar in docs (#426) 2019-10-02 11:46:54 -05:00
Dustin Ingram
5df822ca11 Fix broken docs (#415)
* Fix broken link to parallel request page

* Fix incomplete code block on quickstart page
2019-09-30 20:19:53 +01:00
Ahmed Maher
5ced56b5b5 Expose ASGIDispatch & WSGIDispatch in the 'dispatch' namespace. (#407) 2019-09-28 14:55:19 -05:00
Jt Miclat
6752f7d6f6 Remove data, json and files parameters in delete() function (#408) 2019-09-28 12:18:40 -05:00
Florimond Manca
3496525d02
Document supported async libraries (#387)
* Document supported async libraries

* Update async.md
2019-09-26 13:43:56 +02:00
Can Sarıgöl
c9810a79d9 Add support for SSL_CERT_FILE and SSL_CERT_DIR (#307) 2019-09-23 10:24:53 -05:00
Tyrel Souza
5dc646fb9f Adding params to Client (#372) 2019-09-23 09:22:21 -05:00
Florimond Manca
12752466ae
Document the release process (#363)
* Document release process

* Update changelog instructions w/ ref to keepachangelog

* Prettify bullet points

* Add docs deploy to release script
2019-09-21 09:12:53 +02:00
Seth Michael Larson
b0fa0859a8
Configure Proxy from Client (#353)
* Incorporate suggestions

* Start of proxy config

* Incorporate suggestions

* Add proxies to high-level API, docs

* Update client.py
2019-09-20 12:33:06 -05:00