nextmv 1.0.0__py3-none-any.whl → 1.0.0.dev0__py3-none-any.whl

nextmv/cloud/application/__init__.py

@@ -21,7 +21,7 @@ list_application
 import json
 import shutil
 import sys
-from datetime import datetime
+from datetime import datetime, timezone
 from enum import Enum
 from typing import Any
 
@@ -41,8 +41,6 @@ from nextmv.cloud.application._instance import ApplicationInstanceMixin
 from nextmv.cloud.application._managed_input import ApplicationManagedInputMixin
 from nextmv.cloud.application._run import ApplicationRunMixin
 from nextmv.cloud.application._secrets import ApplicationSecretsMixin
-from nextmv.cloud.application._shadow import ApplicationShadowMixin
-from nextmv.cloud.application._switchback import ApplicationSwitchbackMixin
 from nextmv.cloud.application._utils import _is_not_exist_error
 from nextmv.cloud.application._version import ApplicationVersionMixin
 from nextmv.cloud.client import Client
@@ -102,8 +100,6 @@ class Application(
     ApplicationVersionMixin,
     ApplicationInputSetMixin,
     ApplicationManagedInputMixin,
-    ApplicationShadowMixin,
-    ApplicationSwitchbackMixin,
 ):
     """
     A published decision model that can be executed.
@@ -250,7 +246,7 @@ class Application(
     def new(
         cls,
         client: Client,
-        name: str | None = None,
+        name: str,
         id: str | None = None,
         description: str | None = None,
         is_workflow: bool | None = None,
@@ -268,13 +264,13 @@ class Application(
         ----------
         client : Client
             Client to use for interacting with the Nextmv Cloud API.
-        name : str | None = None
-            Name of the application. Uses the ID as the name if not provided.
-        id : str | None = None
+        name : str
+            Name of the application.
+        id : str, optional
             ID of the application. Will be generated if not provided.
-        description : str | None = None
+        description : str, optional
             Description of the application.
-        is_workflow : bool | None = None
+        is_workflow : bool, optional
             Whether the application is a Decision Workflow.
         exist_ok : bool, default=False
             If True and an application with the same ID already exists,
@@ -296,10 +292,7 @@ class Application(
         >>> app = Application.new(client=client, name="My New App", id="my-app")
         """
 
-        if exist_ok and (id is None or id == ""):
-            raise ValueError("If exist_ok is True, id must be provided")
-
-        if id is None or id == "":
+        if id is None:
             id = safe_id("app")
 
         if exist_ok and cls.exists(client=client, id=id):
