Skip to main content

CLI for creating a Python Package Repository in a GCS bucket

Project description

Python package

gcs_pypi is a CLI for creating a Python Package Repository in an GCS bucket.

Getting started

Installation

Install gcs_pypi using pip:

pip install gcs_pypi

Usage

GCS Bucket

  • Create a new bucket

IAM (Role & Service Account)

Setup service account with the following permissions

storage.buckets.get
storage.buckets.getIamPolicy
storage.buckets.update
storage.objects.create
storage.objects.delete
storage.objects.get
storage.objects.getIamPolicy
storage.objects.list
storage.objects.setIamPolicy

Recommended that you create a custom Role which can be inherited by the service account

Example

  • Create Role “PYPI”

  • Assign Permissions

storage.buckets.get
storage.buckets.getIamPolicy
storage.buckets.update
storage.objects.create
storage.objects.delete
storage.objects.get
storage.objects.getIamPolicy
storage.objects.list
storage.objects.setIamPolicy
  • Create a Service Account e.g pypi

  • Select the “PYPI” Role created above

  • Add a condition to limit access to only that GCS bucket

resource.name == "mybucket"

Visit Cloud IAM Conditions for more information

Distributing packages

You can now use gcspypi to create Python packages and upload them to your GCS bucket. To hide packages from the public, you can use the --private option to prevent the packages from being accessible directly via the GCS bucket (they will only be accessible via your Domain or alternatively you can specify a secret subdirectory using the --secret option:

cd /path/to/your-project/
gcspypi --bucket mybucket [--private] [--secret SECRET]

Cache Header

Set cache-control header for index.html

$ gsutil setmeta -h "cache-control:public, must-revalidate, proxy-revalidate, max-age=0" gs://[BUCKET]/index.html

Installing packages

Install your packages using pip by pointing the --extra-index-url to your Custom domain (optionally followed by a secret subdirectory):

pip install your-project --extra-index-url https://pypi.example.com/SECRET/

Alternatively, you can configure the index URL in ~/.pip/pip.conf:

[global]
extra-index-url = https://pypi.example.com/SECRET/

Credits

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gcs_pypi-0.1.100.tar.gz (6.8 kB view details)

Uploaded Source

Built Distribution

gcs_pypi-0.1.100-py3-none-any.whl (8.0 kB view details)

Uploaded Python 3

File details

Details for the file gcs_pypi-0.1.100.tar.gz.

File metadata

  • Download URL: gcs_pypi-0.1.100.tar.gz
  • Upload date:
  • Size: 6.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.8.2

File hashes

Hashes for gcs_pypi-0.1.100.tar.gz
Algorithm Hash digest
SHA256 2f4f07d0562b95fc4bd975bba31db77dd08d8091d7406580032fa85023b07e32
MD5 1b189d5f66e29250f5d42be07c16d2aa
BLAKE2b-256 74d888bf03deda49f0a4fd9eaf5a18ca3bdc5aaa209b865230072e65d9064f28

See more details on using hashes here.

File details

Details for the file gcs_pypi-0.1.100-py3-none-any.whl.

File metadata

  • Download URL: gcs_pypi-0.1.100-py3-none-any.whl
  • Upload date:
  • Size: 8.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.8.2

File hashes

Hashes for gcs_pypi-0.1.100-py3-none-any.whl
Algorithm Hash digest
SHA256 4397bcb05c6f1fbe77318a94fb7b30608589a63c92216d5bf4d9ddf872adfa49
MD5 264c574a16c3b78e1ad04f1635e03e0a
BLAKE2b-256 d882420f7963b74796677c6aaa30535ff7ba193e257794f7986f08ba1d753e33

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page