encode/httpx
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update dependencies in docs (#969)

Browse Source 
* 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>
This commit is contained in:
Tom Christie 2020-05-21 13:43:34 +01:00 committed by GitHub
parent 991915a935
commit 99a5c78bbb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 14 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -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

7
docs/advanced.md
View 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

8
docs/index.md
View 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