Go to file

Tom Christie a06db38b1b Add mkdocs to requirements		2019-06-12 15:29:11 +01:00
docs	http3 (#86 )	2019-06-12 15:02:16 +01:00
http3	http3 (#86 )	2019-06-12 15:02:16 +01:00
scripts	http3 (#86 )	2019-06-12 15:02:16 +01:00
tests	http3 (#86 )	2019-06-12 15:02:16 +01:00
.gitignore	Initial commit	2019-04-04 13:27:55 +01:00
.travis.yml	Close outstanding connections on pool.close()	2019-04-24 11:42:45 +01:00
CNAME	Create CNAME	2019-06-12 15:28:39 +01:00
LICENSE.md	Initial commit	2019-04-04 13:27:55 +01:00
mkdocs.yml	http3 (#86 )	2019-06-12 15:02:16 +01:00
README.md	Update README.md	2019-06-12 15:13:44 +01:00
requirements.txt	Add mkdocs to requirements	2019-06-12 15:29:11 +01:00
setup.py	http3 (#86 )	2019-06-12 15:02:16 +01:00

README.md

HTTP3

HTTP3 is a next-generation HTTP client for Python.

Note: 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 http3
>>> r = http3.get('https://www.example.org/')
>>> r.status_code
<StatusCode.OK: 200>
>>> r.protocol
'HTTP/2'
>>> r.headers['content-type']
'text/html; charset=UTF-8'
>>> r.text
'<!doctype html>\n<html>\n<head>\n<title>Example Domain</title>...'

Features

HTTP3 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.
Standard synchronous interface, but with async/await support if you need it.
Strict timeouts everywhere.
Fully type annotated.
100% test coverage.

Plus all the standard features of requests...

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 TODO
HTTP(S) Proxy Support TODO
Connection Timeouts
Streaming Downloads
.netrc Support TODO
Chunked Requests

Documentation

For a run-through of all the basics, head over to the QuickStart.

For more advanced topics, see the Parallel Requests or Async Client documentation.

The Developer Interface provides a comprehensive API reference.

Dependencies

The HTTP3 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.
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.