terralab-cli 3.2.5__tar.gz → 3.2.7__tar.gz

{terralab_cli-3.2.5 → terralab_cli-3.2.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: terralab-cli
-Version: 3.2.5
+Version: 3.2.7
 Summary: Command line interface for interacting with the Terra Scientific Pipelines Service, or Teaspoons.
 License-File: LICENSE
 Author: Terra Scientific Services
@@ -20,7 +20,7 @@ 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 (==3.0.2)
+Requires-Dist: terra-scientific-pipelines-service-api-client (==4.0.0)
 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.5 → terralab_cli-3.2.7}/pyproject.toml

@@ -1,7 +1,7 @@
 [tool.poetry]
 name = "terralab-cli"
 # version is auto-incremented. do not edit.
-version = "3.2.5"
+version = "3.2.7"
 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 = "3.0.2"
+terra-scientific-pipelines-service-api-client = "4.0.0"
 python-dotenv = "^1.0.1"
 click = "^8.1.7"
 colorlog = "^6.9.0"

{terralab_cli-3.2.5 → terralab_cli-3.2.7}/terralab/commands/pipeline_runs_commands.py

@@ -7,7 +7,12 @@ import uuid
 import click
 from teaspoons_client import AsyncPipelineRunResponseV2, DataDeliveryReport, PipelineRun  # type: ignore[attr-defined]
 
-from terralab.constants import FAILED_KEY, SUPPORT_EMAIL_TEXT, SUCCEEDED_KEY
+from terralab.constants import (
+    FAILED_KEY,
+    SUPPORT_EMAIL_TEXT,
+    SUCCEEDED_KEY,
+    TERMS_OF_SERVICE_URL,
+)
 from terralab.log import (
     indented,
     add_blankline_before,
@@ -38,10 +43,21 @@ LOGGER = logging.getLogger(__name__)
 @click.option(
     "--description", type=str, default="", help="optional description for the job"
 )
+@click.option(
+    "agree_to_terms",
+    "--agreeToTerms",
+    is_flag=True,
+    help=f"Agree to the terms of service ({TERMS_OF_SERVICE_URL}). This is required to run a pipeline.",
+    prompt=f"Please agree to the terms of service ({TERMS_OF_SERVICE_URL}) to run a pipeline. Do you agree?",
+)
 @click.argument("inputs", nargs=-1, type=click.UNPROCESSED)
 @handle_api_exceptions
 def submit(
-    pipeline_name: str, version: int, inputs: tuple[str, ...], description: str
+    pipeline_name: str,
+    version: int,
+    inputs: tuple[str, ...],
+    description: str,
+    agree_to_terms: bool,
 ) -> None:
     """Submit a job for a PIPELINE_NAME pipeline
 
@@ -54,8 +70,16 @@ def submit(
     # validate inputs
     pipelines_logic.validate_pipeline_inputs(pipeline_name, version, inputs_dict)
 
+    if not agree_to_terms:
+        LOGGER.error(
+            add_blankline_before(
+                "You must agree to the terms of service to run a pipeline. Use the --agreeToTerms flag to indicate your agreement."
+            )
+        )
+        exit(1)
+
     submitted_job_id = pipeline_runs_logic.prepare_upload_start_pipeline_run(
-        pipeline_name, version, inputs_dict, description
+        pipeline_name, version, inputs_dict, description, agree_to_terms
     )
 
     LOGGER.info(f"Successfully started {pipeline_name} job {submitted_job_id}")

{terralab_cli-3.2.5 → terralab_cli-3.2.7}/terralab/commands/pipelines_commands.py

@@ -109,6 +109,6 @@ def details(pipeline_name: str, version: int) -> None:
     inputs_string_for_usage = " ".join(inputs_for_usage)
     LOGGER.info(
         add_blankline_before(
-            f"{pad_column('Example usage', 20)}terralab submit {pipeline_info.pipeline_name} {inputs_string_for_usage} --description 'YOUR JOB DESCRIPTION HERE'"
+            f"{pad_column('Example usage', 20)}terralab submit {pipeline_info.pipeline_name} {inputs_string_for_usage} --description 'YOUR JOB DESCRIPTION HERE' --agreeToTerms"
         )
     )

{terralab_cli-3.2.5 → terralab_cli-3.2.7}/terralab/constants.py

@@ -20,3 +20,4 @@ MAX_FILE_UPLOAD_SIZE_BYTES = 50 * 1025 * 1024 * 1024  # 50GB
 # support text
 SUPPORT_EMAIL = "scientific-services-support@broadinstitute.org"
 SUPPORT_EMAIL_TEXT = f"For help troubleshooting, email {SUPPORT_EMAIL}"
+TERMS_OF_SERVICE_URL = "https://services.terra.bio/#pipelines/terms-of-service"

{terralab_cli-3.2.5 → terralab_cli-3.2.7}/terralab/logic/pipeline_runs_logic.py

@@ -11,7 +11,7 @@ from teaspoons_client import (  # type: ignore[attr-defined]
     PipelineRun,
     PipelineRunOutputSignedUrlsResponse,
     PipelineRunsApi,
-    PreparePipelineRunRequestBody,
+    PreparePipelineRunRequestBodyV2,
     PreparePipelineRunResponseV2,
     StartDataDeliveryRequestBody,
     StartPipelineRunRequestBody,
@@ -37,24 +37,26 @@ def prepare_pipeline_run(
     pipeline_version: int,
     pipeline_inputs: dict[str, Any],
     description: str,
+    agree_to_terms: bool,
 ) -> dict[str, str] | None:
     """Call the preparePipelineRunV2 Teaspoons endpoint.
     Return a dictionary of {input_name: signed_url} if inputs are local, else (cloud inputs) return None.
     """
-    prepare_pipeline_run_request_body: PreparePipelineRunRequestBody = (
-        PreparePipelineRunRequestBody(
+    prepare_pipeline_run_request_body: PreparePipelineRunRequestBodyV2 = (
+        PreparePipelineRunRequestBodyV2(
             jobId=job_id,
             pipelineName=pipeline_name,
             pipelineVersion=pipeline_version,
             pipelineInputs=pipeline_inputs,
             description=description,
+            agreeToTerms=agree_to_terms,
         )
     )
 
     with ClientWrapper() as api_client:
         pipeline_runs_client = PipelineRunsApi(api_client=api_client)
         response: PreparePipelineRunResponseV2 = (
-            pipeline_runs_client.prepare_pipeline_run_v2(
+            pipeline_runs_client.prepare_pipeline_run_v3(
                 prepare_pipeline_run_request_body
             )
         )
@@ -143,6 +145,7 @@ def prepare_upload_start_pipeline_run(
     pipeline_version: int,
     pipeline_inputs: dict[str, Any],
     description: str,
+    agree_to_terms: bool,
 ) -> str:
     """Prepare pipeline run, upload input files if input files are local, and start pipeline run.
     Returns the uuid of the job."""
@@ -151,7 +154,12 @@ def prepare_upload_start_pipeline_run(
     LOGGER.info(f"Generated job_id {job_id}")
 
     file_input_upload_urls: dict[str, str] | None = prepare_pipeline_run(
-        pipeline_name, job_id, pipeline_version, pipeline_inputs, description
+        pipeline_name,
+        job_id,
+        pipeline_version,
+        pipeline_inputs,
+        description,
+        agree_to_terms,
     )
 
     if file_input_upload_urls: