geeViz.gcpLib

Copyright 2019 Leah Campbell

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Functions

clearBucket(bucket_name)

Delete every object in a GCS bucket via gsutil rm -v.

download_to_local(bucket_name, trainingDataPath)

Sync objects from a GCS bucket to a local directory via gsutil.
geeViz.gcpLib.download_to_local(bucket_name, trainingDataPath, exportNamePrefix='')[source]

Sync objects from a GCS bucket to a local directory via gsutil.

Uses gsutil -m cp -n -r — parallel, no-clobber, recursive. The -n flag skips objects that already exist locally, so re-running is cheap.

Parameters:

  • bucket_name (str) – Name of the GCS bucket (no gs:// prefix).

  • trainingDataPath (str) – Local destination directory.

  • exportNamePrefix (str) – Object-name prefix filter. Empty string (default) downloads the whole bucket.

geeViz.gcpLib.clearBucket(bucket_name)[source]

Delete every object in a GCS bucket via gsutil rm -v.

Destructive — removes ALL contents of gs://<bucket_name>/. The bucket itself is preserved. Requires gsutil on PATH and sufficient IAM permissions.

Parameters:

bucket_name (str) – Name of the GCS bucket (no gs:// prefix).