nextmv 0.39.0.dev1__py3-none-any.whl → 1.0.0__py3-none-any.whl

nextmv/cli/cloud/instance/update.py

@@ -0,0 +1,216 @@
+"""
+This module defines the cloud instance update command for the Nextmv CLI.
+"""
+
+import json
+from typing import Annotated
+
+import typer
+
+from nextmv.cli.cloud.instance.create import build_config, build_options
+from nextmv.cli.configuration.config import build_app
+from nextmv.cli.message import enum_values, error, print_json, success
+from nextmv.cli.options import AppIDOption, InstanceIDOption, ProfileOption
+from nextmv.input import InputFormat
+
+# Set up subcommand application.
+app = typer.Typer()
+
+
+@app.command()
+def update(
+    app_id: AppIDOption,
+    instance_id: InstanceIDOption,
+    description: Annotated[
+        str | None,
+        typer.Option(
+            "--description",
+            "-d",
+            help="A new description for the instance.",
+            metavar="DESCRIPTION",
+        ),
+    ] = None,
+    name: Annotated[
+        str | None,
+        typer.Option(
+            "--name",
+            "-n",
+            help="A new name for the instance.",
+            metavar="NAME",
+        ),
+    ] = None,
+    output: Annotated[
+        str | None,
+        typer.Option(
+            "--output",
+            "-u",
+            help="Saves the updated instance information to this location.",
+            metavar="OUTPUT_PATH",
+        ),
+    ] = None,
+    version_id: Annotated[
+        str | None,
+        typer.Option(
+            "--version-id",
+            "-v",
+            help="Update the instance to use a different version.",
+            metavar="VERSION_ID",
+        ),
+    ] = None,
+    # Options for updating the instance configuration.
+    content_format: Annotated[
+        InputFormat | None,
+        typer.Option(
+            "--content-format",
+            "-c",
+            help=f"The content format for the instance. Allowed values are: {enum_values(InputFormat)}.",
+            metavar="CONTENT_FORMAT",
+            rich_help_panel="Instance configuration",
+        ),
+    ] = None,
+    execution_class: Annotated[
+        str | None,
+        typer.Option(
+            "--execution-class",
+            "-x",
+            help="The execution class to use for the instance.",
+            metavar="EXECUTION_CLASS",
+            rich_help_panel="Instance configuration",
+        ),
+    ] = None,
+    integration_id: Annotated[
+        str | None,
+        typer.Option(
+            help="The integration ID to use for the runs of the instance, if applicable.",
+            metavar="INTEGRATION_ID",
+            rich_help_panel="Instance configuration",
+        ),
+    ] = None,
+    no_queuing: Annotated[
+        bool | None,
+        typer.Option(
+            "--no-queuing",
+            help="Do not queue when running the instance.",
+            rich_help_panel="Instance configuration",
+        ),
+    ] = None,
+    options: Annotated[
+        list[str] | None,
+        typer.Option(
+            "--options",
+            "-o",
+            help="Options to always use when running the instance. Format: [magenta]key=value[/magenta]. "
+            "Pass multiple options by repeating the flag, or separating with commas.",
+            metavar="KEY=VALUE",
+            rich_help_panel="Instance configuration",
+        ),
+    ] = None,
+    priority: Annotated[
+        int | None,
+        typer.Option(
+            help="The priority of the runs in the instance. "
+            "Priority is between 1 and 10, with 1 being the highest priority.",
+            metavar="PRIORITY",
+            rich_help_panel="Instance configuration",
+        ),
+    ] = None,
+    secret_collection_id: Annotated[
+        str | None,
+        typer.Option(
+            "--secret-collection-id",
+            "-s",
+            help="The secret collection ID to use for the instance, if applicable.",
+            metavar="SECRET_COLLECTION_ID",
+            rich_help_panel="Instance configuration",
+        ),
+    ] = None,
+    profile: ProfileOption = None,
+) -> None:
+    """
+    Updates a Nextmv Cloud application instance.
+
+    [bold][underline]Examples[/underline][/bold]
+
+    - Update an instance's name.
+        $ [dim]nextmv cloud instance update --app-id hare-app --instance-id prod --name "Production Instance"[/dim]
+
+    - Update an instance's description.
+        $ [dim]nextmv cloud instance update --app-id hare-app --instance-id prod \\
+            --description "Instance for production routing jobs"[/dim]
+
+    - Update an instance to use a different version.
+        $ [dim]nextmv cloud instance update --app-id hare-app --instance-id prod --version-id v2[/dim]
+
+    - Update an instance's name and description at once.
+        $ [dim]nextmv cloud instance update --app-id hare-app --instance-id prod \\
+            --name "Production Instance" --description "Instance for production routing jobs"[/dim]
+
+    - Update an instance and save the updated information to a [magenta]updated_instance.json[/magenta] file.
+        $ [dim]nextmv cloud instance update --app-id hare-app --instance-id prod \\
+            --name "Production Instance" --output updated_instance.json[/dim]
+
+    - Update an instance's execution class and priority.
+        $ [dim]nextmv cloud instance update --app-id hare-app --instance-id prod \\
+            --execution-class 6c9500mb870s --priority 1[/dim]
+
+    - Update an instance's runtime options.
+        $ [dim]nextmv cloud instance update --app-id hare-app --instance-id prod \\
+            --options max_duration=30 --options timeout=60[/dim]
+    """
+
+    # Check if any configuration options are provided
+    has_config_options = any(
+        [
+            content_format is not None,
+            execution_class is not None,
+            integration_id is not None,
+            no_queuing is not None,
+            options is not None,
+            priority is not None,
+            secret_collection_id is not None,
+        ]
+    )
+
+    if name is None and description is None and version_id is None and not has_config_options:
+        error(
+            "Provide at least one option to update: --name, --description, "
+            "--version-id, or any [magenta]Instance configuration[/magenta] option."
+        )
+
+    cloud_app = build_app(app_id=app_id, profile=profile)
+
+    # Build configuration if any configuration options were provided.
+    configuration = None
+    if has_config_options:
+        instance_options = build_options(options)
+        configuration = build_config(
+            priority=priority,
+            no_queuing=no_queuing,
+            content_format=content_format,
+            execution_class=execution_class,
+            integration_id=integration_id,
+            options=instance_options,
+            secret_collection_id=secret_collection_id,
+        )
+
+    updated_instance = cloud_app.update_instance(
+        id=instance_id,
+        name=name,
+        description=description,
+        version_id=version_id,
+        configuration=configuration,
+    )
+    success(
+        f"Instance [magenta]{instance_id}[/magenta] updated successfully in application [magenta]{app_id}[/magenta]."
+    )
+    updated_instance_dict = updated_instance.to_dict()
+
+    if output is not None and output != "":
+        with open(output, "w") as f:
+            json.dump(updated_instance_dict, f, indent=2)
+
+        success(msg=f"Updated instance information saved to [magenta]{output}[/magenta].")
+
+        return
+
+    print_json(updated_instance_dict)

