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

Use shebang-style headers in environment variables docs (#1260)

Browse Source
This commit is contained in:
Florimond Manca 2020-09-05 10:30:14 +02:00 committed by GitHub
parent 42c66863d0
commit 98bb548a73
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/environment_variables.md
View File

@ -1,5 +1,4 @@
Environment Variables
=====================
# Environment Variables
The HTTPX library can be configured via environment variables.
Environment variables are used by default. To ignore environment variables, `trust_env` has to be set `False`. There are two ways to set `trust_env` to disable environment variables:
@ -9,8 +8,7 @@ Environment variables are used by default. To ignore environment variables, `tru
Here is a list of environment variables that HTTPX recognizes and what function they serve:
`HTTPX_LOG_LEVEL`
-----------------
## `HTTPX_LOG_LEVEL`
Valid values: `debug`, `trace` (case-insensitive)
@ -74,8 +72,7 @@ TRACE [2019-11-06 19:18:56] httpx._dispatch.connection_pool - release_connection
TRACE [2019-11-06 19:18:56] httpx._dispatch.connection - close_connection
```
`SSLKEYLOGFILE`
-----------
## `SSLKEYLOGFILE`
Valid values: a filename
@ -109,8 +106,7 @@ CLIENT_HANDSHAKE_TRAFFIC_SECRET XXXX
CLIENT_TRAFFIC_SECRET_0 XXXX
```
`SSL_CERT_FILE`
-----------
## `SSL_CERT_FILE`
Valid values: a filename
@ -124,8 +120,7 @@ Example:
SSL_CERT_FILE=/path/to/ca-certs/ca-bundle.crt python -c "import httpx; httpx.get('https://example.com')"
```
`SSL_CERT_DIR`
-----------
## `SSL_CERT_DIR`
Valid values: a directory
@ -139,8 +134,7 @@ Example:
SSL_CERT_DIR=/path/to/ca-certs/ python -c "import httpx; httpx.get('https://example.com')"
```
`HTTP_PROXY`, `HTTPS_PROXY`, `ALL_PROXY`
----------------------------------------
## `HTTP_PROXY`, `HTTPS_PROXY`, `ALL_PROXY`
Valid values: A URL to a proxy