terralab-cli 3.2.2__tar.gz → 3.2.4__tar.gz

{terralab_cli-3.2.2 → terralab_cli-3.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: terralab-cli
-Version: 3.2.2
+Version: 3.2.4
 Summary: Command line interface for interacting with the Terra Scientific Pipelines Service, or Teaspoons.
 License-File: LICENSE
 Author: Terra Scientific Services
@@ -15,12 +15,12 @@ Requires-Dist: click (>=8.1.7,<9.0.0)
 Requires-Dist: colorlog (>=6.9.0,<7.0.0)
 Requires-Dist: cryptography (>=44.0.1,<48.0.0)
 Requires-Dist: oauth2-cli-auth (>=1.5,<3.0)
-Requires-Dist: poetry (==2.3.4)
+Requires-Dist: poetry (==2.4.0)
 Requires-Dist: prompt-toolkit (>=3.0.51,<4.0.0)
 Requires-Dist: python-dotenv (>=1.0.1,<2.0.0)
 Requires-Dist: requests (>=2.32.3,<3.0.0)
 Requires-Dist: tabulate (>=0.9,<0.11)
-Requires-Dist: terra-scientific-pipelines-service-api-client (==2.4.2)
+Requires-Dist: terra-scientific-pipelines-service-api-client (==2.4.5)
 Requires-Dist: tqdm (>=4.67.0,<5.0.0)
 Requires-Dist: tzlocal (>=5.2,<6.0)
 Description-Content-Type: text/markdown

{terralab_cli-3.2.2 → terralab_cli-3.2.4}/pyproject.toml

@@ -1,7 +1,7 @@
 [tool.poetry]
 name = "terralab-cli"
 # version is auto-incremented. do not edit.
-version = "3.2.2"
+version = "3.2.4"
 description = "Command line interface for interacting with the Terra Scientific Pipelines Service, or Teaspoons."
 authors = ["Terra Scientific Services <teaspoons-developers@broadinstitute.org>"]
 readme = "README.md"
@@ -14,7 +14,7 @@ terralab = "terralab.cli:cli"
 
 [tool.poetry.dependencies]
 python = "^3.12"
-terra-scientific-pipelines-service-api-client = "2.4.2"
+terra-scientific-pipelines-service-api-client = "2.4.5"
 python-dotenv = "^1.0.1"
 click = "^8.1.7"
 colorlog = "^6.9.0"
@@ -24,7 +24,7 @@ requests = "^2.32.3"
 tqdm = "^4.67.0"
 tzlocal = "^5.2"
 tabulate = ">=0.9,<0.11"
-poetry = "2.3.4"
+poetry = "2.4.0"
 cryptography = ">=44.0.1,<48.0.0"
 prompt-toolkit = "^3.0.51"
 

{terralab_cli-3.2.2 → terralab_cli-3.2.4}/terralab/cli.py

@@ -13,6 +13,7 @@ from terralab.commands.auth_commands import logout, login_with_oauth, login
 from terralab.commands.pipeline_runs_commands import (
     submit,
     download,
+    deliver,
     jobs,
     details as details_jobs,
     list_command as list_jobs,
@@ -74,6 +75,9 @@ def cli(debug: bool) -> None:
 cli.add_command(submit)
 cli.add_command(download)
 
+# deliver
+cli.add_command(deliver)
+
 # jobs
 cli.add_command(jobs)
 cli.add_command(list_jobs, name="  jobs list")

{terralab_cli-3.2.2 → terralab_cli-3.2.4}/terralab/commands/pipeline_runs_commands.py

@@ -5,7 +5,7 @@ from typing import Any
 import uuid
 
 import click
-from teaspoons_client import AsyncPipelineRunResponseV2, PipelineRun  # type: ignore[attr-defined]
+from teaspoons_client import AsyncPipelineRunResponseV2, DataDeliveryReport, PipelineRun  # type: ignore[attr-defined]
 
 from terralab.constants import FAILED_KEY, SUPPORT_EMAIL_TEXT, SUCCEEDED_KEY
 from terralab.log import (
@@ -19,6 +19,7 @@ from terralab.utils import (
     convert_file_size_to_human_readable,
     handle_api_exceptions,
     process_inputs_to_dict,
+    validate_gcs_path,
     validate_job_id,
     format_timestamp,
 )
@@ -151,6 +152,8 @@ def details(job_id: str) -> None:
             )
         )
 
+    display_data_delivery(response.pipeline_run_report.data_delivery_report)
+
 
 def display_outputs(outputs: dict[str, dict[str, Any]] | None) -> None:
     if not outputs:
@@ -178,6 +181,14 @@ def display_outputs(outputs: dict[str, dict[str, Any]] | None) -> None:
         )
 
 
