Python
/
uv
mirror of https://github.com/astral-sh/uv
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Document `.netrc` environment variable and path (#8511) 

## Summary

Closes https://github.com/astral-sh/uv/issues/8482.
This commit is contained in:
Charlie Marsh 2024-10-23 22:34:45 -04:00 committed by GitHub
parent dff507702b
commit ede47c0793
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 9 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
crates/uv-auth/src/middleware.rs
View File

@ -71,11 +71,11 @@ impl AuthMiddleware {
} }
} }
/// Configure the [`netrc::Netrc`] credential file to use. /// Configure the [`Netrc`] credential file to use.
/// ///
/// `None` disables authentication via netrc. /// `None` disables authentication via netrc.
#[must_use] #[must_use]
pub fn with_netrc(mut self, netrc: Option<netrc::Netrc>) -> Self { pub fn with_netrc(mut self, netrc: Option<Netrc>) -> Self {
self.netrc = if let Some(netrc) = netrc { self.netrc = if let Some(netrc) = netrc {
NetrcMode::Enabled(netrc) NetrcMode::Enabled(netrc)
} else { } else {

9
docs/configuration/authentication.md
View File

@ -35,15 +35,18 @@ uv supports credentials over HTTP when querying package registries.
Authentication can come from the following sources, in order of precedence: Authentication can come from the following sources, in order of precedence:
- The URL, e.g., `https://<user>:<password>@<hostname>/...` - The URL, e.g., `https://<user>:<password>@<hostname>/...`
- A [`netrc`](https://everything.curl.dev/usingcurl/netrc) configuration file - A [`.netrc`](https://everything.curl.dev/usingcurl/netrc) configuration file
- A [keyring](https://github.com/jaraco/keyring) provider (requires opt-in) - A [keyring](https://github.com/jaraco/keyring) provider (requires opt-in)
If authentication is found for a single net location (scheme, host, and port), it will be cached for If authentication is found for a single net location (scheme, host, and port), it will be cached for
the duration of the command and used for other queries to that net location. Authentication is not the duration of the command and used for other queries to that net location. Authentication is not
cached across invocations of uv. cached across invocations of uv.
Note `--keyring-provider subprocess` or `UV_KEYRING_PROVIDER=subprocess` must be provided to enable `.netc` authentication is enabled by default, and will respect the `NETRC` environment variable if
keyring-based authentication. defined, falling back to `~/.netrc` if not.
To enable keyring-based authentication, pass the `--keyring-provider subprocess` command-line
argument to uv, or set `UV_KEYRING_PROVIDER=subprocess`.
Authentication may be used for hosts specified in the following contexts: Authentication may be used for hosts specified in the following contexts:

1
docs/configuration/environment.md
View File

@ -134,6 +134,7 @@ In addition, uv respects the following environment variables:
- `HTTP_PROXY`, `HTTPS_PROXY`, `ALL_PROXY`: The proxy to use for all HTTP/HTTPS requests. - `HTTP_PROXY`, `HTTPS_PROXY`, `ALL_PROXY`: The proxy to use for all HTTP/HTTPS requests.
- `HTTP_TIMEOUT` (or `UV_HTTP_TIMEOUT`): If set, uv will use this value (in seconds) as the timeout - `HTTP_TIMEOUT` (or `UV_HTTP_TIMEOUT`): If set, uv will use this value (in seconds) as the timeout
for HTTP reads (default: 30 s). for HTTP reads (default: 30 s).
- `NETRC`: If set, uv will read authentication information from this file instead of `~/.netrc`.
- `PYC_INVALIDATION_MODE`: The validation modes to use when run with `--compile`. See: - `PYC_INVALIDATION_MODE`: The validation modes to use when run with `--compile`. See:
[`PycInvalidationMode`](https://docs.python.org/3/library/py_compile.html#py_compile.PycInvalidationMode). [`PycInvalidationMode`](https://docs.python.org/3/library/py_compile.html#py_compile.PycInvalidationMode).
- `VIRTUAL_ENV`: Used to detect an activated virtual environment. - `VIRTUAL_ENV`: Used to detect an activated virtual environment.