This project should be considered as an "alpha" release. It is substantially API complete, but there are still some areas that need more work.
Let's get started...
>>> import httpx >>> r = httpx.get('https://www.example.org/') >>> r <Response [200 OK]> >>> r.status_code 200 >>> r.http_version 'HTTP/1.1' >>> r.headers['content-type'] 'text/html; charset=UTF-8' >>> r.text '<!doctype html>\n<html>\n<head>\n<title>Example Domain</title>...'
HTTPX builds on the well-established usability of
requests, and gives you:
- A requests-compatible API.
- HTTP/2 and HTTP/1.1 support.
- Support for issuing HTTP requests in parallel. (Coming soon)
- Standard synchronous interface, but with
awaitsupport if you need it.
- Ability to make requests directly to WSGI or ASGI applications.
- Strict timeouts everywhere.
- Fully type annotated.
- 100% test coverage.
Plus all the standard features of
- International Domains and URLs
- Keep-Alive & Connection Pooling
- Sessions with Cookie Persistence
- Browser-style SSL Verification
- Basic/Digest Authentication (Digest is still TODO)
- Elegant Key/Value Cookies
- Automatic Decompression
- Automatic Content Decoding
- Unicode Response Bodies
- Multipart File Uploads
- HTTP(S) Proxy Support (TODO)
- Connection Timeouts
- Streaming Downloads
- .netrc Support
- Chunked Requests
For a run-through of all the basics, head over to the QuickStart.
The Developer Interface provides a comprehensive API reference.
The HTTPX project relies on these excellent libraries:
h2- HTTP/2 support.
h11- HTTP/1.1 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.
brotlipy- Decoding for "brotli" compressed responses. (Optional)
A huge amount of credit is due to
requests for the API layout that
much of this work follows, as well as to
urllib3 for plenty of design
inspiration around the lower level networking details.
Install with pip:
$ pip install httpx
HTTPX requires Python 3.6+