nextmv/cli/cloud/managed_input/__init__.py

@@ -0,0 +1,31 @@
+"""
+This module defines the cloud managed-input command tree for the Nextmv CLI.
+"""
+
+import typer
+
+from nextmv.cli.cloud.managed_input.create import app as create_app
+from nextmv.cli.cloud.managed_input.delete import app as delete_app
+from nextmv.cli.cloud.managed_input.get import app as get_app
+from nextmv.cli.cloud.managed_input.list import app as list_app
+from nextmv.cli.cloud.managed_input.update import app as update_app
+
+# Set up subcommand application.
+app = typer.Typer()
+app.add_typer(create_app)
+app.add_typer(delete_app)
+app.add_typer(get_app)
+app.add_typer(list_app)
+app.add_typer(update_app)
+
+
+@app.callback()
+def callback() -> None:
+    """
+    Create and handle managed inputs for Nextmv Cloud applications.
+
+    A managed input is a stored input that can be referenced and used across
+    runs and experiments. Managed inputs help organize and reuse test cases
+    and datasets within your application.
+    """
+    pass

nextmv/cli/cloud/managed_input/create.py

@@ -0,0 +1,144 @@
+"""
+This module defines the cloud managed-input create command for the Nextmv CLI.
+"""
+
+from typing import Annotated
+
+import typer
+
+from nextmv.cli.configuration.config import build_app
+from nextmv.cli.message import enum_values, error, in_progress, print_json
+from nextmv.cli.options import AppIDOption, ProfileOption
+from nextmv.input import InputFormat
+from nextmv.run import Format, FormatInput
+
+# Set up subcommand application.
+app = typer.Typer()
+
+
+@app.command()
+def create(
+    app_id: AppIDOption,
+    content_format: Annotated[
+        InputFormat | None,
+        typer.Option(
+            "--content-format",
+            "-c",
+            help=f"The content format for the managed input. "
+            f"Allowed values are: {enum_values(InputFormat)}. Default is JSON.",
+            metavar="CONTENT_FORMAT",
+        ),
+    ] = None,
+    description: Annotated[
+        str | None,
+        typer.Option(
+            "--description",
+            "-d",
+            help="An optional description for the managed input.",
+            metavar="DESCRIPTION",
+        ),
+    ] = None,
+    managed_input_id: Annotated[
+        str | None,
+        typer.Option(
+            "--managed-input-id",
+            "-m",
+            help="The ID to assign to the new managed input. If not provided, a random ID will be generated.",
+            envvar="NEXTMV_MANAGED_INPUT_ID",
+            metavar="MANAGED_INPUT_ID",
+        ),
+    ] = None,
+    name: Annotated[
+        str | None,
+        typer.Option(
+            "--name",
+            "-n",
+            help="A name for the managed input. If not provided, the ID will be used as the name.",
+            metavar="NAME",
+        ),
+    ] = None,
+    run_id: Annotated[
+        str | None,
+        typer.Option(
+            "--run-id",
+            "-r",
+            help="ID of the run to use for the managed input. Either --upload-id or --run-id must be specified.",
+            envvar="NEXTMV_RUN_ID",
+            metavar="RUN_ID",
+        ),
+    ] = None,
+    upload_id: Annotated[
+        str | None,
+        typer.Option(
+            "--upload-id",
+            "-u",
+            help="ID of the upload to use for the managed input. Either --upload-id or --run-id must be specified.",
+            metavar="UPLOAD_ID",
+        ),
+    ] = None,
+    profile: ProfileOption = None,
+) -> None:
+    """
+    Create a new Nextmv Cloud application managed input.
+
+    A managed input can be created from either an upload or a run. Use the
+    --upload-id flag to create from an upload, or the --run-id flag to create
+    from a run output.
+
+    You can get an upload ID by using the [code]nextmv cloud upload
+    create[/code] command. The [magenta].upload_id[/magenta] field in the
+    command output contains the upload ID, and the
+    [magenta].upload_url[/magenta] field contains a pre-signed URL to upload
+    the data to. You may use the [code]nextmv cloud data upload[/code] command
+    to upload the data to the upload URL.
+
+    If no ID is provided, a unique ID will be automatically generated. If no
+    name is provided, the ID will be used as the name.
+
+    [bold][underline]Examples[/underline][/bold]
+
+    - Create a managed input from an upload.
+        $ [dim]nextmv cloud managed-input create --app-id hare-app --name "Test Input 1" \
+            --upload-id upl_123456789[/dim]
+
+    - Create a managed input from a run.
+        $ [dim]nextmv cloud managed-input create --app-id hare-app --name "Baseline Run" \
+            --run-id run_123456789[/dim]
+
+    - Create a managed input with a specific ID and description.
+        $ [dim]nextmv cloud managed-input create --app-id hare-app --name "Test Input" \\
+            --managed-input-id inp_custom --description "Test case for validation" --upload-id upl_123456789[/dim]
+
+    - Create a managed input with custom format.
+        $ [dim]nextmv cloud managed-input create --app-id hare-app --name "CSV Input" \\
+            --upload-id upl_123456789 --content-format csv[/dim]
+    """
+
+    if upload_id is None and run_id is None:
+        error(
+            "Either --upload-id or --run-id must be specified. "
+            "Use nextmv cloud upload create to create an upload first, "
+            "or specify an existing run ID."
+        )
+
+    cloud_app = build_app(app_id=app_id, profile=profile)
+
+    # Build format if content_format is provided
+    format_obj = None
+    if content_format is not None:
+        format_obj = Format(
+            format_input=FormatInput(
+                input_type=InputFormat(content_format),
+            ),
+        )
+
+    in_progress(msg="Creating managed input...")
+    managed_input = cloud_app.new_managed_input(
+        id=managed_input_id,
+        name=name,
+        description=description,
+        upload_id=upload_id,
+        run_id=run_id,
+        format=format_obj,
+    )
+    print_json(managed_input.to_dict())

