Administra paquetes de Python

En esta página, se describe cómo agregar, ver y borrar versiones de paquetes y paquetes de Python.

Antes de comenzar

1. Instala y, luego, inicializa Google Cloud CLI.

   Se requiere la versión 354.0.0 o posterior de Google Cloud CLI para ejecutar comandos para repositorios de Python. Puedes verificar la versión con el siguiente comando:

   gcloud version
   

2. Si el repositorio de destino no existe, crea un repositorio de paquetes de Python nuevo.

3. Verifica que Python 3 esté instalado. Para obtener instrucciones de instalación, consulta elGoogle Cloud instructivo para configurar Python.

4. (Opcional) Configura valores predeterminados para los comandos de gcloud.

5. Si usas la autenticación de llavero con credenciales de gcloud, accede a Google Cloud CLI con tu cuenta de usuario o cuenta de servicio.

Roles obligatorios

Para obtener los permisos que necesitas para administrar paquetes, pídele a tu administrador que te otorgue los siguientes roles de IAM en el repositorio:

• Ver paquetes o archivos en paquetes: Lector de Artifact Registry (roles/artifactregistry.reader)
• Descarga o instala paquetes: Lector de Artifact Registry (roles/artifactregistry.reader)
• Agrega paquetes a un repositorio: Escritor de Artifact Registry (roles/artifactregistry.writer)
• Borra paquetes: Administrador del repositorio de Artifact Registry (roles/artifactregistry.repoAdmin)

Para obtener más información sobre cómo otorgar roles, consulta Administra el acceso a proyectos, carpetas y organizaciones.

También puedes obtener los permisos necesarios mediante roles personalizados o cualquier otro rol predefinido.

Agrega paquetes

Modos de repositorio: estándar

Cuando compilas un proyecto de Python, los archivos de distribución se guardan en un subdirectorio dist en tu proyecto. Luego, puedes usar Twine para subir paquetes a un repositorio estándar.

Te recomendamos que sigas estas prácticas recomendadas para tus paquetes:

• Usa nombres únicos para tus paquetes privados, de modo que no coincidan con los nombres de los paquetes en pypi.org, en especial si tu configuración de pip incluye varios índices de paquetes.
• Usa la especificación del identificador de versión en PEP 440 para los números de versión de tu paquete. De forma predeterminada, pip solo instala versiones estables. Utiliza la especificación del identificador de versión para distinguir las versiones estables de las versiones previas al lanzamiento y para analizar los requisitos de la versión que se instalará.

Para agregar un paquete, haz lo siguiente:

1. Instala Twine.

   pip install twine
   

2. Cambia al directorio de tu proyecto de Python.

