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.
+inspiration around the lower-level networking details.
<p align="center">— ⭐️ —</p>
<p align="center"><i>HTTPX is <a href="https://github.com/encode/httpx/blob/master/LICENSE.md">BSD licensed</a> code. Designed & built in Brighton, England.</i></p>
assert r.text == "Hello World!"
```
-For some more complex cases you might need to customize the WSGI or ASGI
+For some more complex cases, you might need to customize the WSGI or ASGI
dispatch. This allows you to:
* Inspect 500 error responses, rather than raise exceptions, by setting `raise_app_exceptions=False`.
<Response [200 OK]>
```
-## Specify the version of HTTP protocol
+## Specify the version of the HTTP protocol
-One can set the version of HTTP protocol for the client in case you want to make the requests using specific version.
+One can set the version of the HTTP protocol for the client in case you want to make the requests using a specific version.
For example:
)
client = httpx.Client(proxies=proxy)
-# This request will be tunnelled instead of forwarded.
+# This request will be tunneled instead of forwarded.
client.get("http://example.com")
```
## QuickStart
-Pretty much all the API mentioned in the `requests` QuickStart should be identical
+Pretty much any API mentioned in the `requests` QuickStart should be identical
to the API in our own documentation. The following exceptions apply:
* `Response.url` - Returns a `URL` instance, rather than a string. Use `str(response.url)` if you need a string instance.
# Contributing
-Thank you for being interested in contributing with HTTPX.
-There are many ways you can contribute with the project:
+Thank you for being interested in contributing to HTTPX.
+There are many ways you can contribute to the project:
- Try HTTPX and [report bugs/issues you find](https://github.com/encode/httpx/issues/new)
- [Implement new features](https://github.com/encode/httpx/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
and documentation building workflow. Make sure you have it installed
at your system before starting.
-Install nox with:
+Install `nox` with:
```shell
$ python3 -m pip install --user nox
$ pipx install nox
```
-Now, with nox installed run the complete pipeline with:
+Now, with nox installed, run the complete pipeline with:
```shell
$ nox
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.
+inspiration around the lower-level networking details.
## Installation
## Exceptions and Cancellations
-The style of using `parallel` blocks ensures that you'll always have well
-defined exception and cancellation behaviours. Request exceptions are only ever
-raised when calling either `get_response` or `next_response`, and any pending
-requests are cancelled on exiting the block.
+The style of using `parallel` blocks ensures that you'll always have a well-defined exception and cancellation behaviors. Request exceptions are only ever
+raised when calling either `get_response` or `next_response` and any pending
+requests are canceled on exiting the block.
## Parallel requests with a Client
You can also call `parallel()` from a client instance, which allows you to
-control the authentication or dispatch behaviour for all requests within the
+control the authentication or dispatch behavior for all requests within the
block.
```python
The `httpx` library is designed to be API compatible with `requests` wherever
possible.
-First start by importing HTTPX:
+First, start by importing HTTPX:
```
>>> import httpx
## Response Content
-HTTPX will automatically handle decoding the response content into unicode text.
+HTTPX will automatically handle decoding the response content into Unicode text.
```python
>>> r = httpx.get('https://www.example.org/')
## Sending Form Encoded Data
Some types of HTTP requests, such as `POST` and `PUT` requests, can include data
-in the request body. One common way of including that is as form encoded data,
+in the request body. One common way of including that is as form-encoded data,
which is used for HTML forms.
```python
## Sending JSON Encoded Data
-Form encoded data is okay if all you need is simple key-value data structure.
+Form encoded data is okay if all you need is a simple key-value data structure.
For more complicated data structures you'll often want to use JSON encoding instead.
```python
## Sending Binary Request Data
-For other encodings you should use either a `bytes` type, or a generator
+For other encodings, you should use either a `bytes` type or a generator
that yields `bytes`.
You'll probably also want to set a custom `Content-Type` header when uploading
'application/json'
```
-Multiple values for a single response header are represented as a single comma separated
+Multiple values for a single response header are represented as a single comma-separated
value, as per [RFC 7230](https://tools.ietf.org/html/rfc7230#section-3.2):
-> A recipient MAY combine multiple header fields with the same field name into one “field-name: field-value” pair, without changing the semantics of the message, by appending each subsequent field value to the combined field value in order, separated by a comma.
+> A recipient MAY combine multiple header fields with the same field name into one “field-name: field-value” pair, without changing the semantics of the message, by appending each subsequent field-value to the combined field value in order, separated by a comma.
## Cookies
## Redirection and History
-By default HTTPX will follow redirects for anything except `HEAD` requests.
+By default, HTTPX will follow redirects for anything except `HEAD` requests.
The `history` property of the response can be used to inspect any followed redirects.
It contains a list of all any redirect responses that were followed, in the order
projects / thirdparty / httpx.git / commitdiff