nextmv/cli/cloud/managed_input/delete.py

@@ -0,0 +1,64 @@
+"""
+This module defines the cloud managed-input delete command for the Nextmv CLI.
+"""
+
+from typing import Annotated
+
+import typer
+
+from nextmv.cli.configuration.config import build_app
+from nextmv.cli.confirm import get_confirmation
+from nextmv.cli.message import info, success
+from nextmv.cli.options import AppIDOption, ManagedInputIDOption, ProfileOption
+
+# Set up subcommand application.
+app = typer.Typer()
+
+
+@app.command()
+def delete(
+    app_id: AppIDOption,
+    managed_input_id: ManagedInputIDOption,
+    yes: Annotated[
+        bool,
+        typer.Option(
+            "--yes",
+            "-y",
+            help="Agree to deletion confirmation prompt. Useful for non-interactive sessions.",
+        ),
+    ] = False,
+    profile: ProfileOption = None,
+) -> None:
+    """
+    Deletes a Nextmv Cloud application managed input.
+
+    This action is permanent and cannot be undone. Use the --yes
+    flag to skip the confirmation prompt.
+
+    [bold][underline]Examples[/underline][/bold]
+
+    - Delete the managed input with the ID [magenta]inp_123456789[/magenta] from application
+      [magenta]hare-app[/magenta].
+        $ [dim]nextmv cloud managed-input delete --app-id hare-app \
+            --managed-input-id inp_123456789[/dim]
+
+    - Delete the managed input without confirmation prompt.
+        $ [dim]nextmv cloud managed-input delete --app-id hare-app --managed-input-id inp_123456789 --yes[/dim]
+    """
+
+    if not yes:
+        confirm = get_confirmation(
+            f"Are you sure you want to delete managed input [magenta]{managed_input_id}[/magenta] "
+            f"from application [magenta]{app_id}[/magenta]? This action cannot be undone.",
+        )
+
+        if not confirm:
+            info(f"Managed input [magenta]{managed_input_id}[/magenta] will not be deleted.")
+            return
+
+    cloud_app = build_app(app_id=app_id, profile=profile)
+    cloud_app.delete_managed_input(managed_input_id=managed_input_id)
+    success(
+        f"Managed input [magenta]{managed_input_id}[/magenta] deleted successfully "
+        f"from application [magenta]{app_id}[/magenta]."
+    )

