nextmv 1.0.0.dev9__tar.gz → 1.0.0.dev10__tar.gz

{nextmv-1.0.0.dev9 → nextmv-1.0.0.dev10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nextmv
-Version: 1.0.0.dev9
+Version: 1.0.0.dev10
 Summary: The all-purpose Python SDK for Nextmv
 Project-URL: Homepage, https://www.nextmv.io
 Project-URL: Documentation, https://nextmv-py.docs.nextmv.io/en/latest/nextmv/
@@ -230,10 +230,12 @@ Provides-Extra: dev
 Requires-Dist: build>=1.0.3; extra == 'dev'
 Requires-Dist: folium>=0.20.0; extra == 'dev'
 Requires-Dist: mlflow>=3.9.0; extra == 'dev'
+Requires-Dist: nextpipe>=0.6.0; extra == 'dev'
 Requires-Dist: openpyxl>=3.1.5; extra == 'dev'
 Requires-Dist: pandas>=2.2.3; extra == 'dev'
 Requires-Dist: plotly>=6.0.1; extra == 'dev'
 Requires-Dist: pydantic>=2.5.2; extra == 'dev'
+Requires-Dist: pytest>=9.0.2; extra == 'dev'
 Requires-Dist: pyyaml>=6.0.1; extra == 'dev'
 Requires-Dist: requests>=2.31.0; extra == 'dev'
 Requires-Dist: ruff>=0.1.7; extra == 'dev'

nextmv-1.0.0.dev10/nextmv/__about__.py

@@ -0,0 +1 @@
+__version__ = "v1.0.0.dev10"

{nextmv-1.0.0.dev9 → nextmv-1.0.0.dev10}/nextmv/cli/CONTRIBUTING.md

@@ -152,14 +152,16 @@ guidelines:
 - We embrace the use of emojis. They make the CLI friendlier and more
   approachable.
 - The `message.py` file contains helper functions for printing messages, like:
-  - `error`: prints an error and raises an exception.
-  - `success`: prints a success message.
-  - `warning`: prints a warning message.
-  - `in_progress`: prints an in-progress message.
-  - `info`: prints an informational message. You can give it an emoji for the
-    message. The other commands have fixed emojis.
+  - `message`: prints a message. You can give it an emoji for the message. The
+    other commands have fixed emojis.
+  - `info`: prints an informational message. Use for neutral messages.
+  - `in_progress`: prints an in-progress message. Use before executing an action.
+  - `success`: prints a success message. Use after successfully completing an action.
+  - `warning`: prints a warning message. Use for non-critical issues.
+  - `error`: prints an error and raises an exception. Use for critical issues
+    and to return early from commands.
 - For printing `JSON` information, use the `print_json` function in the
-  `messages.py` file to print JSON output. This ensures consistent formatting
+  `message.py` file to print JSON output. This ensures consistent formatting
   across the CLI.
 - Emojis should be formatted according to [Rich's emoji guide][rich-emoji].
   They are strings enclosed in colons, e.g. `:rocket:`, `:boom:`,
@@ -171,6 +173,24 @@ guidelines:
   success(f"Application [magenta]{app_id}[/magenta] deleted successfully.")
   ```
 
+- When showing the values of an `Enum`, use the `enum_values` function in the
+  `message.py` file which will give a nicely colored, comma-separated list of
+  the enum values. Consider the following example, where we get the allowed
+  values for the `InputFormat` class.
+
+  ```python
+      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,
+  ```
+
 ## Confirmation prompts
 
 For destructive actions (like deletions), use the `get_confirmation()` method
@@ -185,7 +205,7 @@ When using confirmation prompts, follow these guidelines:
   affected.
 - Provide a `--yes` / `-y` flag to skip the confirmation prompt where possible,
   useful for non-interactive sessions.
-- If the user declines, call `info()` with the `:bulb:` emoji and return early.
+- If the user declines, call `info()` and return early.
 
 Consider the `nextmv cloud app delete` command:
 
@@ -196,7 +216,7 @@ if not yes:
     )
 
     if not confirm:
-        info(msg=f"Application [magenta]{app_id}[/magenta] will not be deleted.", emoji=":bulb:")
+        info(f"Application [magenta]{app_id}[/magenta] will not be deleted.")
         return
 ```
 
@@ -377,7 +397,7 @@ to use it.
       """
 
       client = build_client(profile)
-      info(msg="Getting application...", emoji=":hourglass_flowing_sand:")
+      in_progress("Getting application...")
 
       cloud_app = Application.get(
           client=client,
@@ -389,7 +409,7 @@ to use it.
           with open(output, "w") as f:
               json.dump(cloud_app_dict, f, indent=2)
 
-          success(msg=f"Application information saved to [magenta]{output}[/magenta].")
+          success(f"Application information saved to [magenta]{output}[/magenta].")
 
           return
 

{nextmv-1.0.0.dev9 → nextmv-1.0.0.dev10}/nextmv/cli/cloud/acceptance/delete.py

@@ -53,10 +53,7 @@ def delete(
         )
 
         if not confirm:
-            info(
-                msg=f"Acceptance test [magenta]{acceptance_test_id}[/magenta] will not be deleted.",
-                emoji=":bulb:",
-            )
+            info(f"Acceptance test [magenta]{acceptance_test_id}[/magenta] will not be deleted.")
             return
 
     cloud_app = build_app(app_id=app_id, profile=profile)

{nextmv-1.0.0.dev9 → nextmv-1.0.0.dev10}/nextmv/cli/cloud/account/delete.py

@@ -51,7 +51,7 @@ def delete(
         )
 
         if not confirm:
-            info(msg=f"Account [magenta]{account_id}[/magenta] will not be deleted.", emoji=":bulb:")
+            info(f"Account [magenta]{account_id}[/magenta] will not be deleted.")
             return
 
     cloud_account = build_account(account_id=account_id, profile=profile)

{nextmv-1.0.0.dev9 → nextmv-1.0.0.dev10}/nextmv/cli/cloud/app/delete.py

@@ -49,7 +49,7 @@ def delete(
         )
 
         if not confirm:
-            info(msg=f"Application [magenta]{app_id}[/magenta] will not be deleted.", emoji=":bulb:")
+            info(f"Application [magenta]{app_id}[/magenta] will not be deleted.")
             return
 
     cloud_app = build_app(app_id=app_id, profile=profile)

{nextmv-1.0.0.dev9 → nextmv-1.0.0.dev10}/nextmv/cli/cloud/app/push.py

@@ -129,26 +129,34 @@ def push(
         $ [dim]nextmv cloud app push --app-id hare-app --version-yes --update-instance-id inst-1[/dim]
     """
 
+    cloud_app = build_app(app_id=app_id, profile=profile)
+
+    # If a version already exists, we cannot create it.
+    if version_id is not None and version_id != "":
+        exists = cloud_app.version_exists(version_id=version_id)
+        if exists:
+            error(
+                f"Version [magenta]{version_id}[/magenta] already exists for application [magenta]{app_id}[/magenta]."
+            )
+
     # We cannot create and update an instance at the same time.
     update_defined = update_instance_id is not None and update_instance_id != ""
     create_defined = create_instance_id is not None and create_instance_id != ""
     if update_defined and create_defined:
         error("Cannot use --update-instance-id and --create-instance-id at the same time.")
 
-    cloud_app = build_app(app_id=app_id, profile=profile)
-
     # We cannot update an instance that does not exist.
     if update_defined and not cloud_app.instance_exists(instance_id=update_instance_id):
         error(
-            f"Used option --update-instance-id but the instance {update_instance_id} does not exist. "
-            "Use --create-instance-id instead."
+            f"Used option --update-instance-id but the instance [magenta]{update_instance_id}[/magenta] "
+            "does not exist. Use --create-instance-id instead."
         )
 
     # We cannot create an instance that already exists.
     if create_defined and cloud_app.instance_exists(instance_id=create_instance_id):
         error(
-            f"Used option --create-instance-id but the instance {create_instance_id} already exists. "
-            "Use --update-instance-id instead."
+            f"Used option --create-instance-id but the instance [magenta]{create_instance_id}[/magenta] "
+            "already exists. Use --update-instance-id instead."
         )
 
     # Do the normal push first.
@@ -174,7 +182,7 @@ def push(
     # If the override for updating an instance was used, we update the instance
     # and we are done.
     if update_defined:
-        info("Used option --update-instance-id to link version to existing instance.", emoji=":bulb:")
+        info("Used option --update-instance-id to link version to existing instance.")
         _update_instance(
             cloud_app=cloud_app,
             app_id=app_id,
@@ -187,7 +195,7 @@ def push(
     # If the override for creating a new instance was used, we create the
     # instance and we are done.
     if create_defined:
-        info("Used option --create-instance-id to link version to new instance.", emoji=":bulb:")
+        info("Used option --create-instance-id to link version to new instance.")
         _create_instance(
             cloud_app=cloud_app,
             app_id=app_id,
@@ -243,34 +251,19 @@ def _handle_version_creation(
     # If the user provides a version, and it exists, we use it directly and we
     # are done.
     if version_id is not None and version_id != "":
-        exists = cloud_app.version_exists(version_id=version_id)
-        if exists:
-            error(
-                f"Version [magenta]{version_id}[/magenta] already exists for application [magenta]{app_id}[/magenta]."
-            )
-
-            return "", False
-
-        info(
-            msg=f"Version [magenta]{version_id}[/magenta] does not exist. A new version will be created.",
-            emoji=":bulb:",
-        )
-
+        info(f"Version [magenta]{version_id}[/magenta] does not exist. A new version will be created.")
         version_yes = True  # Activate auto-confirm since user provided a version ID.
 
     # If we are not auto-confirming version creation, ask the user.
     if not version_yes:
         should_create = get_confirmation(
-            msg=f"Do you want to create a new version [magenta]{app_id}[/magenta] now?",
+            msg=f"Do you want to create a new version for application [magenta]{app_id}[/magenta] now?",
             default=True,
         )
 
         # If the user does not want to create a new version, we are done.
         if not should_create:
-            info(
-                msg="Will not create a new version.",
-                emoji=":bulb:",
-            )
+            info("Will not create a new version.")
             return "", False
 
     # Create a new version if either the user confirms by prompt or by using
@@ -314,10 +307,7 @@ def _handle_instance_prompting(
     # If this is not an interactive terminal, do not ask for instance linking,
     # to avoid hanging indefinitely waiting for a user response.
     if not sys.stdin.isatty():
-        info(
-            msg="Non-interactive terminal detected. Skipping instance linking.",
-            emoji=":bulb:",
-        )
+        info("Non-interactive terminal detected. Skipping instance linking.")
 
         return
 
@@ -328,10 +318,7 @@ def _handle_instance_prompting(
         case_sensitive=False,
     )
     if instance_id == "":
-        info(
-            msg="No instance ID provided. Skipping instance linking.",
-            emoji=":bulb:",
-        )
+        info("No instance ID provided. Skipping instance linking.")
         return
 
     # Based on whether the instance exists or not, ask the user if they want to
@@ -347,10 +334,7 @@ def _handle_instance_prompting(
         )
 
         if not should_update:
-            info(
-                msg=f"Will not update instance [magenta]{instance_id}[/magenta].",
-                emoji=":bulb:",
-            )
+            info(f"Will not update instance [magenta]{instance_id}[/magenta].")
             return
 
         _update_instance(
@@ -370,10 +354,7 @@ def _handle_instance_prompting(
     )
 
     if not should_create:
-        info(
-            msg=f"Will not create instance [magenta]{instance_id}[/magenta].",
-            emoji=":bulb:",
-        )
+        info(f"Will not create instance [magenta]{instance_id}[/magenta].")
         return
 
     _create_instance(

{nextmv-1.0.0.dev9 → nextmv-1.0.0.dev10}/nextmv/cli/cloud/batch/delete.py

@@ -53,10 +53,7 @@ def delete(
         )
 
         if not confirm:
-            info(
-                msg=f"Batch experiment [magenta]{batch_experiment_id}[/magenta] will not be deleted.",
-                emoji=":bulb:",
-            )
+            info(f"Batch experiment [magenta]{batch_experiment_id}[/magenta] will not be deleted.")
             return
 
     cloud_app = build_app(app_id=app_id, profile=profile)

{nextmv-1.0.0.dev9 → nextmv-1.0.0.dev10}/nextmv/cli/cloud/ensemble/delete.py

@@ -52,10 +52,7 @@ def delete(
         )
 
         if not confirm:
-            info(
-                msg=f"Ensemble definition [magenta]{ensemble_definition_id}[/magenta] will not be deleted.",
-                emoji=":bulb:",
-            )
+            info(f"Ensemble definition [magenta]{ensemble_definition_id}[/magenta] will not be deleted.")
             return
 
     cloud_app = build_app(app_id=app_id, profile=profile)

{nextmv-1.0.0.dev9 → nextmv-1.0.0.dev10}/nextmv/cli/cloud/input_set/__init__.py

@@ -5,6 +5,7 @@ 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
@@ -12,6 +13,7 @@ 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)

nextmv-1.0.0.dev10/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-1.0.0.dev9 → nextmv-1.0.0.dev10}/nextmv/cli/cloud/instance/delete.py

@@ -51,7 +51,7 @@ def delete(
         )
 
         if not confirm:
-            info(msg=f"Instance [magenta]{instance_id}[/magenta] will not be deleted.", emoji=":bulb:")
+            info(f"Instance [magenta]{instance_id}[/magenta] will not be deleted.")
             return
 
     cloud_app = build_app(app_id=app_id, profile=profile)

{nextmv-1.0.0.dev9 → nextmv-1.0.0.dev10}/nextmv/cli/cloud/managed_input/delete.py

@@ -53,7 +53,7 @@ def delete(
         )
 
         if not confirm:
-            info(msg=f"Managed input [magenta]{managed_input_id}[/magenta] will not be deleted.", emoji=":bulb:")
+            info(f"Managed input [magenta]{managed_input_id}[/magenta] will not be deleted.")
             return
 
     cloud_app = build_app(app_id=app_id, profile=profile)

{nextmv-1.0.0.dev9 → nextmv-1.0.0.dev10}/nextmv/cli/cloud/run/create.py

@@ -129,7 +129,7 @@ def create(
             metavar="INSTANCE_ID",
             rich_help_panel="Run configuration",
         ),
-    ] = "latest",
+    ] = None,
     integration_id: Annotated[
         str | None,
         typer.Option(
@@ -240,12 +240,11 @@ def create(
     specify the instance with the --instance-id flag. These are the possible
     values for this flag:
 
+    - [yellow]unspecified[/yellow]: Run against the default instance of the
+      application. When an application is created, the default instance is [magenta]latest[/magenta].
     - [yellow]latest[/yellow]: uses the special [magenta]latest[/magenta]
       instance of the application. This corresponds to the latest pushed
-      executable. This is the default behavior.
-    - [yellow]default[/yellow]: if the application has a [italic]default[/italic]
-      instance configured, then it uses that instance. Setting the flag's value
-      to [magenta]''[/magenta] (empty string) has the same effect.
+      executable.
     - [yellow]<INSTANCE_ID>[/yellow]: uses the instance with the given ID.
 
     [bold][underline]Examples[/underline][/bold]
@@ -319,10 +318,6 @@ def create(
     )
     run_options = build_run_options(options)
 
-    # Handles the default instance.
-    if instance_id == "default":
-        instance_id = ""
-
     # Start the run before deciding if we should poll or not.
     input_kwarg = resolve_input_kwarg(
         stdin=stdin,

{nextmv-1.0.0.dev9 → nextmv-1.0.0.dev10}/nextmv/cli/cloud/scenario/delete.py

@@ -53,10 +53,7 @@ def delete(
         )
 
         if not confirm:
-            info(
-                msg=f"Scenario test [magenta]{scenario_test_id}[/magenta] will not be deleted.",
-                emoji=":bulb:",
-            )
+            info(f"Scenario test [magenta]{scenario_test_id}[/magenta] will not be deleted.")
             return
 
     cloud_app = build_app(app_id=app_id, profile=profile)

{nextmv-1.0.0.dev9 → nextmv-1.0.0.dev10}/nextmv/cli/cloud/secrets/delete.py

@@ -52,10 +52,7 @@ def delete(
         )
 
         if not confirm:
-            info(
-                msg=f"Secrets collection [magenta]{secrets_collection_id}[/magenta] will not be deleted.",
-                emoji=":bulb:",
-            )
+            info(f"Secrets collection [magenta]{secrets_collection_id}[/magenta] will not be deleted.")
             return
 
     cloud_app = build_app(app_id=app_id, profile=profile)

{nextmv-1.0.0.dev9 → nextmv-1.0.0.dev10}/nextmv/cli/cloud/shadow/delete.py

@@ -53,10 +53,7 @@ def delete(
         )
 
         if not confirm:
-            info(
-                msg=f"Shadow test [magenta]{shadow_test_id}[/magenta] will not be deleted.",
-                emoji=":bulb:",
-            )
+            info(f"Shadow test [magenta]{shadow_test_id}[/magenta] will not be deleted.")
             return
 
     cloud_app = build_app(app_id=app_id, profile=profile)

{nextmv-1.0.0.dev9 → nextmv-1.0.0.dev10}/nextmv/cli/cloud/shadow/stop.py

@@ -2,11 +2,14 @@
 This module defines the cloud shadow stop command for the Nextmv CLI.
 """
 
+from typing import Annotated
+
 import typer
 
 from nextmv.cli.configuration.config import build_app
-from nextmv.cli.message import in_progress, success
+from nextmv.cli.message import enum_values, in_progress, success
 from nextmv.cli.options import AppIDOption, ProfileOption, ShadowTestIDOption
+from nextmv.cloud.shadow import StopIntent
 
 # Set up subcommand application.
 app = typer.Typer()
@@ -15,6 +18,15 @@ app = typer.Typer()
 @app.command()
 def stop(
     app_id: AppIDOption,
+    intent: Annotated[
+        StopIntent,
+        typer.Option(
+            "--intent",
+            "-i",
+            help=f"Intent for stopping the shadow test. Allowed values are: {enum_values(StopIntent)}.",
+            metavar="INTENT",
+        ),
+    ],
     shadow_test_id: ShadowTestIDOption,
     profile: ProfileOption = None,
 ) -> None:
@@ -34,7 +46,7 @@ def stop(
 
     in_progress(msg="Stopping shadow test...")
     cloud_app = build_app(app_id=app_id, profile=profile)
-    cloud_app.stop_shadow_test(shadow_test_id=shadow_test_id)
+    cloud_app.stop_shadow_test(shadow_test_id=shadow_test_id, intent=StopIntent(intent))
     success(
         f"Shadow test [magenta]{shadow_test_id}[/magenta] stopped successfully "
         f"in application [magenta]{app_id}[/magenta]."

{nextmv-1.0.0.dev9 → nextmv-1.0.0.dev10}/nextmv/cli/cloud/switchback/delete.py

@@ -53,10 +53,7 @@ def delete(
         )
 
         if not confirm:
-            info(
-                msg=f"Switchback test [magenta]{switchback_test_id}[/magenta] will not be deleted.",
-                emoji=":bulb:",
-            )
+            info(f"Switchback test [magenta]{switchback_test_id}[/magenta] will not be deleted.")
             return
 
     cloud_app = build_app(app_id=app_id, profile=profile)

{nextmv-1.0.0.dev9 → nextmv-1.0.0.dev10}/nextmv/cli/cloud/switchback/stop.py

@@ -2,11 +2,14 @@
 This module defines the cloud switchback stop command for the Nextmv CLI.
 """
 
+from typing import Annotated
+
 import typer
 
 from nextmv.cli.configuration.config import build_app
-from nextmv.cli.message import in_progress, success
+from nextmv.cli.message import enum_values, in_progress, success
 from nextmv.cli.options import AppIDOption, ProfileOption, SwitchbackTestIDOption
+from nextmv.cloud.shadow import StopIntent
 
 # Set up subcommand application.
 app = typer.Typer()
@@ -15,6 +18,15 @@ app = typer.Typer()
 @app.command()
 def stop(
     app_id: AppIDOption,
+    intent: Annotated[
+        StopIntent,
+        typer.Option(
+            "--intent",
+            "-i",
+            help=f"Intent for stopping the switchback test. Allowed values are: {enum_values(StopIntent)}.",
+            metavar="INTENT",
+        ),
+    ],
     switchback_test_id: SwitchbackTestIDOption,
     profile: ProfileOption = None,
 ) -> None:
@@ -34,7 +46,7 @@ def stop(
 
     in_progress(msg="Stopping switchback test...")
     cloud_app = build_app(app_id=app_id, profile=profile)
-    cloud_app.stop_switchback_test(switchback_test_id=switchback_test_id)
+    cloud_app.stop_switchback_test(switchback_test_id=switchback_test_id, intent=StopIntent(intent))
     success(
         f"Switchback test [magenta]{switchback_test_id}[/magenta] stopped successfully "
         f"in application [magenta]{app_id}[/magenta]."

{nextmv-1.0.0.dev9 → nextmv-1.0.0.dev10}/nextmv/cli/cloud/version/delete.py

@@ -51,7 +51,7 @@ def delete(
         )
 
         if not confirm:
-            info(msg=f"Version [magenta]{version_id}[/magenta] will not be deleted.", emoji=":bulb:")
+            info(f"Version [magenta]{version_id}[/magenta] will not be deleted.")
             return
 
     cloud_app = build_app(app_id=app_id, profile=profile)