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

nextmv/cli/cloud/ensemble/update.py

@@ -0,0 +1,103 @@
+"""
+This module defines the cloud ensemble 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, EnsembleDefinitionIDOption, ProfileOption
+
+# Set up subcommand application.
+app = typer.Typer()
+
+
+@app.command()
+def update(
+    app_id: AppIDOption,
+    ensemble_definition_id: EnsembleDefinitionIDOption,
+    description: Annotated[
+        str | None,
+        typer.Option(
+            "--description",
+            "-d",
+            help="A new description for the ensemble definition.",
+            metavar="DESCRIPTION",
+        ),
+    ] = None,
+    name: Annotated[
+        str | None,
+        typer.Option(
+            "--name",
+            "-n",
+            help="A new name for the ensemble definition.",
+            metavar="NAME",
+        ),
+    ] = None,
+    output: Annotated[
+        str | None,
+        typer.Option(
+            "--output",
+            "-o",
+            help="Saves the updated ensemble definition information to this location.",
+            metavar="OUTPUT_PATH",
+        ),
+    ] = None,
+    profile: ProfileOption = None,
+) -> None:
+    """
+    Update a Nextmv Cloud ensemble definition.
+
+    You can update the name and/or description of an existing ensemble
+    definition. To modify run groups or evaluation rules, you need to delete
+    and recreate the ensemble definition.
+
+    [bold][underline]Examples[/underline][/bold]
+
+    - Update the name of an ensemble definition.
+        $ [dim]nextmv cloud ensemble update --app-id hare-app \\
+            --ensemble-definition-id prod-ensemble --name "Updated Production Ensemble"[/dim]
+
+    - Update the description of an ensemble definition.
+        $ [dim]nextmv cloud ensemble update --app-id hare-app \\
+            --ensemble-definition-id prod-ensemble \\
+            --description "Updated ensemble for production workloads"[/dim]
+
+    - Update both name and description.
+        $ [dim]nextmv cloud ensemble update --app-id hare-app \\
+            --ensemble-definition-id prod-ensemble --name "Production Ensemble v2" \\
+            --description "Enhanced ensemble configuration for production"[/dim]
+
+    - Update and save the result to a file.
+        $ [dim]nextmv cloud ensemble update --app-id hare-app \\
+            --ensemble-definition-id prod-ensemble --name "New Name" \\
+            --description "New Description" --output updated.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)
+
+    ensemble_definition = cloud_app.update_ensemble_definition(
+        id=ensemble_definition_id,
+        name=name,
+        description=description,
+    )
+    success(
+        f"Ensemble definition [magenta]{ensemble_definition_id}[/magenta] updated successfully "
+        f"in application [magenta]{app_id}[/magenta]."
+    )
+
+    if output is not None and output != "":
+        with open(output, "w") as f:
+            json.dump(ensemble_definition.to_dict(), f, indent=2)
+
+        success(msg=f"Updated ensemble definition information saved to [magenta]{output}[/magenta].")
+
+        return
+
+    print_json(ensemble_definition.to_dict())

nextmv/cli/cloud/input_set/__init__.py