nextmv/cli/cloud/managed_input/get.py

@@ -0,0 +1,63 @@
+"""
+This module defines the cloud managed-input get command for the Nextmv CLI.
+"""
+
+import json
+from typing import Annotated
+
+import typer
+
+from nextmv.cli.configuration.config import build_app
+from nextmv.cli.message import in_progress, print_json, success
+from nextmv.cli.options import AppIDOption, ManagedInputIDOption, ProfileOption
+
+# Set up subcommand application.
+app = typer.Typer()
+
+
+@app.command()
+def get(
+    app_id: AppIDOption,
+    managed_input_id: ManagedInputIDOption,
+    output: Annotated[
+        str | None,
+        typer.Option(
+            "--output",
+            "-o",
+            help="Saves the managed input information to this location.",
+            metavar="OUTPUT_PATH",
+        ),
+    ] = None,
+    profile: ProfileOption = None,
+) -> None:
+    """
+    Get a Nextmv Cloud application managed input.
+
+    This command is useful to get the attributes of an existing Nextmv Cloud
+    application managed input by its ID.
+
+    [bold][underline]Examples[/underline][/bold]
+
+    - Get the managed input with the ID [magenta]inp_123456789[/magenta] from application [magenta]hare-app[/magenta].
+        $ [dim]nextmv cloud managed-input get --app-id hare-app --managed-input-id inp_123456789[/dim]
+
+    - Get the managed input with the ID [magenta]inp_123456789[/magenta] and save the information to a
+      [magenta]managed_input.json[/magenta] file.
+        $ [dim]nextmv cloud managed-input get --app-id hare-app --managed-input-id inp_123456789 \
+            --output managed_input.json[/dim]
+    """
+
+    cloud_app = build_app(app_id=app_id, profile=profile)
+    in_progress(msg="Getting managed input...")
+    managed_input = cloud_app.managed_input(managed_input_id=managed_input_id)
+    managed_input_dict = managed_input.to_dict()
+
+    if output is not None and output != "":
+        with open(output, "w") as f:
+            json.dump(managed_input_dict, f, indent=2)
+
+        success(msg=f"Managed input information saved to [magenta]{output}[/magenta].")
+
+        return
+
+    print_json(managed_input_dict)

nextmv/cli/cloud/managed_input/list.py