@@ -310,9 +303,6 @@ class Application(
 
             return cls.from_dict({"client": client} | response.json())
 
-        if name is None or name == "":
-            name = id
-
         payload = {
             "name": name,
             "id": id,
@@ -405,6 +395,10 @@ class Application(
         model: Model | None = None,
         model_configuration: ModelConfiguration | None = None,
         rich_print: bool = False,
+        no_version: bool = False,
+        version_id: str | None = None,
+        version_name: str | None = None,
+        version_description: str | None = None,
     ) -> None:
         """
         Push an app to Nextmv Cloud.
@@ -422,6 +416,15 @@ class Application(
         `nextmv.Model`. The model is encoded, some dependencies and
         accompanying files are packaged, and the app is pushed to Nextmv Cloud.
 
+        The default behavior of this function is to create a new application
+        version _after_ the app has been pushed. You can set the `no_version`
+        argument to `True` to skip this step. The `version_id`, `version_name`,
+        and `version_description` arguments can be used to customize the version
+        that is created. If the `version_id` is not specified, a randomly
+        generated ID will be used. If the `version_name` is not specified, a
+        generic name with a timestamp will be used. Lastly, if no description is
+        specified, then a generic description will also be used.
+
         Parameters
         ----------
         manifest : Optional[Manifest], default=None
@@ -440,6 +443,21 @@ class Application(
             with `model`.
         rich_print : bool, default=False
             Whether to use rich printing when verbose output is enabled.
+        no_version : bool, default=False
+            If True, do not create a new version after pushing the app.
+        version_id : Optional[str], default=None
+            ID of the version to create after pushing the app. If None, a unique
+            ID will be generated.
+        version_name : Optional[str], default=None
+            Name of the version to create after pushing the app. If None, a name
+            with a timestamp will be generated.
+        version_description : Optional[str], default=None
+            Description of the version to create after pushing the app. If None, a
+            generic description with a timestamp will be generated.
+
+        Returns
+        -------
+        None
 
         Raises
         ------
@@ -543,6 +561,45 @@ class Application(
         except OSError as e:
             raise Exception(f"error deleting output directory: {e}") from e
 
+        if no_version:
+            if verbose:
+                if rich_print:
+                    rich.print(
+                        f":white_check_mark: Push completed for Nextmv application [magenta]{self.id}[/magenta] "
+                        "without creating a new version.",
+                        file=sys.stderr,
+                    )
+                else:
+                    log("✅ Push completed without creating a new version for Nextmv application.")
+
+            return
+
+        now = datetime.now(timezone.utc)
+        if version_id is None:
+            version_id = safe_id(prefix="version") + f"-{now.strftime('%Y%m%d-%H%M%S')}"
+        if version_name is None:
+            version_name = f"Version {version_id}"
+        if version_description is None:
+            version_description = f"Version created automatically from push at {now.strftime('%Y-%m-%dT%H:%M:%SZ')}"
+
+        version = self.new_version(
+            id=version_id,
+            name=version_name,
+            description=version_description,
+        )
+        version_dict = version.to_dict()
+
+        if verbose:
+            if rich_print:
+                rich.print(
+                    f":white_check_mark: Automatically created new version [magenta]{version.id}[/magenta].",
+                    file=sys.stderr,
+                )
+                rich.print_json(data=version_dict)
+            else:
+                log(f'✅ Automatically created new version "{version.id}".')
+                log(json.dumps(version_dict, indent=2))
+
     def update(
         self,
         name: str | None = None,

nextmv/cloud/application/_acceptance.py

@@ -9,7 +9,6 @@ import requests
 from nextmv.cloud.acceptance_test import AcceptanceTest, Metric
 from nextmv.cloud.batch_experiment import BatchExperimentRun, ExperimentStatus
 from nextmv.polling import DEFAULT_POLLING_OPTIONS, PollingOptions, poll
-from nextmv.safe import safe_id
 
 if TYPE_CHECKING:
     from . import Application
@@ -164,8 +163,8 @@ class ApplicationAcceptanceMixin:
         self: "Application",
         candidate_instance_id: str,
         baseline_instance_id: str,
+        id: str,
         metrics: list[Metric | dict[str, Any]],
-        id: str | None = None,
         name: str | None = None,
         input_set_id: str | None = None,
         description: str | None = None,
@@ -186,8 +185,8 @@ class ApplicationAcceptanceMixin:
             ID of the candidate instance.
         baseline_instance_id : str
             ID of the baseline instance.
-        id : str | None, default=None
-            ID of the acceptance test. Will be generated if not provided.
+        id : str
+            ID of the acceptance test.
         metrics : list[Union[Metric, dict[str, Any]]]
             List of metrics to use for the acceptance test.
         name : Optional[str], default=None
@@ -211,11 +210,6 @@ class ApplicationAcceptanceMixin:
             If the batch experiment ID does not match the acceptance test ID.
         """
 
-        # Generate ID if not provided
-        if id is None or id == "":
-            id = safe_id("acceptance")
-
-        # Use ID as name if name not provided
         if name is None or name == "":
             name = id
 
@@ -271,10 +265,11 @@ class ApplicationAcceptanceMixin:
             "metrics": payload_metrics,
             "experiment_id": batch_experiment_id,
             "name": name,
-            "id": id,
         }
         if description is not None:
             payload["description"] = description
+        if id is not None:
+            payload["id"] = id
 
         response = self.client.request(
             method="POST",
@@ -288,8 +283,8 @@ class ApplicationAcceptanceMixin:
         self: "Application",
         candidate_instance_id: str,
         baseline_instance_id: str,
+        id: str,
         metrics: list[Metric | dict[str, Any]],
-        id: str | None = None,
         name: str | None = None,
         input_set_id: str | None = None,
         description: str | None = None,
@@ -307,8 +302,8 @@ class ApplicationAcceptanceMixin:
             ID of the candidate instance.
         baseline_instance_id : str
             ID of the baseline instance.
-        id : str | None, default=None
-            ID of the acceptance test. Will be generated if not provided.
+        id : str
+            ID of the acceptance test.
         metrics : list[Union[Metric, dict[str, Any]]]
             List of metrics to use for the acceptance test.
         name : Optional[str], default=None

nextmv/cloud/application/_batch_scenario.py

@@ -10,6 +10,7 @@ from nextmv.cloud.batch_experiment import (
     BatchExperimentMetadata,
     BatchExperimentRun,
     ExperimentStatus,
+    to_runs,
 )
 from nextmv.cloud.input_set import InputSet, ManagedInput
 from nextmv.cloud.scenario import Scenario, ScenarioInputType, _option_sets, _scenarios_by_id
@@ -257,6 +258,7 @@ class ApplicationBatchMixin:
         self: "Application",
         name: str | None = None,
         input_set_id: str | None = None,
+        instance_ids: list[str] | None = None,
         description: str | None = None,
         id: str | None = None,
         option_sets: dict[str, dict[str, str]] | None = None,
@@ -272,6 +274,9 @@ class ApplicationBatchMixin:
             Name of the batch experiment. If not provided, the ID will be used as the name.
         input_set_id: str | None
             ID of the input set to use for the batch experiment.
+        instance_ids: list[str]
+            This argument is deprecated, use `runs` instead.
+            List of instance IDs to use for the batch experiment.
         description: Optional[str]
             Optional description of the batch experiment.
         id: Optional[str]
@@ -299,11 +304,11 @@ class ApplicationBatchMixin:
         """
 
         # Generate ID if not provided
-        if id is None or id == "":
+        if id is None:
             id = safe_id("batch")
 
         # Use ID as name if name not provided
-        if name is None or name == "":
+        if name is None:
             name = id
 
         payload = {
@@ -312,6 +317,11 @@ class ApplicationBatchMixin:
         }
         if input_set_id is not None:
             payload["input_set_id"] = input_set_id
+        if instance_ids is not None:
+            input_set = self.input_set(input_set_id)
+            runs = to_runs(instance_ids, input_set)
+            payload_runs = [run.to_dict() for run in runs]
+            payload["runs"] = payload_runs
         if description is not None:
             payload["description"] = description
         if option_sets is not None:
@@ -336,6 +346,7 @@ class ApplicationBatchMixin:
         self: "Application",
         name: str | None = None,
         input_set_id: str | None = None,
+        instance_ids: list[str] | None = None,
         description: str | None = None,
         id: str | None = None,
         option_sets: dict[str, dict[str, str]] | None = None,
@@ -357,6 +368,9 @@ class ApplicationBatchMixin:
             Name of the batch experiment. If not provided, the ID will be used as the name.
         input_set_id: str
             ID of the input set to use for the batch experiment.
+        instance_ids: list[str]
+            List of instance IDs to use for the batch experiment. This argument
+            is deprecated, use `runs` instead.
         description: Optional[str]
             Optional description of the batch experiment.
         id: Optional[str]
@@ -388,6 +402,7 @@ class ApplicationBatchMixin:
         batch_id = self.new_batch_experiment(
             name=name,
             input_set_id=input_set_id,
+            instance_ids=instance_ids,
             description=description,
             id=id,
             option_sets=option_sets,
@@ -466,11 +481,11 @@ class ApplicationBatchMixin:
             raise ValueError("At least one scenario must be provided")
 
         # Generate ID if not provided
-        if id is None or id == "":
+        if id is None:
             id = safe_id("scenario")
 
         # Use ID as name if name not provided
-        if name is None or name == "":
+        if name is None:
             name = id
 
         scenarios_by_id = _scenarios_by_id(scenarios)

nextmv/cloud/application/_input_set.py

@@ -6,7 +6,6 @@ from datetime import datetime
 from typing import TYPE_CHECKING
 
 from nextmv.cloud.input_set import InputSet, ManagedInput
-from nextmv.safe import safe_id
 
 if TYPE_CHECKING:
     from . import Application
@@ -17,32 +16,6 @@ class ApplicationInputSetMixin:
     Mixin class for managing app input sets within an application.
     """
 
-    def delete_input_set(self: "Application", input_set_id: str) -> None:
-        """
-        Delete an input set.
-
-        Deletes an input set along with all the associated information.
-
-        Parameters
-        ----------
-        input_set_id : str
-            ID of the input set to delete.
-
-        Raises
-        ------
-        requests.HTTPError
-            If the response status code is not 2xx.
-
-        Examples
-        --------
-        >>> app.delete_input_set("input-set-123")
-        """
-
-        _ = self.client.request(
-            method="DELETE",
-            endpoint=f"{self.experiments_endpoint}/inputsets/{input_set_id}",
-        )
-
     def input_set(self: "Application", input_set_id: str) -> InputSet:
         """
         Get an input set.
@@ -108,8 +81,8 @@ class ApplicationInputSetMixin:
 
     def new_input_set(
         self: "Application",
-        id: str | None = None,
-        name: str | None = None,
+        id: str,
+        name: str,
         description: str | None = None,
         end_time: datetime | None = None,
         instance_id: str | None = None,
@@ -134,11 +107,10 @@ class ApplicationInputSetMixin:
 
         Parameters
         ----------
-        id: str | None = None
-            ID of the input set, will be generated if not provided.
-        name: str | None = None
-            Name of the input set. If not provided, the ID will be used as
-            the name.
+        id: str
+            ID of the input set
+        name: str
+            Name of the input set.
         description: Optional[str]
             Optional description of the input set.
         end_time: Optional[datetime]
@@ -173,14 +145,6 @@ class ApplicationInputSetMixin:
             If the response status code is not 2xx.
         """
 
-        # Generate ID if not provided
-        if id is None or id == "":
-            id = safe_id("input-set")
-
-        # Use ID as name if name not provided
-        if name is None or name == "":
-            name = id
-
         payload = {
             "id": id,
             "name": name,

nextmv/cloud/application/_instance.py

@@ -194,15 +194,15 @@ class ApplicationInstanceMixin:
         'Production Instance'
         """
 
-        if exist_ok and (id is None or id == ""):
+        if exist_ok and id is None:
             raise ValueError("If exist_ok is True, id must be provided")
 
         if exist_ok and self.instance_exists(instance_id=id):
             return self.instance(instance_id=id)
 
-        if id is None or id == "":
+        if id is None:
             id = safe_id(prefix="instance")
-        if name is None or name == "":
+        if name is None:
             name = id
 
         payload = {

nextmv/cloud/application/_managed_input.py

@@ -147,9 +147,9 @@ class ApplicationManagedInputMixin:
         if upload_id is None and run_id is None:
             raise ValueError("Either upload_id or run_id must be specified")
 
-        if id is None or id == "":
+        if id is None:
             id = safe_id(prefix="managed-input")
-        if name is None or name == "":
+        if name is None:
             name = id
 
         payload = {

nextmv/cloud/application/_version.py

@@ -132,16 +132,15 @@ class ApplicationVersionMixin:
         ... )
         """
 
-        if exist_ok and (id is None or id == ""):
+        if exist_ok and id is None:
             raise ValueError("If exist_ok is True, id must be provided")
 
         if exist_ok and self.version_exists(version_id=id):
             return self.version(version_id=id)
 
-        if id is None or id == "":
+        if id is None:
             id = safe_id(prefix="version")
-
-        if name is None or name == "":
+        if name is None:
             name = id
 
         payload = {

nextmv/cloud/batch_experiment.py

@@ -30,9 +30,7 @@ class ExperimentStatus(str, Enum):
 
     You can import the `ExperimentStatus` class directly from `cloud`:
 
-    ```python
-    from nextmv.cloud import ExperimentStatus
-    ```
+    ```python from nextmv.cloud import ExperimentStatus ```
 
     This enum represents the comprehensive set of possible states for an
     experiment in Nextmv Cloud.

nextmv/cloud/integration.py

@@ -225,12 +225,12 @@ class Integration(BaseModel):
     def new(  # noqa: C901
         cls,
         client: Client,
+        name: str,
         integration_type: IntegrationType | str,
         exec_types: list[ManifestType | str],
         provider: IntegrationProvider | str,
         provider_config: dict[str, Any],
         integration_id: str | None = None,
-        name: str | None = None,
         description: str | None = None,
         is_global: bool = False,
         application_ids: list[str] | None = None,
@@ -243,6 +243,8 @@ class Integration(BaseModel):
         ----------
         client : Client
             Client to use for interacting with the Nextmv Cloud API.
+        name : str
+            The name of the integration.
         integration_type : IntegrationType | str
             The type of the integration. Please refer to the `IntegrationType`
             enum for possible values.
@@ -257,9 +259,6 @@ class Integration(BaseModel):
         integration_id : str, optional
             The unique identifier of the integration. If not provided,
             it will be generated automatically.
-        name : str | None, optional
-            The name of the integration. If not provided, the integration ID
-            will be used as the name.
         description : str, optional
             An optional description of the integration.
         is_global : bool, optional, default=False
@@ -303,10 +302,8 @@ class Integration(BaseModel):
         elif not is_global and application_ids is None:
             raise ValueError("A non-global integration must have specific application IDs.")
 
-        if integration_id is None or integration_id == "":
+        if integration_id is None:
             integration_id = safe_id("integration")
-        if name is None or name == "":
-            name = integration_id
 
         if exist_ok:
             try:

nextmv/deprecated.py

@@ -1,5 +1,4 @@
-"""
-Utilities for handling deprecated functionality within the Nextmv Python SDK.
+"""Utilities for handling deprecated functionality within the Nextmv Python SDK.
 
 This module provides tools to mark functions, methods, or features as deprecated,
 emitting appropriate warnings to users. These warnings inform users that the
@@ -14,8 +13,7 @@ import warnings
 
 
 def deprecated(name: str, reason: str) -> None:
-    """
-    Mark functionality as deprecated with a warning message.
+    """Mark functionality as deprecated with a warning message.
 
     This function emits a DeprecationWarning when called, indicating that
     the functionality will be removed in a future release.
@@ -42,7 +40,7 @@ def deprecated(name: str, reason: str) -> None:
 
     warnings.simplefilter("always", DeprecationWarning)
     warnings.warn(
-        f"{name}: {reason}. This functionality will be removed in the next major release.",
+        f"{name}: {reason}. This functionality will be removed in a future release",
         category=DeprecationWarning,
         stacklevel=2,
     )

nextmv/input.py

@@ -38,6 +38,7 @@ from enum import Enum
 from typing import Any
 
 from nextmv._serialization import serialize_json
+from nextmv.deprecated import deprecated
 from nextmv.options import Options
 
 INPUTS_KEY = "inputs"
@@ -940,6 +941,57 @@ class LocalInputLoader(InputLoader):
         return data
 
 
+def load_local(
+    input_format: InputFormat | None = InputFormat.JSON,
+    options: Options | None = None,
+    path: str | None = None,
+    csv_configurations: dict[str, Any] | None = None,
+) -> Input:
+    """
+    !!! warning
+        `load_local` is deprecated, use `load` instead.
+
+    Load input data from local sources.
+
+    This is a convenience function for instantiating a `LocalInputLoader`
+    and calling its `load` method.
+
+    Parameters
+    ----------
+    input_format : InputFormat, optional
+        Format of the input data. Default is `InputFormat.JSON`.
+    options : Options, optional
+        Options for loading the input data.
+    path : str, optional
+        Path to the input data.
+    csv_configurations : dict[str, Any], optional
+        Configurations for loading CSV files. Custom kwargs for
+        Python's `csv.DictReader`.
+
+    Returns
+    -------
+    Input
+        The loaded input data in an Input object.
+
+    Raises
+    ------
+    ValueError
+        If the path is invalid or data format is incorrect.
+
+    See Also
+    --------
+    load : The recommended function to use instead.
+    """
+
+    deprecated(
+        name="load_local",
+        reason="`load_local` is deprecated, use `load` instead",
+    )
+
+    loader = LocalInputLoader()
+    return loader.load(input_format, options, path, csv_configurations)
+
+
 _LOCAL_INPUT_LOADER = LocalInputLoader()
 """Default instance of LocalInputLoader used by the load function."""
 

nextmv/local/runner.py

@@ -204,7 +204,7 @@ def new_run(
     if description is None:
         description = f"Local run created at {created_at.isoformat().replace('+00:00', 'Z')}"
 
-    if name is None or name == "":
+    if name is None:
         name = f"local run {run_id}"
 
     information = RunInformation(