3. Sube los archivos de distribución al repositorio desde el subdirectorio dist del proyecto. Ejecuta el siguiente comando:

   twine upload dist/*
   

   Puedes especificar un repositorio en particular con la marca --repository-url.

   twine upload --repository-url https://LOCATION-python.pkg.dev/PROJECT/REPOSITORY/ dist/*
   

Visualiza paquetes y versiones

Modos de repositorio: estándar, remoto

Para ver los paquetes y sus versiones con la Google Cloud consola o gcloud, haz lo siguiente:

gcloud artifacts packages list [--repository=REPOSITORY] [--location=LOCATION]

gcloud artifacts versions list --package=PACKAGE \
    [--repository=REPOSITORY] [--location=LOCATION]

En el caso de los repositorios remotos, la lista que se devuelve debe incluir todas las dependencias directas y transitivas.

Cómo enumerar archivos

Modos de repositorio: estándar, remoto

Puedes enumerar los archivos de un repositorio, los archivos de todas las versiones de un paquete especificado o los archivos de una versión específica de un paquete.

Para todos los siguientes comandos, puedes establecer una cantidad máxima de archivos que se devolverán agregando la marca --limit al comando.

Para enumerar todos los archivos en el proyecto, el repositorio y la ubicación predeterminados cuando se configuran los valores predeterminados, haz lo siguiente:

gcloud artifacts files list

Para enumerar los archivos en un proyecto, un repositorio y una ubicación especificados, ejecuta el siguiente comando:

gcloud artifacts files list \
    --project=PROJECT \
    --repository=REPOSITORY \
    --location=LOCATION

Para enumerar los archivos de todas las versiones de un paquete específico, haz lo siguiente:

gcloud artifacts files list \
    --project=PROJECT \
    --repository=REPOSITORY \
    --location=LOCATION \
    --package=PACKAGE

Para enumerar los archivos de una versión de paquete específica, haz lo siguiente:

gcloud artifacts files list \
    --project=PROJECT \
    --repository=REPOSITORY \
    --location=LOCATION \
    --package=PACKAGE \
    --version=VERSION

Reemplaza los siguientes valores:

• LOCATION: Es la ubicación regional o multirregional del repositorio.
• PROJECT: El Google Cloud ID del proyecto. Si el ID de tu proyecto contiene dos puntos (:), consulta Proyectos con alcance de dominio.
• REPOSITORY: Es el nombre del repositorio en el que se almacena la imagen.
• PACKAGE: Es el nombre del paquete.
• VERSION: Es la versión del paquete.

Ejemplos

Considera la siguiente información del paquete:

• Proyecto: my-project
• Repositorio: my-repo
• Ubicación del repositorio: us-west1
• Paquete: my-app

El siguiente comando enumera todos los archivos del repositorio my-repo en la ubicación us-west1 dentro del proyecto predeterminado:

gcloud artifacts files list \
    --location=us-west1 \
    --repository=my-repo

gcloud artifacts files list \
    --project=my-project \
    --location=us-west1 \
    --repository=my-repo \
    --package=my-app \
    --version=1.0

Instala paquetes

Modos de repositorio: estándar, remoto y virtual

Usa el comando pip para instalar paquetes.

Para instalar la versión estable más reciente de un paquete, ejecuta el siguiente comando:

pip install PACKAGE

En el caso de los repositorios estándar, descargas un paquete directamente desde el repositorio.

En el caso de un repositorio remoto, descargas una copia almacenada en caché del paquete y sus dependencias. Si no existe una copia en caché, el repositorio remoto descarga el paquete de la fuente upstream y lo almacena en caché antes de entregártelo. Para verificar que el repositorio remoto recuperó los paquetes de la fuente upstream, consulta la lista de paquetes en el repositorio.

En el caso de un repositorio virtual, Artifact Registry busca el paquete solicitado en los repositorios upstream.

• Los repositorios remotos upstream descargarán y almacenarán en caché el paquete solicitado si no existe una copia en caché. Los repositorios virtuales solo entregan los paquetes solicitados, no los almacenan.
• Si solicitas una versión que está disponible en más de un repositorio upstream, Artifact Registry elige un repositorio upstream para usarlo según la configuración de prioridad establecida para el repositorio virtual.

Por ejemplo, considera un repositorio virtual con los siguientes parámetros de configuración de prioridad para los repositorios upstream:

• main-repo: Prioridad establecida en 100
• secondary-repo1: Prioridad establecida en 80.
• secondary-repo2: Prioridad establecida en 80.
• test-repo: Prioridad establecida en 20.

main-repo tiene el valor de prioridad más alto, por lo que el repositorio virtual siempre lo busca primero.

Tanto secondary-repo1 como secondary-repo2 tienen la prioridad establecida en 80. Si un paquete solicitado no está disponible en main-repo, Artifact Registry buscará en estos repositorios a continuación. Dado que ambos tienen el mismo valor de prioridad, Artifact Registry puede optar por entregar un paquete desde cualquiera de los repositorios si la versión está disponible en ambos.

test-repo tiene el valor de prioridad más bajo y publicará un artefacto almacenado si ninguno de los otros repositorios upstream lo tiene.

Información adicional

De forma predeterminada, pip instala versiones estables de un paquete y omite las versiones previas al lanzamiento. La PEP 440 define la especificación del identificador de versión de Python que pip usa para analizar los números de versión, incluidas las versiones preliminares.

Para incluir versiones previas al lanzamiento cuando pip busque un paquete para instalar, agrega la marca --pre a tu comando.

pip install --pre PACKAGE

Para especificar un rango o una versión requerida, incluye un especificador de requisitos. Puedes incluir el requisito de versión directamente en tu comando o usar un archivo de requisitos.

Por ejemplo, este comando especifica que la versión mínima de my-package es la versión de desarrollo 1.0.dev0.

pip install --pre my-package>=1.0.dev0

Las versiones estables se consideran más nuevas que las versiones preliminares, por lo que, si la versión 1.0 está en el repositorio, pip elegirá la versión 1.0 en lugar de una versión preliminar.

Si no especificas un repositorio, la configuración de pip en pip.conf determinará cómo pip buscará el paquete.

• Si configuraste el repositorio de Artifact Registry con el parámetro de configuración index-url y no se configuraron otros índices de paquetes, pip solo buscará el paquete en tu repositorio de Artifact Registry.
• Si usas un repositorio virtual, Artifact Registry usa las prioridades configuradas en la política de upstream para elegir un paquete cuando varios repositorios de upstream tienen la versión del paquete solicitada. Si dos repositorios con el paquete tienen la misma prioridad, Artifact Registry lo publicará desde cualquiera de los dos.
• Si configuraste pip con el parámetro de configuración extra-index-url o si configuraste varios índices de paquetes, pip buscará en pypi.org y en cualquier otro índice de paquetes configurado, y elegirá la versión más reciente del paquete.

Puedes anular la configuración de index-url o extra-index-url en el archivo de requisitos. También puedes usar marcas para estos parámetros de configuración en tu comando pip. Por ejemplo, este comando reemplaza index-url por un repositorio de Artifact Registry.

pip install --index-url https://us-east1-python.pkg.dev/my-project/python-repo/simple/ my-package

Para obtener más información sobre la instalación de paquetes, consulta la documentación de Python Packaging.

Borra paquetes y versiones

Modos de repositorio: estándar, remoto

Puedes borrar un paquete y todas sus versiones, o bien borrar una versión específica.

• Una vez que borres un paquete, no podrás deshacer la acción.
• En el caso de los repositorios remotos, solo se borra la copia almacenada en caché del paquete. La fuente upstream no se ve afectada. Si borras un paquete almacenado en caché, Artifact Registry lo volverá a descargar y almacenar en caché la próxima vez que el repositorio reciba una solicitud para la misma versión del paquete.

Antes de borrar un paquete o una versión de un paquete, verifica que se haya comunicado o abordado cualquier dependencia importante en este.

Para borrar un paquete, haz lo siguiente:

gcloud artifacts packages delete PACKAGE \
    [--repository=REPOSITORY] [--location=LOCATION] [--async]

Para borrar versiones de un paquete, haz lo siguiente:

gcloud artifacts versions delete VERSION \
    --package=PACKAGE \
    [--repository=REPOSITORY] [--location=LOCATION] \
    [--async]

¿Qué sigue?

• Obtén más información para administrar paquetes de Java
• Obtén más información para administrar paquetes de Node.js
• Obtén más información para administrar imágenes de contenedor
• Cómo descargar archivos individuales dentro de un paquete