跳到内容

使用备用包索引

虽然 uv 默认使用官方 Python 包索引 (PyPI),但它也支持备用包索引。 大多数备用索引都需要各种形式的身份验证,这需要一些初始设置。

重要

如果使用 pip 接口,请阅读关于 uv 中使用多个索引的文档 - 默认行为与 pip 不同,以防止依赖混淆攻击,但这意味着 uv 可能无法找到您期望的包版本。

Azure Artifacts

uv 可以从 Azure Artifacts 安装包,可以使用个人访问令牌 (PAT),或使用 keyring 包。

要使用 Azure Artifacts,请将索引添加到您的项目中

pyproject.toml
[[tool.uv.index]]
name = "private-registry"
url = "https://pkgs.dev.azure.com/<ORGANIZATION>/<PROJECT>/_packaging/<FEED>/pypi/simple/"

使用 Azure 访问令牌进行身份验证

如果有一个个人访问令牌 (PAT) 可用(例如,Azure 管道中的 $(System.AccessToken)),则可以通过“Basic”HTTP 身份验证方案提供凭据。 将 PAT 包含在 URL 的密码字段中。 还必须包含用户名,但可以是任何字符串。

例如,如果令牌存储在 $AZURE_ARTIFACTS_TOKEN 环境变量中,请使用以下命令设置索引的凭据

export UV_INDEX_PRIVATE_REGISTRY_USERNAME=dummy
export UV_INDEX_PRIVATE_REGISTRY_PASSWORD="$AZURE_ARTIFACTS_TOKEN"

注意

PRIVATE_REGISTRY 应与您的 pyproject.toml 中定义的索引名称匹配。

使用 keyringartifacts-keyring 进行身份验证

您还可以使用带有 artifacts-keyring 插件keyring 包对 Artifacts 进行身份验证。 因为需要这两个包才能对 Azure Artifacts 进行身份验证,所以必须从 Artifacts 以外的源预先安装它们。

artifacts-keyring 插件包装了 Azure Artifacts 凭据提供程序工具。 凭据提供程序支持几种不同的身份验证模式,包括交互式登录 - 有关配置的信息,请参阅该工具的文档

uv 仅支持在子进程模式下使用 keyring 包。 keyring 可执行文件必须位于 PATH 中,即全局安装或在活动环境中安装。 keyring CLI 需要 URL 中的用户名,并且必须是 VssSessionToken

# Pre-install keyring and the Artifacts plugin from the public PyPI
uv tool install keyring --with artifacts-keyring

# Enable keyring authentication
export UV_KEYRING_PROVIDER=subprocess

# Set the username for the index
export UV_INDEX_PRIVATE_REGISTRY_USERNAME=VssSessionToken

注意

可以使用 tool.uv.keyring-provider 设置在您的 uv.tomlpyproject.toml 中启用 keyring。

同样,索引的用户名也可以直接添加到索引 URL 中。

将包发布到 Azure Artifacts

如果您还想将自己的包发布到 Azure Artifacts,则可以使用 构建和发布指南中描述的 uv publish

首先,将 publish-url 添加到要将包发布到的索引。 例如

pyproject.toml
[[tool.uv.index]]
name = "private-registry"
url = "https://pkgs.dev.azure.com/<ORGANIZATION>/<PROJECT>/_packaging/<FEED>/pypi/simple/"
publish-url = "https://pkgs.dev.azure.com/<ORGANIZATION>/<PROJECT>/_packaging/<FEED>/pypi/upload/"

然后,配置凭据(如果不使用 keyring)

$ export UV_PUBLISH_USERNAME=dummy
$ export UV_PUBLISH_PASSWORD="$AZURE_ARTIFACTS_TOKEN"

并发布包

$ uv publish --index private-registry

要在不将 publish-url 添加到项目的情况下使用 uv publish,您可以设置 UV_PUBLISH_URL

$ export UV_PUBLISH_URL=https://pkgs.dev.azure.com/<ORGANIZATION>/<PROJECT>/_packaging/<FEED>/pypi/upload/
$ uv publish

请注意,此方法不是首选方法,因为 uv 无法在上传工件之前检查包是否已发布。

Google Artifact Registry

uv 可以从 Google Artifact Registry 安装包,可以使用访问令牌,或使用 keyring 包。

注意

本指南假定已安装并验证了 gcloud CLI。

要使用 Google Artifact Registry,请将索引添加到您的项目中

pyproject.toml
[[tool.uv.index]]
name = "private-registry"
url = "https://<REGION>-python.pkg.dev/<PROJECT>/<REPOSITORY>/simple/"

使用 Google 访问令牌进行身份验证

