nextmv 1.1.0.dev0__tar.gz → 1.1.0.dev2__tar.gz

nextmv-1.1.0.dev2/.python-version

@@ -0,0 +1 @@
+3.13

{nextmv-1.1.0.dev0 → nextmv-1.1.0.dev2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nextmv
-Version: 1.1.0.dev0
+Version: 1.1.0.dev2
 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/
@@ -218,6 +218,7 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Requires-Python: >=3.10
+Requires-Dist: pip>=26.0
 Requires-Dist: pydantic>=2.5.2
 Requires-Dist: pyyaml>=6.0.1
 Requires-Dist: requests>=2.31.0
@@ -226,21 +227,6 @@ Requires-Dist: urllib3>=2.1.0
 Provides-Extra: all
 Requires-Dist: folium>=0.20.0; extra == 'all'
 Requires-Dist: plotly>=6.0.1; extra == 'all'
-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'
-Requires-Dist: twine>=4.0.2; extra == 'dev'
-Requires-Dist: urllib3>=2.1.0; extra == 'dev'
 Provides-Extra: notebook
 Requires-Dist: mlflow>=3.9.0; extra == 'notebook'
 Description-Content-Type: text/markdown

nextmv-1.1.0.dev2/nextmv/__about__.py

@@ -0,0 +1 @@
+__version__ = "v1.1.0.dev2"

{nextmv-1.1.0.dev0 → nextmv-1.1.0.dev2}/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.1.0.dev0 → nextmv-1.1.0.dev2}/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., "solution.objective").
+    - [magenta]field[/magenta]: Field of the metric to measure (e.g., "result.custom.unassigned").
     - [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.
-        $ [dim]METRIC='{{
-            "field": "solution.objective",
+        $ [green]METRIC='{{
+            "field": "result.custom.unassigned",
             "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.
-        $ [dim]METRIC1='{{
-            "field": "solution.objective",
+        $ [green]METRIC1='{{
+            "field": "result.custom.unassigned",
             "metric_type": "direct-comparison",
             "params": {{
                 "operator": "lt",
@@ -95,7 +95,7 @@ app = typer.Typer()
             "statistic": "mean"
         }}'
         METRIC2='{{
-            "field": "statistics.run.duration",
+            "field": "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": "solution.objective",
+                "field": "result.custom.unassigned",
                 "metric_type": "direct-comparison",
                 "params": {{
                     "operator": "lt",
@@ -119,7 +119,7 @@ app = typer.Typer()
                 "statistic": "mean"
             }},
             {{
-                "field": "statistics.run.duration",
+                "field": "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.
-        $ [dim]METRIC='{{
-            "field": "solution.objective",
+        $ [green]METRIC='{{
+            "field": "result.custom.unassigned",
             "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.
-        $ [dim]METRIC='{{
-            "field": "solution.objective",
+        $ [green]METRIC='{{
+            "field": "result.custom.unassigned",
             "metric_type": "direct-comparison",
             "params": {{
                 "operator": "lt",

{nextmv-1.1.0.dev0 → nextmv-1.1.0.dev2}/nextmv/cli/cloud/run/track.py

@@ -124,11 +124,21 @@ def track(
     statistics: Annotated[
         str | None,
         typer.Option(
-            help="The statistics of the run being tracked. A [magenta]json[/magenta] file to read the statistics from.",
+            help="Deprecated: Use 'metrics' instead. The statistics of the run" \
+                " being tracked. A [magenta]json[/magenta] file to read the statistics from.",
             metavar="STATISTICS_PATH",
             rich_help_panel="Tracked run configuration",
         ),
     ] = None,
+    metrics: Annotated[
+        str | None,
+        typer.Option(
+            help="The metrics of the run being tracked. A [magenta]json[/magenta]"\
+                " file to read the metrics from.",
+            metavar="METRICS_PATH",
+            rich_help_panel="Tracked run configuration",
+        ),
+    ] = None,
     # Options for run configuration.
     instance_id: Annotated[
         str | None,
@@ -159,9 +169,9 @@ def track(
     path must be provided. If the content type is
     [magenta]multi-file[/magenta], then a directory path must be provided.
 
-    Run logs, assets, and statistics can be provided via files using the
-    --logs, --assets, and --statistics options, respectively. Assets and
-    statistics must be provided as [magenta]json[/magenta] files, while logs
+    Run logs, assets, and metrics can be provided via files using the
+    --logs, --assets, and --metrics options, respectively. Assets and
+    metrics must be provided as [magenta]json[/magenta] files, while logs
     must be provided as a utf-8 encoded text file.
 
     [bold][underline]Examples[/underline][/bold]
@@ -183,11 +193,11 @@ def track(
         $ [dim]nextmv cloud run track --app-id hare-app --status succeeded --input input.json \\
             --output output.json --logs logs.log[/dim]
 
-    - Track a [magenta]successful[/magenta] [magenta]json[/magenta] run with assets and statistics
+    - Track a [magenta]successful[/magenta] [magenta]json[/magenta] run with assets and metrics
       from [magenta]json[/magenta] files, for an app with ID
       [magenta]hare-app[/magenta].
         $ [dim]nextmv cloud run track --app-id hare-app --status succeeded --input input.json \\
-            --output output.json --assets assets.json --statistics statistics.json[/dim]
+            --output output.json --assets assets.json --metrics metrics.json[/dim]
 
     - Track a [magenta]failed[/magenta] run with an error message, for an app with ID
       [magenta]hare-app[/magenta].
@@ -215,7 +225,7 @@ def track(
     - Track a [magenta]successful[/magenta] [magenta]json[/magenta] run with all available options,
       for an app with ID [magenta]hare-app[/magenta].
         $ [dim]nextmv cloud run track --app-id hare-app --status succeeded --input input.json \\
-            --output output.json --logs logs.log --assets assets.json --statistics statistics.json \\
+            --output output.json --logs logs.log --assets assets.json --metrics metrics.json \\
                 --name "Full run" --description "Complete example" --duration 10000 --instance-id burrow[/dim]
     """
 
@@ -251,6 +261,7 @@ def track(
         assets=assets,
         logs=logs,
         statistics=statistics,
+        metrics=metrics,
     )
 
     # Actually track the run.
@@ -277,12 +288,13 @@ def build_tracked_run_input(
     assets: str | None = None,
     logs: str | None = None,
     statistics: str | None = None,
+    metrics: str | None = None,
 ) -> TrackedRun:
     """
     Builds the tracked run input for tracking a run. Starts by creating a
     TrackedRun object with the provided status, duration, error message, name,
     and description. Then resolves the input and output using helper functions.
-    Finally, it reads the assets, logs, and statistics from the provided file
+    Finally, it reads the assets, logs, and metrics from the provided file
     paths, if any, and assigns them to the TrackedRun object.
 
     Parameters
@@ -310,7 +322,9 @@ def build_tracked_run_input(
     logs : str | None
         The logs file path, if any.
     statistics : str | None
-        The statistics file path, if any.
+        Deprecated: Use metrics. The statistics file path, if any.
+    metrics : str | None
+        The metrics file path, if any.
     """
     tracked_run = TrackedRun(
         status=TrackedRunStatus(status),
@@ -355,6 +369,14 @@ def build_tracked_run_input(
         except json.JSONDecodeError as e:
             error(f"Failed to parse statistics file [magenta]{statistics}[/magenta] as [magenta]json[/magenta]: {e}.")
 
+    # Handle the metrics, which should be a JSON file.
+    if metrics is not None and metrics != "":
+        try:
+            with open(metrics) as f:
+                tracked_run.metrics = json.load(f)
+        except json.JSONDecodeError as e:
+            error(f"Failed to parse metrics file [magenta]{metrics}[/magenta] as [magenta]json[/magenta]: {e}.")
+
     return tracked_run
 
 

{nextmv-1.1.0.dev0 → nextmv-1.1.0.dev2}/nextmv/cli/cloud/sso/create.py

@@ -2,12 +2,13 @@
 This module defines the cloud sso create command for the Nextmv CLI.
 """
 
+import sys
 from typing import Annotated
 
 import typer
 
 from nextmv.cli.configuration.config import build_client
-from nextmv.cli.message import in_progress, print_json
+from nextmv.cli.message import in_progress, success
 from nextmv.cli.options import ProfileOption
 from nextmv.cloud.sso import SSOConfiguration
 
@@ -48,7 +49,7 @@ def create(
         typer.Option(
             "--metadata-document",
             "-d",
-            help="The SSO metadata document as a string.",
+            help="The SSO metadata document as a string or a path to a file containing the document.",
             metavar="METADATA_DOCUMENT",
         ),
     ] = None,
@@ -60,8 +61,15 @@ def create(
     SSO must be configured to enable managed accounts in your organization.
     Please contact [link=https://www.nextmv.io/contact][bold]Nextmv support[/bold][/link] for assistance.
 
-    You must provide either a metadata URL or a metadata document. The metadata
-    document contains the SAML configuration details from your identity provider.
+    You must use either the --metadata-url or --metadata-document option. When
+    working with the metadata document, you have three options:
+
+    - Pipe the document into the command via [magenta]stdin[/magenta].
+    - Provide the document as a string with --metadata-document.
+    - Provide a path to a file containing the document with --metadata-document.
+
+    You can use the [code]nextmv cloud sso get[/code] to get the newly-created
+    configuration after running this command.
 
     [bold][underline]Examples[/underline][/bold]
 
@@ -79,19 +87,26 @@ def create(
     - Create SSO configuration using a metadata document string.
         $ [dim]nextmv cloud sso create --metadata-document "<EntityDescriptor ...</EntityDescriptor>"[/dim]
 
+    - Create SSO configuration using a metadata document file.
+        $ [dim]nextmv cloud sso create --metadata-document "/path/to/metadata_document.xml"[/dim]
+
     - Create SSO configuration using the profile named [magenta]hare[/magenta].
         $ [dim]nextmv cloud sso create --metadata-url "https://sso.cottontailcouriers.net/metadata" \\
             --profile hare[/dim]
     """
 
+    stdin = sys.stdin.read().strip() if sys.stdin.isatty() is False else None
+    if stdin is not None:
+        metadata_document = stdin
+
     cloud_client = build_client(profile)
     in_progress(msg="Creating configuration...")
 
-    configuration = SSOConfiguration.new(
+    SSOConfiguration.new(
         client=cloud_client,
         allow_non_domain_users=allow_non_domain_users,
         enabled=enabled,
         metadata_url=metadata_url,
         metadata_document=metadata_document,
     )
-    print_json(configuration.to_dict())
+    success("SSO configuration created successfully.")

{nextmv-1.1.0.dev0 → nextmv-1.1.0.dev2}/nextmv/cli/cloud/sso/delete.py

@@ -30,10 +30,9 @@ def delete(
     """
     Deletes the SSO configuration.
 
-    You must have the [magenta]administrator[/magenta] role on the organization in order to delete it.
-
-    This action is permanent and cannot be undone. Use the --yes
-    flag to skip the confirmation prompt.
+    You must have the [magenta]administrator[/magenta] role on the organization
+    in order to delete it. Use the --yes flag to skip the confirmation prompt.
+    You can create a new SSO configuration again with [code]nextmv cloud sso create[/code].
 
     [bold][underline]Examples[/underline][/bold]
 
@@ -46,7 +45,8 @@ def delete(
 
     if not yes:
         confirm = get_confirmation(
-            "Are you sure you want to delete the sso configuration? This action cannot be undone.",
+            "Are you sure you want to delete the sso configuration? "
+            "You can create it again with [code]nextmv cloud sso create[/code].",
         )
 
         if not confirm:
@@ -55,4 +55,4 @@ def delete(
 
     sso_config = build_sso_config(profile)
     sso_config.delete()
-    success("SSO configuration has been deleted.")
+    success("SSO configuration has been deleted. You can create it again with [code]nextmv cloud sso create[/code].")

{nextmv-1.1.0.dev0 → nextmv-1.1.0.dev2}/nextmv/cli/cloud/sso/update.py

@@ -2,13 +2,12 @@
 This module defines the cloud sso update command for the Nextmv CLI.
 """
 
-import json
 from typing import Annotated
 
 import typer
 
 from nextmv.cli.configuration.config import build_sso_config
-from nextmv.cli.message import print_json, success
+from nextmv.cli.message import success
 from nextmv.cli.options import ProfileOption
 
 # Set up subcommand application.
@@ -35,44 +34,24 @@ def update(
             metavar="METADATA_DOCUMENT",
         ),
     ] = None,
-    output: Annotated[
-        str | None,
-        typer.Option(
-            "--output",
-            "-o",
-            help="Saves the updated SSO configuration information to this location.",
-            metavar="OUTPUT_PATH",
-        ),
-    ] = None,
     profile: ProfileOption = None,
 ) -> None:
     """
     Updates information of a Nextmv Cloud SSO configuration.
 
     This command allows you to update the metadata URL or metadata document of
-    an existing SSO configuration.
+    an existing SSO configuration. You can use the [code]nextmv cloud sso
+    get[/code] to get the updated configuration after running this command.
 
     [bold][underline]Examples[/underline][/bold]
 
     - Update the SSO configuration with a new metadata URL.
         $ [dim]nextmv cloud sso update --metadata-url "https://example.com/metadata.xml"[/dim]
 
-    - Update the SSO configuration with a new metadata document and save the updated information to an
-        [magenta]updated_sso_config.json[/magenta] file.
-        $ [dim]nextmv cloud sso update --metadata-document "<xml>...</xml>" --output updated_sso_config.json[/dim]
+    - Update the SSO configuration with a new metadata document.
+        $ [dim]nextmv cloud sso update --metadata-document "<xml>...</xml>"[/dim]
     """
 
     sso_config = build_sso_config(profile)
-    updated_config = sso_config.update(metadata_url=metadata_url, metadata_document=metadata_document)
+    sso_config.update(metadata_url=metadata_url, metadata_document=metadata_document)
     success("SSO configuration updated successfully.")
-    updated_config_dict = updated_config.to_dict()
-
-    if output is not None and output != "":
-        with open(output, "w") as f:
-            json.dump(updated_config_dict, f, indent=2)
-
-        success(msg=f"Updated SSO configuration information saved to [magenta]{output}[/magenta].")
-
-        return
-
-    print_json(updated_config_dict)

{nextmv-1.1.0.dev0 → nextmv-1.1.0.dev2}/nextmv/cloud/account.py

@@ -19,6 +19,7 @@ from datetime import datetime
 
 from pydantic import AliasChoices, Field
 
+from nextmv import deprecated
 from nextmv.base_model import BaseModel
 from nextmv.cloud.client import Client
 from nextmv.status import StatusV2
@@ -378,6 +379,9 @@ class Account(BaseModel):
 
     def queue(self) -> Queue:
         """
+        !!! warning
+            `Account.queue` is deprecated, use `Application.list_runs` with `status=StatusV2.queued` instead.
+
         Get the queue of runs in the account.
 
         Retrieves the current list of runs that are pending or being executed
@@ -404,6 +408,11 @@ class Account(BaseModel):
         Run run-123: Daily Optimization - Status: RUNNING
         Run run-456: Weekly Planning - Status: QUEUED
         """
+        deprecated(
+            name="Account.queue",
+            reason="`Account.queue` is deprecated, use `Application.list_runs` with `status=StatusV2.queued` instead",
+        )
+
         response = self.client.request(
             method="GET",
             endpoint=self.account_endpoint + "/queue",

{nextmv-1.1.0.dev0 → nextmv-1.1.0.dev2}/nextmv/cloud/application/__init__.py

@@ -789,6 +789,8 @@ class Application(
                     output_config = multi_config["output_configuration"] = {}
                     if content.multi_file.output.statistics:
                         output_config["statistics_path"] = content.multi_file.output.statistics
+                    if content.multi_file.output.metrics:
+                        output_config["metrics_path"] = content.multi_file.output.metrics
                     if content.multi_file.output.assets:
                         output_config["assets_path"] = content.multi_file.output.assets
                     if content.multi_file.output.solutions: