Stocker des packages Python dans Artifact Registry

Ce guide de démarrage rapide explique comment configurer un dépôt Python Artifact Registry privé, importer un package, puis l'installer.

Avant de commencer

  1. Connectez-vous à votre compte Google Cloud. Si vous débutez sur Google Cloud, créez un compte pour évaluer les performances de nos produits en conditions réelles. Les nouveaux clients bénéficient également de 300 $ de crédits gratuits pour exécuter, tester et déployer des charges de travail.

  2. Dans Google Cloud Console, sur la page de sélection du projet, sélectionnez ou créez un projet Google Cloud.

    Accéder au sélecteur de projet

  3. Vérifiez que la facturation est activée pour votre projet Google Cloud.

  4. Activez l'API Artifact Registry

    Activer l'API

    5.

  5. Dans Google Cloud Console, sur la page de sélection du projet, sélectionnez ou créez un projet Google Cloud.

    Accéder au sélecteur de projet

  6. Vérifiez que la facturation est activée pour votre projet Google Cloud.

  7. Activez l'API Artifact Registry

    Activer l'API

    8.

Lancer Cloud Shell

Dans ce guide de démarrage rapide, vous allez utiliser Cloud Shell, un environnement shell permettant de gérer les ressources hébergées sur Google Cloud.

Cloud Shell est préinstallé avec Google Cloud CLI et Python. gcloud CLI fournit l'interface de ligne de commande principale pour Google Cloud.

Lancez Cloud Shell :

  1. Accédez à Google Cloud Console.

    Google Cloud Console

  2. Dans la barre d'outils de la console Google Cloud, cliquez sur Activer Cloud Shell:

Une session Cloud Shell s'ouvre dans un cadre situé en bas de la console. Cette interface système vous permet d'exécuter les commandes gcloud.

Installer les packages requis

Twine est un outil permettant de publier des packages Python. Vous utiliserez Twine pour importer un package dans Artifact Registry.

Dans ce guide de démarrage rapide, vous allez utiliser l'installation Python incluse dans Cloud Shell. Cette installation par défaut inclut le backend de trousseau de clés Artifact Registry, qui permet de gérer l'authentification avec Artifact Registry. Si vous créez un environnement virtuel ou configurez Python en dehors de Cloud Shell, vous devez installer le backend du trousseau pour l'authentification. Pour en savoir plus, consultez S'authentifier avec un trousseau.

Pour installer Twine, exécutez la commande suivante:

pip install twine

Vous êtes maintenant prêt à configurer Artifact Registry.

Créer un dépôt

Créez le dépôt de vos packages.

  1. Exécutez la commande suivante pour créer un dépôt de packages Python dans le projet actuel, nommé quickstart-python-repo, à l'emplacement us-central1.

    gcloud artifacts repositories create quickstart-python-repo \
    --repository-format=python \
    --location=us-central1 \
    --description="Python package repository"

  2. Exécutez la commande suivante pour vérifier que votre dépôt a bien été créé :

    gcloud artifacts repositories list

  3. Pour simplifier les commandes gcloud, définissez le dépôt par défaut sur quickstart-python-repo et l'emplacement par défaut sur us-central1. Une fois les valeurs définies, vous n'avez pas besoin de les spécifier dans les commandes gcloud nécessitant un dépôt ou un emplacement.

    Pour définir le dépôt, exécutez la commande suivante :

    gcloud config set artifacts/repository quickstart-python-repo

    Pour définir l'emplacement, exécutez la commande suivante :

    gcloud config set artifacts/location us-central1

    Pour plus d'informations sur ces commandes, consultez la documentation gcloud config set.

Configurer l'authentification

Le backend de trousseau Artifact Registry trouve vos identifiants à l'aide des Identifiants par défaut de l'application (ADC), une stratégie qui recherche les identifiants dans votre environnement.

Dans ce guide de démarrage rapide, vous allez:

  • Générez des identifiants utilisateur pour l'ADC. Dans un environnement de production, vous devez utiliser un compte de service et fournir des identifiants avec la variable d'environnement GOOGLE_APPLICATION_CREDENTIALS.
  • Incluez l'URL du dépôt Artifact Registry dans les commandes pip et twine afin de ne pas avoir à configurer pip et Twine avec l'URL du dépôt.

Pour générer des identifiants pour ADC, exécutez la commande suivante:

gcloud auth application-default login

Pour en savoir plus sur les méthodes d'authentification et sur l'ajout de dépôts à la configuration pip et Twine, consultez la section Configurer l'authentification auprès des dépôts de packages Python.

Obtenir un exemple de package

Lorsque vous compilez un projet Python, les fichiers de distribution sont enregistrés dans un sous-répertoire dist de votre projet Python. Pour simplifier ce guide de démarrage rapide, vous allez télécharger les fichiers de packages prédéfinis.

  1. Créez un dossier de projet Python nommé python-quickstart.

    mkdir python-quickstart

  2. Créez un sous-répertoire nommé dist, puis accédez au répertoire.

    mkdir python-quickstart/dist
cd python-quickstart/dist

  3. Téléchargez les exemples de packages Python utilisés dans le tutoriel Empaqueter des projets Python du guide de l'utilisateur d'empaquetage Python.

    pip download sampleproject

    La commande télécharge le package sampleproject et sa dépendance, peppercorn.

Importer le package dans le dépôt

Utilisez Twine pour importer vos packages dans votre dépôt.

  1. Dans le répertoire dist, accédez au répertoire parent python-quickstart.

    cd ..

  2. Importez les packages dans le dépôt à partir du répertoire dist.

    python3 -m twine upload --repository-url https://us-central1-python.pkg.dev/PROJECT_ID/quickstart-python-repo/ dist/*

    Lorsque vous exécutez la commande avec python3 -m, Python localise twine et exécute la commande. Si la commande twine se trouve dans le chemin d'accès de votre système, vous pouvez l'exécuter sans python3 -m.

Twine importe à la fois sampleproject et peppercorn dans votre dépôt.

Afficher le package dans le dépôt

Pour vérifier que votre package a été ajouté, répertoriez les packages dans le dépôt quickstart-python-repo.

Exécutez la commande suivante :

gcloud artifacts packages list --repository=quickstart-python-repo

Pour afficher les versions d'un package, exécutez la commande suivante :

gcloud artifacts versions list --package=PACKAGE

Où PACKAGE correspond à l'ID de package.

Installer le package

Exécutez la commande suivante pour installer le package:

pip install --index-url https://us-central1-python.pkg.dev/PROJECT_ID/quickstart-python-repo/simple/ sampleproject

Dépannage

Par défaut, des outils tels que pip et Twine ne renvoient pas de messages d'erreur détaillés. Si vous rencontrez une erreur, réexécutez la commande avec l'option --verbose pour obtenir une sortie plus détaillée. Pour en savoir plus, consultez la section Dépannage des packages Python.

Effectuer un nettoyage

Pour éviter que les ressources utilisées sur cette page soient facturées sur votre compte Google Cloud, procédez comme suit :

Avant de supprimer le dépôt, assurez-vous que tous les packages que vous souhaitez conserver sont disponibles à un autre emplacement.

Pour supprimer le dépôt :

  1. Pour supprimer le dépôt quickstart-python-repo, exécutez la commande suivante :

    gcloud artifacts repositories delete quickstart-python-repo

  2. Si vous souhaitez supprimer le dépôt par défaut et les paramètres d'emplacement que vous avez définis pour la configuration gcloud active, exécutez les commandes suivantes :

    gcloud config unset artifacts/repository
gcloud config unset artifacts/location

Étapes suivantes