Python的Artifact Registry工具

此存储库包含一个替代的keyring后端实现，以帮助与在Artifact Registry上托管的Python存储库交互。

身份验证

keyrings.google-artifactregistry-auth是一个Python包，允许您配置密钥环以与存储在Artifact Registry中的Python存储库交互。

后端自动从环境中搜索凭据并验证到Artifact Registry。它会按照以下顺序查找凭据

1. Google应用程序默认凭据.
2. 来自gcloud SDK。（即，通过gcloud config config-helper --format='value(credential.access_token)'打印的访问令牌）
   • 提示：您可以使用以下命令查看哪个账户处于活动状态：gcloud config config-helper --format='value(configuration.properties.core.account)'
3. 如果它们都不存在，则会发生错误。

要使用密钥环后端

1. 登录

   选项1：以服务账户登录

   （1）使用包含服务账户密钥的JSON文件

   $ export GOOGLE_APPLICATION_CREDENTIALS=[path/to/key.json]
   

   （2）或使用gcloud

   $ gcloud auth application-default login
   

   选项2：通过gcloud以最终用户身份登录

   $ gcloud auth login
   

2. 配置twine（.pypirc）和pip（pip.conf）工具以连接到存储库。使用以下命令的输出

    $ gcloud artifacts print-settings python
   

   在您的.pypirc文件中添加

   [disutils]
   index-servers =
       REPOSITORY_ID
   
   [REPOSITORY_ID]
   repository = https://LOCATION-python.pkg.dev/PROJECT_ID/REPOSITORY_ID/
   

   在您的pip.conf文件中添加

   [global]
   extra-index-url = https://LOCATION-python.pkg.dev/PROJECT_ID/REPOSITORY_ID/simple/
   

3. 安装 keyrings.google-artifactregistry-auth 软件包

   $ pip install keyrings.google-artifactregistry-auth
   

   列出后端以确认安装。

   $ keyring --list-backends
   

   列表应包括

   • keyrings.gauth.GooglePythonAuth (优先级：9)
   • keyring.backends.chainer.ChainerBackend (优先级：-1)
   • keyring.backends.fail.Keyring (优先级：0)

与其他工具的使用

与 tox 的使用

tox 工具 是一个测试和自动化工具。

由于凭证助手需要在安装任何私有依赖项之前安装，因此需要通过插件将其引导到 tox 环境中。

为此，请在您的 tox.ini 文件中通过 requires 依赖项指定 keyrings.google-artifactregistry-auth 软件包

[tox]
envlist = py
requires = keyrings.google-artifactregistry-auth

[testenv]
deps = -r requirements.txt

然后，您可以将您的 requirement.txt 文件配置为使用 Artifactory 仓库作为额外索引，并指定公共和私有依赖项

--extra-index-url https://[REGION]-python.pkg.dev/[PROJECT_ID]/[REPOSITORY]/simple

# samplepackage will be installed directly from PyPI
samplepackage
# mypackage will be installed from the Artifact Registry repository
mypackage