nextmv 1.0.0.dev5__tar.gz → 1.0.0.dev7__tar.gz

{nextmv-1.0.0.dev5 → nextmv-1.0.0.dev7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nextmv
-Version: 1.0.0.dev5
+Version: 1.0.0.dev7
 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,11 +230,13 @@ Provides-Extra: dev
 Requires-Dist: build>=1.0.3; extra == 'dev'
 Requires-Dist: folium>=0.20.0; extra == 'dev'
 Requires-Dist: mlflow>=2.19.0; extra == 'dev'
+Requires-Dist: nextpipe>=0.6.0; extra == 'dev'
 Requires-Dist: nextroute>=1.11.1; 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.dev7/nextmv/__about__.py

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

{nextmv-1.0.0.dev5 → nextmv-1.0.0.dev7}/nextmv/_serialization.py

@@ -90,7 +90,7 @@ def _custom_serial(obj: Any) -> str:
         If the object type is not supported for serialization.
     """
 
-    if isinstance(obj, datetime.datetime | datetime.date):
+    if isinstance(obj, (datetime.datetime, datetime.date)):
         return obj.isoformat()
 
     raise TypeError(f"Type {type(obj)} not serializable")

{nextmv-1.0.0.dev5 → nextmv-1.0.0.dev7}/nextmv/cli/cloud/acceptance/create.py

@@ -45,7 +45,7 @@ app = typer.Typer()
     - Multiple metrics as a [magenta]json[/magenta] array in a single --metrics flag.
 
     Each metric must have the following fields:
-    - [magenta]field[/magenta]: Field of the metric to measure (e.g., "result.custom.unassigned").
+    - [magenta]field[/magenta]: Field of the metric to measure (e.g., "solution.objective").
     - [magenta]metric_type[/magenta]: Type of metric comparison. Allowed values: {enum_values(MetricType)}.
     - [magenta]params[/magenta]: Parameters of the metric comparison.
         - [magenta]operator[/magenta]: Comparison operator. Allowed values: {enum_values(Comparison)}.
@@ -71,8 +71,8 @@ app = typer.Typer()
     [bold][underline]Examples[/underline][/bold]
 
     - Create an acceptance test with a single metric.
-        $ [green]METRIC='{{
-            "field": "result.custom.unassigned",
+        $ [dim]METRIC='{{
+            "field": "solution.objective",
             "metric_type": "direct-comparison",
             "params": {{
                 "operator": "lt",
@@ -85,8 +85,8 @@ app = typer.Typer()
             --metrics "$METRIC" --input-set-id input-set-123[/dim]
 
     - Create with multiple metrics by repeating the flag.
-        $ [green]METRIC1='{{
-            "field": "result.custom.unassigned",
+        $ [dim]METRIC1='{{
+            "field": "solution.objective",
             "metric_type": "direct-comparison",
             "params": {{
                 "operator": "lt",
@@ -95,7 +95,7 @@ app = typer.Typer()
             "statistic": "mean"
         }}'
         METRIC2='{{
-            "field": "run.duration",
+            "field": "statistics.run.duration",
             "metric_type": "direct-comparison",
             "params": {{
                 "operator": "le",
@@ -110,7 +110,7 @@ app = typer.Typer()
     - Create with multiple metrics in a single [magenta]json[/magenta] array.
         $ [dim]METRICS='[
             {{
-                "field": "result.custom.unassigned",
+                "field": "solution.objective",
                 "metric_type": "direct-comparison",
                 "params": {{
                     "operator": "lt",
@@ -119,7 +119,7 @@ app = typer.Typer()
                 "statistic": "mean"
             }},
             {{
-                "field": "run.duration",
+                "field": "statistics.run.duration",
                 "metric_type": "direct-comparison",
                 "params": {{
                     "operator": "le",
@@ -133,8 +133,8 @@ app = typer.Typer()
             --metrics "$METRICS" --input-set-id input-set-123[/dim]
 
     - Create an acceptance test and wait for it to complete.
-        $ [green]METRIC='{{
-            "field": "result.custom.unassigned",
+        $ [dim]METRIC='{{
+            "field": "solution.objective",
             "metric_type": "direct-comparison",
             "params": {{
                 "operator": "lt",
@@ -147,8 +147,8 @@ app = typer.Typer()
             --metrics "$METRIC" --input-set-id input-set-123 --wait[/dim]
 
     - Create an acceptance test and save the results to a file, waiting for completion.
-        $ [green]METRIC='{{
-            "field": "result.custom.unassigned",
+        $ [dim]METRIC='{{
+            "field": "solution.objective",
             "metric_type": "direct-comparison",
             "params": {{
                 "operator": "lt",

{nextmv-1.0.0.dev5 → nextmv-1.0.0.dev7}/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.
@@ -243,14 +251,6 @@ 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:",
@@ -261,7 +261,7 @@ def _handle_version_creation(
     # 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,
         )
 

{nextmv-1.0.0.dev5 → nextmv-1.0.0.dev7}/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.dev7/nextmv/cli/cloud/input_set/delete.py

@@ -0,0 +1,67 @@
+"""
+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(
+                msg=f"Input set [magenta]{input_set_id}[/magenta] will not be deleted.",
+                emoji=":bulb:",
+            )
+            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.dev5 → nextmv-1.0.0.dev7}/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.dev5 → nextmv-1.0.0.dev7}/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.dev5 → nextmv-1.0.0.dev7}/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.dev7/nextmv/cli/community/clone.py

