Menyimpan paket Python di Artifact Registry

Panduan memulai ini menunjukkan cara menyiapkan repositori Python Artifact Registry pribadi, mengupload paket, lalu menginstal paket.

Sebelum memulai

  1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

  2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  3. Make sure that billing is enabled for your Google Cloud project.

  4. Enable the Artifact Registry API.

    Enable the API

    5.

  5. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  6. Make sure that billing is enabled for your Google Cloud project.

  7. Enable the Artifact Registry API.

    Enable the API

    8.

Meluncurkan Cloud Shell

Dalam panduan memulai ini, Anda akan menggunakan Cloud Shell, yang merupakan lingkungan shell untuk mengelola resource yang dihosting di Google Cloud.

Cloud Shell telah diinstal lebih dulu dengan Google Cloud CLI dan Python. Gcloud CLI menyediakan antarmuka command line utama untuk Google Cloud.

Meluncurkan Cloud Shell:

  1. Buka Konsol Google Cloud.

    Konsol Google Cloud

  2. Di toolbar Konsol Google Cloud, klik Activate Cloud Shell:

Sesi Cloud Shell akan terbuka di dalam frame yang lebih rendah di konsol. Anda menggunakan shell ini untuk menjalankan perintah gcloud.

Menginstal paket yang diperlukan

Twine adalah alat untuk memublikasikan paket Python. Anda akan menggunakan Twine untuk mengupload paket ke Artifact Registry.

Dalam panduan memulai ini, Anda akan menggunakan penginstalan Python yang disertakan dengan Cloud Shell. Penginstalan default ini mencakup backend keyring Artifact Registry: untuk menangani autentikasi dengan Artifact Registry. Jika membuat lingkungan virtual atau menyiapkan Python di luar Cloud Shell, Anda harus menginstal backend keyring untuk autentikasi. Untuk mengetahui detailnya, lihat Melakukan autentikasi dengan keyring.

Untuk menginstal Twine, jalankan perintah:

pip install twine

Sekarang Anda siap menyiapkan Artifact Registry.

Membuat repositori

Buat repositori untuk paket Anda.

  1. Jalankan perintah berikut untuk membuat repositori paket Python baru di project saat ini bernama quickstart-python-repo di lokasi us-central1.

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

  2. Jalankan perintah berikut untuk memverifikasi bahwa repositori Anda telah dibuat:

    gcloud artifacts repositories list

  3. Untuk menyederhanakan perintah gcloud, tetapkan repositori default ke quickstart-python-repo dan lokasi default ke us-central1. Setelah nilai ditetapkan, Anda tidak perlu menentukannya dalam perintah gcloud yang memerlukan repositori atau lokasi.

    Untuk menetapkan repositori, jalankan perintah:

    gcloud config set artifacts/repository quickstart-python-repo

    Untuk menetapkan lokasi, jalankan perintah:

    gcloud config set artifacts/location us-central1

    Untuk mengetahui informasi selengkapnya tentang perintah ini, lihat dokumentasi gcloud config set.

Mengonfigurasi autentikasi

Backend keyring Artifact Registry menemukan kredensial Anda menggunakan Kredensial Default Aplikasi (ADC), strategi yang mencari kredensial di lingkungan Anda.

Dalam panduan memulai ini, Anda akan:

  • Buat kredensial pengguna untuk ADC. Di lingkungan produksi, Anda harus menggunakan akun layanan dan memberikan kredensial dengan variabel lingkungan GOOGLE_APPLICATION_CREDENTIALS.
  • Sertakan URL repositori Artifact Registry dalam perintah pip dan twine sehingga Anda tidak perlu mengonfigurasi pip dan Twine dengan URL repositori.

Untuk membuat kredensial ADC, jalankan perintah berikut:

gcloud auth application-default login

Untuk mengetahui detail tentang metode autentikasi dan menambahkan repositori ke konfigurasi pip dan Twine, lihat Menyiapkan autentikasi ke repositori paket Python.

Mendapatkan paket contoh

Saat Anda mem-build project Python, file distribusi disimpan di subdirektori dist dalam project Python Anda. Untuk menyederhanakan panduan memulai ini, Anda akan mendownload file paket bawaan.

  1. Buat folder project Python bernama python-quickstart.

    mkdir python-quickstart

  2. Buat subdirektori bernama dist, lalu ubah ke direktori tersebut.

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

  3. Download contoh paket Python yang digunakan dalam tutorial Panduan Pengguna Pengemasan Python Mengemasan Project Python.

    pip download sampleproject

    Perintah ini mendownload paket sampleproject dan dependensinya, peppercorn.

Mengupload paket ke repositori

Gunakan Twine untuk mengupload paket ke repositori.

  1. Dari direktori dist, ubah ke direktori induk python-quickstart.

    cd ..

  2. Upload paket ke repositori dari direktori dist Anda.

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

    Saat Anda menjalankan perintah dengan python3 -m, Python akan menemukan twine dan menjalankan perintah. Jika perintah twine berada di jalur sistem, Anda dapat menjalankannya tanpa python3 -m.

Twine mengupload sampleproject dan peppercorn ke repositori Anda.

Melihat paket di repositori

Untuk memverifikasi bahwa paket Anda telah ditambahkan, cantumkan paket di repositori quickstart-python-repo.

Jalankan perintah berikut:

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

Untuk melihat versi paket, jalankan perintah berikut:

gcloud artifacts versions list --package=PACKAGE

Dengan PACKAGE adalah ID paket.

Menginstal paket

Jalankan perintah berikut untuk menginstal paket:

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

Pemecahan masalah

Secara default, alat seperti pip dan Twine tidak menampilkan pesan error mendetail. Jika Anda mengalami error, jalankan kembali perintah dengan flag --verbose untuk mendapatkan output yang lebih mendetail. Lihat Pemecahan masalah untuk paket Python untuk mengetahui informasi selengkapnya.

Pembersihan

Agar tidak menimbulkan biaya pada akun Google Cloud Anda untuk resource yang digunakan pada halaman ini, ikuti langkah-langkah berikut.

Sebelum menghapus repositori, pastikan paket yang ingin Anda simpan tersedia di lokasi lain.

Untuk menghapus repositori:

  1. Untuk menghapus repositori quickstart-python-repo, jalankan perintah berikut:

    gcloud artifacts repositories delete quickstart-python-repo

  2. Jika Anda ingin menghapus setelan repositori dan lokasi default yang dikonfigurasi untuk konfigurasi gcloud aktif, jalankan perintah berikut:

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

Langkah selanjutnya