From: Mei <55642867+meist0731@users.noreply.github.com>
Date: Wed, 16 Jun 2021 05:04:47 +0000 (-0500)
Subject: Add netrc environment variable into the documentation (#1675)
X-Git-Tag: 0.18.2~4
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=604d09d7d7064454c83267b0b62a30928241bf78;p=thirdparty%2Fhttpx.git

Add netrc environment variable into the documentation (#1675)

* Adding netrc environment variable documentation

* Update docs/environment_variables.md

Co-authored-by: Tom Christie <tom@tomchristie.com>

* Modifications about netrcfile environment variable

* Change uppercase "A" in netrcfile env variable into lowercase

* Added some words and a dot before "my_netrc" in the console example

* changed a typo "rather that" into "rather than" in advanced.md

* changed netrc environment variable in example part

* modified title for netrc environment variable part in doc

* Deleted the dot in title of netrc environment variable

Co-authored-by: Tom Christie <tom@tomchristie.com>
---

diff --git a/docs/advanced.md b/docs/advanced.md
index 32714bd5..cf8cc513 100644
--- a/docs/advanced.md
+++ b/docs/advanced.md
@@ -370,7 +370,7 @@ password example-password
 ...
 ```
 
-When using `Client` instances, `trust_env` should be set on the client itself, rather that on the request methods:
+When using `Client` instances, `trust_env` should be set on the client itself, rather than on the request methods:
 
 ```python
 client = httpx.Client(trust_env=False)
diff --git a/docs/environment_variables.md b/docs/environment_variables.md
index d9cc89a5..b0ebcf0c 100644
--- a/docs/environment_variables.md
+++ b/docs/environment_variables.md
@@ -132,6 +132,18 @@ Example:
 SSL_CERT_DIR=/path/to/ca-certs/ python -c "import httpx; httpx.get('https://example.com')"
 ```
 
+## `NETRC`
+
+Valid values: a filename
+
+If this environment variable is set but auth parameter is not defined, HTTPX will add auth information stored in the .netrc file into the request's header. If you do not provide NETRC environment either, HTTPX will use default files. (~/.netrc, ~/_netrc)
+
+Example:
+
+```console
+NETRC=/path/to/netrcfile/.my_netrc python -c "import httpx; httpx.get('https://example.com')"
+```
+
 ## Proxies
 
 The environment variables documented below are used as a convention by various HTTP tooling, including:
@@ -175,3 +187,4 @@ python -c "import httpx; httpx.get('http://example.com')"
 python -c "import httpx; httpx.get('http://127.0.0.1:5000/my-api')"
 python -c "import httpx; httpx.get('https://www.python-httpx.org')"
 ```
+