@@ -0,0 +1,86 @@
+"""
+This module defines the community clone command for the Nextmv CLI.
+"""
+
+from typing import Annotated
+
+import typer
+
+from nextmv.cli.configuration.config import build_client
+from nextmv.cli.message import error
+from nextmv.cli.options import ProfileOption
+from nextmv.cloud.community import clone_community_app
+
+# Set up subcommand application.
+app = typer.Typer()
+
+# Helpful constants.
+LATEST_VERSION = "latest"
+
+
+@app.command()
+def clone(
+    app: Annotated[
+        str,
+        typer.Option("--app", "-a", help="The name of the community app to clone.", metavar="COMMUNITY_APP"),
+    ],
+    directory: Annotated[
+        str | None,
+        typer.Option(
+            "--directory",
+            "-d",
+            help="The directory in which to clone the app. Default is the name of the app at current directory.",
+            metavar="DIRECTORY",
+        ),
+    ] = None,
+    version: Annotated[
+        str | None,
+        typer.Option(
+            "--version",
+            "-v",
+            help="The version of the community app to clone.",
+            metavar="VERSION",
+        ),
+    ] = LATEST_VERSION,
+    profile: ProfileOption = None,
+) -> None:
+    """
+    Clone a community app locally.
+
+    By default, the [magenta]latest[/magenta] version will be used. You can
+    specify a version with the --version flag, and customize the output
+    directory with the --directory flag. If you want to list the available
+    apps, use the [code]nextmv community list[/code] command.
+
+    [bold][underline]Examples[/underline][/bold]
+
+    - Clone the [magenta]go-nextroute[/magenta] community app (under the
+      [magenta]"go-nextroute"[/magenta] directory), using the [magenta]latest[/magenta] version.
+        $ [dim]nextmv community clone --app go-nextroute[/dim]
+
+    - Clone the [magenta]go-nextroute[/magenta] community app under the
+      [magenta]"~/sample/my_app"[/magenta] directory, using the [magenta]latest[/magenta] version.
+        $ [dim]nextmv community clone --app go-nextroute --directory ~/sample/my_app[/dim]
+
+    - Clone the [magenta]go-nextroute[/magenta] community app (under the
+      [magenta]"go-nextroute"[/magenta] directory), using version [magenta]v1.2.0[/magenta].
+        $ [dim]nextmv community clone --app go-nextroute --version v1.2.0[/dim]
+
+    - Clone the [magenta]go-nextroute[/magenta] community app (under the
+      [magenta]"go-nextroute"[/magenta] directory), using the [magenta]latest[/magenta] version
+      and a profile named [magenta]hare[/magenta].
+        $ [dim]nextmv community clone --app go-nextroute --profile hare[/dim]
+    """
+
+    if version is not None and version == "":
+        error("The --version flag cannot be an empty string.")
+
+    client = build_client(profile)
+    clone_community_app(
+        client=client,
+        app=app,
+        directory=directory,
+        version=version,
+        verbose=True,
+        rich_print=True,
+    )