可以通过“Basic”HTTP 身份验证方案提供凭据。 将访问令牌包含在 URL 的密码字段中。 用户名必须是 oauth2accesstoken,否则身份验证将失败。

使用 gcloud 生成令牌

export ARTIFACT_REGISTRY_TOKEN=$(
    gcloud auth application-default print-access-token
)

注意

您可能需要传递额外的参数才能正确生成令牌(例如 --project),这是一个基本示例。

然后使用以下命令设置索引的凭据

export UV_INDEX_PRIVATE_REGISTRY_USERNAME=oauth2accesstoken
export UV_INDEX_PRIVATE_REGISTRY_PASSWORD="$ARTIFACT_REGISTRY_TOKEN"

注意

PRIVATE_REGISTRY 应与您的 pyproject.toml 中定义的索引名称匹配。

使用 keyringkeyrings.google-artifactregistry-auth 进行身份验证

您还可以使用带有 keyrings.google-artifactregistry-auth 插件keyring 包对 Artifact Registry 进行身份验证。 因为需要这两个包才能对 Artifact Registry 进行身份验证,所以必须从 Artifact Registry 以外的源预先安装它们。

keyrings.google-artifactregistry-auth 插件包装 gcloud CLI 以生成短期访问令牌,将其安全地存储在系统 keyring 中,并在它们过期时刷新它们。

uv 仅支持在子进程模式下使用 keyring 包。 keyring 可执行文件必须位于 PATH 中,即全局安装或在活动环境中安装。 keyring CLI 需要 URL 中的用户名,并且必须是 oauth2accesstoken

# Pre-install keyring and Artifact Registry plugin from the public PyPI
uv tool install keyring --with keyrings.google-artifactregistry-auth

# Enable keyring authentication
export UV_KEYRING_PROVIDER=subprocess

# Set the username for the index
export UV_INDEX_PRIVATE_REGISTRY_USERNAME=oauth2accesstoken

注意

可以使用 tool.uv.keyring-provider 设置在您的 uv.tomlpyproject.toml 中启用 keyring。

同样,索引的用户名也可以直接添加到索引 URL 中。

将包发布到 Google Artifact Registry

如果您还想将自己的包发布到 Google Artifact Registry,则可以使用 构建和发布指南中描述的 uv publish

首先,将 publish-url 添加到要将包发布到的索引。 例如

pyproject.toml
[[tool.uv.index]]
name = "private-registry"
url = "https://<REGION>-python.pkg.dev/<PROJECT>/<REPOSITORY>/simple/"
publish-url = "https://<REGION>-python.pkg.dev/<PROJECT>/<REPOSITORY>/"

然后,配置凭据(如果不使用 keyring)

$ export UV_PUBLISH_USERNAME=oauth2accesstoken
$ export UV_PUBLISH_PASSWORD="$ARTIFACT_REGISTRY_TOKEN"

并发布包

$ uv publish --index private-registry

要在不将 publish-url 添加到项目的情况下使用 uv publish,您可以设置 UV_PUBLISH_URL

$ export UV_PUBLISH_URL=https://<REGION>-python.pkg.dev/<PROJECT>/<REPOSITORY>/
$ uv publish

请注意,此方法不是首选方法,因为 uv 无法在上传工件之前检查包是否已发布。

AWS CodeArtifact

uv 可以从 AWS CodeArtifact 安装包,可以使用访问令牌,或使用 keyring 包。

注意

本指南假定已安装并验证了 awscli

可以这样声明索引

pyproject.toml
[[tool.uv.index]]
name = "private-registry"
url = "https://<DOMAIN>-<ACCOUNT_ID>.d.codeartifact.<REGION>.amazonaws.com/pypi/<REPOSITORY>/simple/"

使用 AWS 访问令牌进行身份验证

可以通过“Basic”HTTP 身份验证方案提供凭据。 将访问令牌包含在 URL 的密码字段中。 用户名必须是 aws,否则身份验证将失败。

使用 awscli 生成令牌

export AWS_CODEARTIFACT_TOKEN="$(
    aws codeartifact get-authorization-token \
    --domain <DOMAIN> \
    --domain-owner <ACCOUNT_ID> \
    --query authorizationToken \
    --output text
)"

注意

您可能需要传递额外的参数才能正确生成令牌(例如 --region),这是一个基本示例。

然后使用以下命令设置索引的凭据

export UV_INDEX_PRIVATE_REGISTRY_USERNAME=aws
export UV_INDEX_PRIVATE_REGISTRY_PASSWORD="$AWS_CODEARTIFACT_TOKEN"

注意

PRIVATE_REGISTRY 应与您的 pyproject.toml 中定义的索引名称匹配。

