]> git.ipfire.org Git - thirdparty/httpx.git/commitdiff
Update dependencies in docs (#969)
authorTom Christie <tom@tomchristie.com>
Thu, 21 May 2020 12:43:34 +0000 (13:43 +0100)
committerGitHub <noreply@github.com>
Thu, 21 May 2020 12:43:34 +0000 (13:43 +0100)
* Update dependencies in docs

* Update README.md

Co-authored-by: Florimond Manca <florimond.manca@gmail.com>
* Update docs/index.md

Co-authored-by: Florimond Manca <florimond.manca@gmail.com>
Co-authored-by: Florimond Manca <florimond.manca@gmail.com>
README.md
docs/advanced.md
docs/index.md

index d0c5a25afc6607bc15bb25732fb55d90c5fee1f4..18db5909b3e9491d47b29c26288c008608d43e74 100644 (file)
--- a/README.md
+++ b/README.md
@@ -108,15 +108,16 @@ If you want to contribute with HTTPX check out the [Contributing Guide](https://
 
 The HTTPX project relies on these excellent libraries:
 
-* `urllib3` - Sync client support.
-* `h11` - HTTP/1.1 support.
-* `h2` - HTTP/2 support.
+* `httpcore` - The underlying transport implementation for `httpx`.
+  * `h11` - HTTP/1.1 support.
+  * `h2` - HTTP/2 support.
 * `certifi` - SSL certificates.
 * `chardet` - Fallback auto-detection for response encoding.
 * `hstspreload` - determines whether IDNA-encoded host should be only accessed via HTTPS.
 * `idna` - Internationalized domain name support.
 * `rfc3986` - URL parsing & normalization.
 * `sniffio` - Async library autodetection.
+* `urllib3` - Support for the `httpx.URLLib3Transport` class. *(Optional)*
 * `brotlipy` - Decoding for "brotli" compressed responses. *(Optional)*
 
 A huge amount of credit is due to `requests` for the API layout that
index 2c1f1a6042e22d0120e8a4dfba37d120736d417a..97a440b43bc70806cb208294fd074e655ed80144 100644 (file)
@@ -633,7 +633,8 @@ use with `AsyncClient`, or subclass `httpcore.SyncHTTPTransport` to implement a
 transport to use with `Client`.
 
 For example, HTTPX ships with a transport that uses the excellent
-[`urllib3` library](https://urllib3.readthedocs.io/en/latest/):
+[`urllib3` library](https://urllib3.readthedocs.io/en/latest/), which can be
+used with the sync `Client`...
 
 ```python
 >>> import httpx
@@ -642,7 +643,9 @@ For example, HTTPX ships with a transport that uses the excellent
 <Response [200 OK]>
 ```
 
-A complete example of a transport implementation would be:
+Note that you'll need to install the `urllib3` package to use `URLLib3Transport`.
+
+A complete example of a custom transport implementation would be:
 
 ```python
 import json
index d862519d1c890579b949da2493a07c232299f730..07b9f48890dce4869a6419c917ecc3d429b419c0 100644 (file)
@@ -106,14 +106,16 @@ To find out about tools that integrate with HTTPX, see [Third Party Packages](th
 
 The HTTPX project relies on these excellent libraries:
 
-* `urllib3` - Sync client support.
-* `h11` - HTTP/1.1 support.
-* `h2` - HTTP/2 support.
+* `httpcore` - The underlying transport implementation for `httpx`.
+  * `h11` - HTTP/1.1 support.
+  * `h2` - HTTP/2 support.
 * `certifi` - SSL certificates.
 * `chardet` - Fallback auto-detection for response encoding.
 * `hstspreload` - determines whether IDNA-encoded host should be only accessed via HTTPS.
 * `idna` - Internationalized domain name support.
 * `rfc3986` - URL parsing & normalization.
+* `sniffio` - Async library autodetection.
+* `urllib3` - Support for the `httpx.URLLib3Transport` class. *(Optional)*
 * `brotlipy` - Decoding for "brotli" compressed responses. *(Optional)*
 
 A huge amount of credit is due to `requests` for the API layout that