@@ -0,0 +1,60 @@
+"""
+This module defines the cloud managed-input list command for the Nextmv CLI.
+"""
+
+import json
+from typing import Annotated
+
+import typer
+
+from nextmv.cli.configuration.config import build_app
+from nextmv.cli.message import in_progress, print_json, success
+from nextmv.cli.options import AppIDOption, ProfileOption
+
+# Set up subcommand application.
+app = typer.Typer()
+
+
+@app.command()
+def list(
+    app_id: AppIDOption,
+    output: Annotated[
+        str | None,
+        typer.Option(
+            "--output",
+            "-o",
+            help="Saves the managed input list information to this location.",
+            metavar="OUTPUT_PATH",
+        ),
+    ] = None,
+    profile: ProfileOption = None,
+) -> None:
+    """
+    List all managed inputs of a Nextmv Cloud application.
+
+    [bold][underline]Examples[/underline][/bold]
+
+    - List all managed inputs of application [magenta]hare-app[/magenta].
+        $ [dim]nextmv cloud managed-input list --app-id hare-app[/dim]
+
+    - List all managed inputs using the profile named [magenta]hare[/magenta].
+        $ [dim]nextmv cloud managed-input list --app-id hare-app --profile hare[/dim]
+
+    - List all managed inputs and save the information to a [magenta]managed_inputs.json[/magenta] file.
+        $ [dim]nextmv cloud managed-input list --app-id hare-app --output managed_inputs.json[/dim]
+    """
+
+    cloud_app = build_app(app_id=app_id, profile=profile)
+    in_progress(msg="Listing managed inputs...")
+    managed_inputs = cloud_app.list_managed_inputs()
+    managed_inputs_dicts = [managed_input.to_dict() for managed_input in managed_inputs]
+
+    if output is not None and output != "":
+        with open(output, "w") as f:
+            json.dump(managed_inputs_dicts, f, indent=2)
+
+        success(msg=f"Managed input list information saved to [magenta]{output}[/magenta].")
+
+        return
+
+    print_json(managed_inputs_dicts)

nextmv/cli/cloud/managed_input/update.py

@@ -0,0 +1,97 @@
+"""
+This module defines the cloud managed-input update command for the Nextmv CLI.
+"""
+
+import json
+from typing import Annotated
+
+import typer
+
+from nextmv.cli.configuration.config import build_app
+from nextmv.cli.message import error, print_json, success
+from nextmv.cli.options import AppIDOption, ManagedInputIDOption, ProfileOption
+
+# Set up subcommand application.
+app = typer.Typer()
+
+
+@app.command()
+def update(
+    app_id: AppIDOption,
+    managed_input_id: ManagedInputIDOption,
+    description: Annotated[
+        str | None,
+        typer.Option(
+            "--description",
+            "-d",
+            help="A new description for the managed input.",
+            metavar="DESCRIPTION",
+        ),
+    ] = None,
+    name: Annotated[
+        str | None,
+        typer.Option(
+            "--name",
+            "-n",
+            help="A new name for the managed input.",
+            metavar="NAME",
+        ),
+    ] = None,
+    output: Annotated[
+        str | None,
+        typer.Option(
+            "--output",
+            "-o",
+            help="Saves the updated managed input information to this location.",
+            metavar="OUTPUT_PATH",
+        ),
+    ] = None,
+    profile: ProfileOption = None,
+) -> None:
+    """
+    Updates a Nextmv Cloud application managed input.
+
+    [bold][underline]Examples[/underline][/bold]
+
+    - Update a managed input's name.
+        $ [dim]nextmv cloud managed-input update --app-id hare-app \
+            --managed-input-id inp_123456789 --name "Updated Test Input"[/dim]
+
+    - Update a managed input's description.
+        $ [dim]nextmv cloud managed-input update --app-id hare-app --managed-input-id inp_123456789 \\
+            --description "Updated test case for validation"[/dim]
+
+    - Update a managed input's name and description at once.
+        $ [dim]nextmv cloud managed-input update --app-id hare-app --managed-input-id inp_123456789 \\
+            --name "Updated Test Input" --description "Updated test case for validation"[/dim]
+
+    - Update a managed input and save the updated information to a [magenta]updated_managed_input.json[/magenta] file.
+        $ [dim]nextmv cloud managed-input update --app-id hare-app --managed-input-id inp_123456789 \\
+            --name "Updated Test Input" --output updated_managed_input.json[/dim]
+    """
+
+    if name is None and description is None:
+        error("Provide at least one option to update: --name or --description.")
+
+    cloud_app = build_app(app_id=app_id, profile=profile)
+
+    updated_managed_input = cloud_app.update_managed_input(
+        managed_input_id=managed_input_id,
+        name=name,
+        description=description,
+    )
+    success(
+        f"Managed input [magenta]{managed_input_id}[/magenta] updated successfully "
+        f"in application [magenta]{app_id}[/magenta]."
+    )
+    updated_managed_input_dict = updated_managed_input.to_dict()
+
+    if output is not None and output != "":
+        with open(output, "w") as f:
+            json.dump(updated_managed_input_dict, f, indent=2)
+
+        success(msg=f"Updated managed input information saved to [magenta]{output}[/magenta].")
+
+        return
+
+    print_json(updated_managed_input_dict)