使用 keyringkeyrings.codeartifact 进行身份验证

您还可以使用带有 keyrings.codeartifact 插件keyring 包对 Artifact Registry 进行身份验证。 因为需要这两个包才能对 Artifact Registry 进行身份验证,所以必须从 Artifact Registry 以外的源预先安装它们。

keyrings.codeartifact 插件包装 boto3 以生成短期访问令牌,将其安全地存储在系统 keyring 中,并在它们过期时刷新它们。

uv 仅支持在子进程模式下使用 keyring 包。 keyring 可执行文件必须位于 PATH 中,即全局安装或在活动环境中安装。 keyring CLI 需要 URL 中的用户名,并且必须是 aws

# Pre-install keyring and AWS CodeArtifact plugin from the public PyPI
uv tool install keyring --with keyrings.codeartifact

# Enable keyring authentication
export UV_KEYRING_PROVIDER=subprocess

# Set the username for the index
export UV_INDEX_PRIVATE_REGISTRY_USERNAME=aws

注意

可以使用 tool.uv.keyring-provider 设置在您的 uv.tomlpyproject.toml 中启用 keyring。

同样,索引的用户名也可以直接添加到索引 URL 中。

将包发布到 AWS CodeArtifact

如果您还想将自己的包发布到 AWS CodeArtifact,则可以使用 构建和发布指南中描述的 uv publish

首先,将 publish-url 添加到要将包发布到的索引。 例如

pyproject.toml
[[tool.uv.index]]
name = "private-registry"
url = "https://<DOMAIN>-<ACCOUNT_ID>.d.codeartifact.<REGION>.amazonaws.com/pypi/<REPOSITORY>/simple/"
publish-url = "https://<DOMAIN>-<ACCOUNT_ID>.d.codeartifact.<REGION>.amazonaws.com/pypi/<REPOSITORY>/"

然后,配置凭据(如果不使用 keyring)

$ export UV_PUBLISH_USERNAME=aws
$ export UV_PUBLISH_PASSWORD="$AWS_CODEARTIFACT_TOKEN"

并发布包

$ uv publish --index private-registry

要在不将 publish-url 添加到项目的情况下使用 uv publish,您可以设置 UV_PUBLISH_URL

$ export UV_PUBLISH_URL=https://<DOMAIN>-<ACCOUNT_ID>.d.codeartifact.<REGION>.amazonaws.com/pypi/<REPOSITORY>/
$ uv publish

请注意,此方法不是首选方法,因为 uv 无法在上传工件之前检查包是否已发布。

JFrog Artifactory

uv 可以从 JFrog Artifactory 安装包,可以使用用户名和密码或 JWT 令牌。

要使用它,请将索引添加到您的项目中

pyproject.toml
[[tool.uv.index]]
name = "private-registry"
url = "https://<organization>.jfrog.io/artifactory/api/pypi/<repository>/simple"

使用用户名和密码进行身份验证

$ export UV_INDEX_PRIVATE_REGISTRY_USERNAME="<username>"
$ export UV_INDEX_PRIVATE_REGISTRY_PASSWORD="<password>"

使用 JWT 令牌进行身份验证

$ export UV_INDEX_PRIVATE_REGISTRY_USERNAME=""
$ export UV_INDEX_PRIVATE_REGISTRY_PASSWORD="$JFROG_JWT_TOKEN"

注意

将环境变量名称中的 PRIVATE_REGISTRY 替换为您的 pyproject.toml 中定义的实际索引名称。

将包发布到 JFrog Artifactory

publish-url 添加到您的索引定义

pyproject.toml
[[tool.uv.index]]
name = "private-registry"
url = "https://<organization>.jfrog.io/artifactory/api/pypi/<repository>/simple"
publish-url = "https://<organization>.jfrog.io/artifactory/api/pypi/<repository>"

重要

如果将 --token "$JFROG_TOKEN"UV_PUBLISH_TOKEN 与 JFrog 一起使用,您将收到 401 Unauthorized 错误,因为 JFrog 需要一个空的用户名,但当使用 --token 时,uv 会将 __token__ 作为用户名传递。

要进行身份验证,请将您的令牌作为密码传递,并将用户名设置为空字符串

$ uv publish --index <index_name> -u "" -p "$JFROG_TOKEN"

或者,您可以设置环境变量

$ export UV_PUBLISH_USERNAME=""
$ export UV_PUBLISH_PASSWORD="$JFROG_TOKEN"
$ uv publish --index private-registry

注意

发布环境变量(UV_PUBLISH_USERNAMEUV_PUBLISH_PASSWORD)不包含索引名称。