@@ -0,0 +1,32 @@
+"""
+This module defines the cloud input-set command tree for the Nextmv CLI.
+"""
+
+import typer
+
+from nextmv.cli.cloud.input_set.create import app as create_app
+from nextmv.cli.cloud.input_set.delete import app as delete_app
+from nextmv.cli.cloud.input_set.get import app as get_app
+from nextmv.cli.cloud.input_set.list import app as list_app
+from nextmv.cli.cloud.input_set.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 manage Nextmv Cloud input sets.
+
+    An input set is a collection of inputs from associated runs that can be
+    reused across multiple experiments. Input sets allow you to test different
+    configurations of your decision model using the same set of inputs for
+    consistent comparison.
+    """
+    pass

nextmv/cli/cloud/input_set/create.py

@@ -0,0 +1,168 @@
+"""
+This module defines the cloud input-set create command for the Nextmv CLI.
+"""
+
+import json
+from datetime import datetime
+from typing import Annotated
+
+import typer
+
+from nextmv.cli.configuration.config import build_app
+from nextmv.cli.message import error, in_progress, print_json
+from nextmv.cli.options import AppIDOption, ProfileOption
+from nextmv.cloud.input_set import ManagedInput
+from nextmv.safe import safe_id
+
+# Set up subcommand application.
+app = typer.Typer()
+
+
+@app.command()
+def create(
+    app_id: AppIDOption,
+    name: Annotated[
+        str,
+        typer.Option(
+            "--name",
+            "-n",
+            help="A name for the input set.",
+            metavar="NAME",
+        ),
+    ],
+    input_set_id: Annotated[
+        str | None,
+        typer.Option(
+            "--input-set-id",
+            "-s",
+            help="An optional ID for the input set. If not provided, a random ID will be generated.",
+            envvar="NEXTMV_INPUT_SET_ID",
+            metavar="INPUT_SET_ID",
+        ),
+    ] = None,
+    instance_id: Annotated[
+        str | None,
+        typer.Option(
+            "--instance-id",
+            "-i",
+            help="Instance ID to filter runs from.",
+            metavar="INSTANCE_ID",
+        ),
+    ] = None,
+    description: Annotated[
+        str | None,
+        typer.Option(
+            "--description",
+            "-d",
+            help="An optional description for the input set.",
+            metavar="DESCRIPTION",
+        ),
+    ] = None,
+    run_ids: Annotated[
+        list[str] | None,
+        typer.Option(
+            "--run-ids",
+            "-r",
+            help="List of run IDs to include in the input set (max 20). Pass multiple run IDs by repeating the flag.",
+            metavar="RUN_IDS",
+        ),
+    ] = None,
+    start_time: Annotated[
+        datetime | None,
+        typer.Option(
+            "--start-time",
+            formats=["%Y-%m-%dT%H:%M:%S%z"],
+            help="Start time for filtering runs in [magenta]RFC 3339[/magenta] format. "
+            "Object format: [dim]'2024-01-01T00:00:00Z'[/dim]",
+            metavar="START_TIME",
+        ),
+    ] = None,
+    end_time: Annotated[
+        datetime | None,
+        typer.Option(
+            "--end-time",
+            formats=["%Y-%m-%dT%H:%M:%S%z"],
+            help="End time for filtering runs in [magenta]RFC 3339[/magenta] format. "
+            "Object format: [dim]'2024-01-01T00:00:00Z'[/dim]",
+            metavar="END_TIME",
+        ),
+    ] = None,
+    maximum_runs: Annotated[
+        int | None,
+        typer.Option(
+            "--maximum-runs",
+            "-m",
+            help="Maximum number of runs to include (max [magenta]20[/magenta]).",
+            metavar="MAXIMUM_RUNS",
+        ),
+    ] = 20,
+    managed_inputs: Annotated[
+        str | None,
+        typer.Option(
+            "--managed-inputs",
+            help="Managed inputs for the input set. Data should be valid [magenta]json[/magenta]. Object "
+            "format: [dim][{'id': 'id', 'name': 'name', 'description': 'description'}][/dim].",
+            metavar="MANAGED_INPUTS",
+        ),
+    ] = None,
+    profile: ProfileOption = None,
+) -> None:
+    """
+    Create a new Nextmv Cloud input set for experiments.
+
+    An input set is a collection of inputs that can be reused across multiple
+    experiments.
+
+    1. --run-ids: Create from a list of existing run IDs.
+    2. --managed-inputs: Create from existing managed inputs in the application.
+    3. --instance-id with --start-time and --end-time:
+       Create from instance runs matching the time range criteria.
+
+    [bold][underline]Examples[/underline][/bold]
+
+    - Create an input set for application [magenta]hare-app[/magenta] from runs.
+      A random input set ID will be generated if one is not provided.
+        $ [dim]nextmv cloud input-set create --app-id hare-app \\
+            --name "Hare Input Set" --run-ids run-1 --run-ids run-2 --run-ids run-3"[/dim]
+
+    - Create an input set with a specific ID.
+        $ [dim]nextmv cloud input-set create --app-id hare-app --input-set-id hare-input-set \\
+            --name "Hare Input Set" --run-ids run-1 --run-ids run-2 --run-ids run-3"[/dim]
+
+    - Create an input set using existing managed inputs.
+        $ [dim]nextmv cloud input-set create --app-id hare-app --name "Hare Input Set" \\
+            --managed-inputs '[{"id": "hare-input-1", "name": "hare input", "description": "hare description"}]'[/dim]
+
+    - Create an input set from runs using a specific instance and time range.
+        $ [dim]nextmv cloud input-set create --app-id hare-app --name "Hare Input Set" \\
+            --instance-id hare-instance --start-time "2024-01-01T00:00:00Z" \\
+            --end-time "2024-01-31T23:59:59Z"[/dim]
+    """
+
+    cloud_app = build_app(app_id=app_id, profile=profile)
+    in_progress(msg="Creating input set...")
+
+    # Generate a random input set ID if one is not provided.
+    if input_set_id is None:
+        input_set_id = safe_id("input-set")
+
+    managed_inputs = []
+    if managed_inputs is not None:
+        for d in json.loads(managed_inputs):
+            i = ManagedInput.from_dict(d)
+            if i is None:
+                error(f"[magenta]{d}[/magenta] is not a valid [yellow]ManagedInput[/yellow]")
+            managed_inputs.append(i)
+
+    input_set = cloud_app.new_input_set(
+        input_set_id,
+        name,
+        description=description,
+        instance_id=instance_id,
+        run_ids=run_ids,
+        start_time=start_time,
+        end_time=end_time,
+        maximum_runs=maximum_runs,
+        inputs=managed_inputs,
+    )
+    print_json(input_set.to_dict())

nextmv/cli/cloud/input_set/delete.py

@@ -0,0 +1,64 @@
+"""
+This module defines the cloud input-set 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, InputSetIDOption, ProfileOption
+
+# Set up subcommand application.
+app = typer.Typer()
+
+
+@app.command()
+def delete(
+    app_id: AppIDOption,
+    input_set_id: InputSetIDOption,
+    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 input set.
+
+    This action is permanent and cannot be undone. The input set and all
+    associated data will be deleted. Use the --yes flag to skip the
+    confirmation prompt.
+
+    [bold][underline]Examples[/underline][/bold]
+
+    - Delete the input set with the ID [magenta]hop-analysis[/magenta] from application
+      [magenta]hare-app[/magenta].
+        $ [dim]nextmv cloud input-set delete --app-id hare-app --input-set-id hop-analysis[/dim]
+
+    - Delete the input set without confirmation prompt.
+        $ [dim]nextmv cloud input-set delete --app-id hare-app --input-set-id carrot-routes --yes[/dim]
+    """
+
+    if not yes:
+        confirm = get_confirmation(
+            f"Are you sure you want to delete input set [magenta]{input_set_id}[/magenta] "
+            f"from application [magenta]{app_id}[/magenta]? This action cannot be undone.",
+        )
+
+        if not confirm:
+            info(f"Input set [magenta]{input_set_id}[/magenta] will not be deleted.")
+            return
+
+    cloud_app = build_app(app_id=app_id, profile=profile)
+    cloud_app.delete_input_set(input_set_id=input_set_id)
+    success(
+        f"Input set [magenta]{input_set_id}[/magenta] deleted successfully "
+        f"from application [magenta]{app_id}[/magenta]."
+    )

nextmv/cli/cloud/input_set/get.py

@@ -0,0 +1,63 @@
+"""
+This module defines the cloud input-set 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, InputSetIDOption, ProfileOption
+
+# Set up subcommand application.
+app = typer.Typer()
+
+
+@app.command()
+def get(
+    app_id: AppIDOption,
+    input_set_id: InputSetIDOption,
+    output: Annotated[
+        str | None,
+        typer.Option(
+            "--output",
+            "-o",
+            help="Saves the input set information to this location.",
+            metavar="OUTPUT_PATH",
+        ),
+    ] = None,
+    profile: ProfileOption = None,
+) -> None:
+    """
+    Get an Nextmv Cloud input set.
+
+    This command retrieves the details of an existing input set, including
+    its name, description, and the list of inputs it contains.
+
+    [bold][underline]Examples[/underline][/bold]
+
+    - Get an input set with the ID [magenta]hare-input-set[/magenta].
+        $ [dim]nextmv cloud input-set get --app-id hare-app --input-set-id hare-input-set[/dim]
+
+    - Get an input set with the ID [magenta]hare-input-set[/magenta] and save
+      the information to a [magenta]input-set.json[/magenta] file.
+        $ [dim]nextmv cloud input-set get --app-id hare-app --input-set-id hare-input-set \\
+            --output input-set.json[/dim]
+    """
+
+    cloud_app = build_app(app_id=app_id, profile=profile)
+    in_progress(msg="Getting input set...")
+    input_set = cloud_app.input_set(input_set_id=input_set_id)
+    input_set_dict = input_set.to_dict()
+
+    if output is not None and output != "":
+        with open(output, "w") as f:
+            json.dump(input_set_dict, f, indent=2)
+
+        success(msg=f"Input set information saved to [magenta]{output}[/magenta].")
+
+        return
+
+    print_json(input_set_dict)

nextmv/cli/cloud/input_set/list.py

@@ -0,0 +1,63 @@
+"""
+This module defines the cloud input-set 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 input set list to this location.",
+            metavar="OUTPUT_PATH",
+        ),
+    ] = None,
+    profile: ProfileOption = None,
+) -> None:
+    """
+    List all input sets of a Nextmv Cloud application.
+
+    This command retrieves all input sets that exist for a given Nextmv Cloud
+    application.
+
+    [bold][underline]Examples[/underline][/bold]
+
+    - List all input sets of application [magenta]hare-app[/magenta].
+        $ [dim]nextmv cloud input-set list --app-id hare-app[/dim]
+
+    - List all input sets using the profile named [magenta]hare[/magenta].
+        $ [dim]nextmv cloud input-set list --app-id hare-app --profile hare[/dim]
+
+    - List all input sets and save the information to a [magenta]input-sets.json[/magenta] file.
+        $ [dim]nextmv cloud input-set list --app-id hare-app --output input-sets.json[/dim]
+    """
+
+    cloud_app = build_app(app_id=app_id, profile=profile)
+    in_progress(msg="Listing input sets...")
+    input_sets = cloud_app.list_input_sets()
+    input_sets_dicts = [input_set.to_dict() for input_set in input_sets]
+
+    if output is not None and output != "":
+        with open(output, "w") as f:
+            json.dump(input_sets_dicts, f, indent=2)
+
+        success(msg=f"Input set list information saved to [magenta]{output}[/magenta].")
+
+        return
+
+    print_json(input_sets_dicts)

nextmv/cli/cloud/input_set/update.py

@@ -0,0 +1,123 @@
+"""
+This module defines the cloud input-set 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, in_progress, print_json, success
+from nextmv.cli.options import AppIDOption, InputSetIDOption, ProfileOption
+from nextmv.cloud.input_set import ManagedInput
+
+# Set up subcommand application.
+app = typer.Typer()
+
+
+@app.command()
+def update(
+    app_id: AppIDOption,
+    input_set_id: InputSetIDOption,
+    name: Annotated[
+        str | None,
+        typer.Option(
+            "--name",
+            "-n",
+            help="A new name for the input set.",
+            metavar="NAME",
+        ),
+    ] = None,
+    description: Annotated[
+        str | None,
+        typer.Option(
+            "--description",
+            "-d",
+            help="A new description for the input set.",
+            metavar="DESCRIPTION",
+        ),
+    ] = None,
+    managed_inputs: Annotated[
+        str | None,
+        typer.Option(
+            "--managed-inputs",
+            help="Managed inputs for the input set. Data should be valid [magenta]json[/magenta]. Object "
+            "format: [dim][{'id': 'id', 'name': 'name', 'description': 'description'}][/dim].",
+            metavar="MANAGED_INPUTS",
+        ),
+    ] = None,
+    output: Annotated[
+        str | None,
+        typer.Option(
+            "--output",
+            "-o",
+            help="Saves the updated input set information to this location.",
+            metavar="OUTPUT_PATH",
+        ),
+    ] = None,
+    profile: ProfileOption = None,
+) -> None:
+    """
+    Updates a Nextmv Cloud input set.
+
+    This command updates the metadata of an existing input set. You can update
+    the name, description, or managed inputs of the input set.
+
+    [bold][underline]Examples[/underline][/bold]
+
+    - Update an input set's name.
+        $ [dim]nextmv cloud input-set update --app-id hare-app \\
+            --input-set-id hare-input-set --name "New Name"[/dim]
+
+    - Update an input set's description.
+        $ [dim]nextmv cloud input-set update --app-id hare-app \\
+            --input-set-id hare-input-set --description "Updated description"[/dim]
+
+    - Update an input set's managed inputs.
+        $ [dim]nextmv cloud input-set update --app-id hare-app --input-set-id hare-input-set \\
+            --managed-inputs '[{"id": "hare-input-1", "name": "hare input", "description": "hare description"}]'[/dim]
+
+    - Update both name and description.
+        $ [dim]nextmv cloud input-set update --app-id hare-app --input-set-id hare-input-set \\
+            --name "New Name" --description "Updated description"[/dim]
+
+    - Update and save to a file.
+        $ [dim]nextmv cloud input-set update --app-id hare-app --input-set-id hare-input-set \\
+            --name "New Name" --output updated_input_set.json[/dim]
+    """
+
+    if name is None and description is None and managed_inputs is None:
+        error("Provide at least one option: --name, --description, or --managed-inputs.")
+
+    cloud_app = build_app(app_id=app_id, profile=profile)
+    in_progress(msg="Updating input set...")
+
+    managed_input_list = []
+    if managed_inputs is not None:
+        for d in json.loads(managed_inputs):
+            i = ManagedInput.from_dict(d)
+            if i is None:
+                error(f"[magenta]{d}[/magenta] is not a valid [yellow]ManagedInput[/yellow]")
+            managed_input_list.append(i)
+
+    updated_input_set = cloud_app.update_input_set(
+        id=input_set_id,
+        name=name,
+        description=description,
+        inputs=managed_input_list,
+    )
+    success(
+        f"Input set [magenta]{input_set_id}[/magenta] updated successfully in application [magenta]{app_id}[/magenta]."
+    )
+    updated_input_set_dict = updated_input_set.to_dict()
+
+    if output is not None and output != "":
+        with open(output, "w") as f:
+            json.dump(updated_input_set_dict, f, indent=2)
+
+        success(msg=f"Updated input set information saved to [magenta]{output}[/magenta].")
+
+        return
+
+    print_json(updated_input_set_dict)

nextmv/cli/cloud/instance/__init__.py

@@ -0,0 +1,35 @@
+"""
+This module defines the cloud instance command tree for the Nextmv CLI.
+"""
+
+import typer
+
+from nextmv.cli.cloud.instance.create import app as create_app
+from nextmv.cli.cloud.instance.delete import app as delete_app
+from nextmv.cli.cloud.instance.exists import app as exists_app
+from nextmv.cli.cloud.instance.get import app as get_app
+from nextmv.cli.cloud.instance.list import app as list_app
+from nextmv.cli.cloud.instance.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(exists_app)
+app.add_typer(get_app)
+app.add_typer(list_app)
+app.add_typer(update_app)
+
+
+@app.callback()
+def callback() -> None:
+    """
+    Create and manage Nextmv Cloud application instances.
+
+    An application instance is a representation of a version and optional
+    configuration (options/parameters). Instances are the mechanism by which a
+    run is made. When you make a new run, the app determines which instance to
+    use and then uses the executable code associated to the version for the
+    run.
+    """
+    pass