+def display_data_delivery(data_delivery_report: DataDeliveryReport | None) -> None:
+    if not data_delivery_report:
+        return
+    LOGGER.info(add_blankline_before("Data Delivery:"))
+    LOGGER.info(indented(f"Status: {format_status(data_delivery_report.status)}"))
+    LOGGER.info(indented(f"Destination: {data_delivery_report.destination}"))
+
+
 @jobs.command(name="list", short_help="List your jobs")
 @click.option(
     "--num_results",
@@ -213,3 +224,32 @@ def list_command(num_results: int) -> None:
             )
 
         LOGGER.info(format_table_with_status(row_list))
+
+
+# DELIVER group
+
+
+@click.command(short_help="Deliver output files from a job to a cloud destination")
+@click.argument("job_id", type=str)
+@click.argument("destination", type=str)
+@handle_api_exceptions
+def deliver(job_id: str, destination: str) -> None:
+    """Deliver output files from a job with JOB_ID identifier to a DESTINATION GCS path.
+
+    Note: delivering your data to a cloud destination will disable downloading locally.
+    """
+    job_id_uuid: uuid.UUID = validate_job_id(job_id)
+    validated_destination: str = validate_gcs_path(destination)
+
+    pipeline_runs_logic.deliver_pipeline_run_to_cloud(
+        job_id_uuid, validated_destination
+    )
+
+    LOGGER.info(
+        f"Successfully initiated data delivery for job {job_id} to {validated_destination}. Delivery may take a few minutes to complete."
+    )
+    LOGGER.info(
+        add_blankline_before(
+            f"You can check the status of the delivery with `terralab jobs details {job_id}`."
+        )
+    )

{terralab_cli-3.2.2 → terralab_cli-3.2.4}/terralab/log.py

@@ -124,7 +124,7 @@ def format_status_in_table_row(
 
 
 def format_status(status_str: str) -> str:
-    return COLORFUL_STATUS[status_str]
+    return COLORFUL_STATUS.get(status_str, status_str)
 
 
 # This filter makes the retry messages from urllib3 more user-friendly.

{terralab_cli-3.2.2 → terralab_cli-3.2.4}/terralab/logic/pipeline_runs_logic.py

@@ -7,11 +7,13 @@ from typing import Any
 from teaspoons_client import (  # type: ignore[attr-defined]
     AsyncPipelineRunResponseV2,
     JobControl,
+    JobReport,
     PipelineRun,
     PipelineRunOutputSignedUrlsResponse,
     PipelineRunsApi,
     PreparePipelineRunRequestBody,
     PreparePipelineRunResponseV2,
+    StartDataDeliveryRequestBody,
     StartPipelineRunRequestBody,
 )
 
@@ -167,6 +169,23 @@ def prepare_upload_start_pipeline_run(
     return start_pipeline_run(job_id)
 
 
+## deliver action
+
+
+def deliver_pipeline_run_to_cloud(
+    job_id: uuid.UUID, destination_gcs_path: str
+) -> JobReport:
+    """Call the deliverPipelineRunOutputFilesToCloud Teaspoons endpoint and return the JobReport."""
+    start_data_delivery_request_body = StartDataDeliveryRequestBody(
+        destinationGcsPath=destination_gcs_path
+    )
+    with ClientWrapper() as api_client:
+        pipeline_runs_client = PipelineRunsApi(api_client=api_client)
+        return pipeline_runs_client.deliver_pipeline_run_output_files_to_cloud(
+            str(job_id), start_data_delivery_request_body
+        )
+
+
 ## download action
 
 

{terralab_cli-3.2.2 → terralab_cli-3.2.4}/terralab/utils.py

@@ -17,7 +17,11 @@ from tqdm import tqdm
 from tqdm.contrib.logging import logging_redirect_tqdm
 from urllib3.exceptions import MaxRetryError
 
-from terralab.constants import MAX_FILE_UPLOAD_SIZE_BYTES, SUPPORT_EMAIL_TEXT
+from terralab.constants import (
+    MAX_FILE_UPLOAD_SIZE_BYTES,
+    SUPPORT_EMAIL_TEXT,
+    GCS_PREFIX,
+)
 from terralab.log import add_blankline_before
 
 LOGGER = logging.getLogger(__name__)
@@ -284,6 +288,18 @@ def validate_job_id(job_id: str) -> uuid.UUID:
         exit(1)
 
 
+def validate_gcs_path(gcs_path: str) -> str:
+    """Validates that the provided string is a valid GCS path (gs://bucket/...).
+
+    Returns the path if valid, otherwise logs an error and exits."""
+    if not gcs_path.startswith(GCS_PREFIX) or len(gcs_path) <= len(GCS_PREFIX):
+        LOGGER.error(
+            f"Error: '{gcs_path}' is not a valid GCS path. GCS paths must start with '{GCS_PREFIX}' followed by a bucket name."
+        )
+        exit(1)
+    return gcs_path
+
+
 def format_timestamp(
     timestamp_string: str | None, timestamp_format: str = "%Y-%m-%d %H:%M"
 ) -> str: