nextmv 1.0.0.dev9__py3-none-any.whl → 1.1.0.dev0__py3-none-any.whl

nextmv/cli/message.py

@@ -11,106 +11,107 @@ import rich
 import typer
 
 
-def error(msg: str) -> None:
+def message(msg: str, emoji: str | None = None) -> None:
     """
-    Pretty-print an error message and exit with code 1. Your message should end
-    with a period.
+    Pretty-print a message. Your message should end with a period. The use of
+    emojis is encouraged to give context to the message. An emoji should be a
+    string as specified in:
+    https://rich.readthedocs.io/en/latest/markup.html#emoji.
 
     Parameters
     ----------
     msg : str
-        The error message to display.
-
-    Raises
-    ------
-    typer.Exit
-        Exits the program with code 1.
+        The message to display.
+    emoji : str | None
+        An optional emoji to prefix the message. If None, no emoji is used. The
+        emoji should be a string as specified in:
+        https://rich.readthedocs.io/en/latest/markup.html#emoji. For example:
+        `:hourglass_flowing_sand:`.
     """
 
-    msg = msg.rstrip("\n")
-    if not msg.endswith("."):
-        msg += "."
-
-    rich.print(f":x: [red]Error:[/red] {msg}", file=sys.stderr)
+    msg = _format(msg)
+    if emoji:
+        rich.print(f"{emoji} {msg}", file=sys.stderr)
+        return
 
-    raise typer.Exit(code=1)
+    rich.print(msg, file=sys.stderr)
 
 
-def success(msg: str) -> None:
+def info(msg: str) -> None:
     """
-    Pretty-print a success message. Your message should end with a period.
+    Pretty-print an informational message. Your message should end with a
+    period.
 
     Parameters
     ----------
     msg : str
-        The success message to display.
+        The informational message to display.
     """
 
-    msg = msg.rstrip("\n")
-    if not msg.endswith("."):
-        msg += "."
+    message(msg, emoji=":bulb:")
 
-    rich.print(f":white_check_mark: {msg}", file=sys.stderr)
 
-
-def warning(msg: str) -> None:
+def in_progress(msg: str) -> None:
     """
-    Pretty-print a warning message. Your message should end with a period.
+    Pretty-print an in-progress message with an hourglass emoji. Your message
+    should end with a period.
 
     Parameters
     ----------
     msg : str
-        The warning message to display.
+        The in-progress message to display.
     """
 
-    msg = msg.rstrip("\n")
-    if not msg.endswith("."):
-        msg += "."
-
-    rich.print(f":construction: [yellow] Warning:[/yellow] {msg}", file=sys.stderr)
+    message(msg, emoji=":hourglass_flowing_sand:")
 
 
-def info(msg: str, emoji: str | None = None) -> None:
+def success(msg: str) -> None:
     """
-    Pretty-print an informational message. Your message should end with a
-    period. The use of emojis is encouraged to give context to the message. An
-    emoji should be a string as specified in:
-    https://rich.readthedocs.io/en/latest/markup.html#emoji.
+    Pretty-print a success message. Your message should end with a period.
 
     Parameters
     ----------
     msg : str
-        The informational message to display.
-    emoji : str | None
-        An optional emoji to prefix the message. If None, no emoji is used. The
-        emoji should be a string as specified in:
-        https://rich.readthedocs.io/en/latest/markup.html#emoji. For example:
-        `:hourglass_flowing_sand:`.
+        The success message to display.
     """
 
-    msg = msg.rstrip("\n")
-    if not msg.endswith("."):
-        msg += "."
+    message(msg, emoji=":white_check_mark:")
 
-    if emoji:
-        rich.print(f"{emoji} {msg}", file=sys.stderr)
-        return
 
-    rich.print(msg, file=sys.stderr)
+def warning(msg: str) -> None:
+    """
+    Pretty-print a warning message. Your message should end with a period.
 
+    Parameters
+    ----------
+    msg : str
+        The warning message to display.
+    """
 
-def in_progress(msg: str) -> None:
+    msg = _format(msg)
+    rich.print(f":construction: [yellow] Warning:[/yellow] {msg}", file=sys.stderr)
+
+
+def error(msg: str) -> None:
     """
-    Pretty-print an in-progress message with an hourglass emoji. Your message
-    should end with a period.
+    Pretty-print an error message and exit with code 1. Your message should end
+    with a period.
 
     Parameters
     ----------
     msg : str
-        The in-progress message to display.
+        The error message to display.
+
+    Raises
+    ------
+    typer.Exit
+        Exits the program with code 1.
     """
 
-    info(msg, emoji=":hourglass_flowing_sand:")
+    msg = _format(msg)
+    rich.print(f":x: [red]Error:[/red] {msg}", file=sys.stderr)
+
+    raise typer.Exit(code=1)
 
 
 def print_json(data: dict[str, Any] | list[dict[str, Any]]) -> None:
@@ -151,3 +152,19 @@ def enum_values(enum_class: Enum) -> str:
         return " and ".join(values)
 
     return ", ".join(values[:-1]) + ", and " + values[-1]
+
+
+def _format(msg: str) -> str:
+    """
+    Format a message to ensure it ends with a period.
+
+    Parameters
+    ----------
+    msg : str
+        The message to format.
+    """
+    msg = msg.rstrip("\n")
+    if not msg.endswith("."):
+        msg += "."
+
+    return msg

nextmv/cloud/__init__.py

@@ -30,6 +30,9 @@ from .batch_experiment import BatchExperimentRun as BatchExperimentRun
 from .batch_experiment import ExperimentStatus as ExperimentStatus
 from .client import Client as Client
 from .client import get_size as get_size
+from .community import CommunityApp as CommunityApp
+from .community import clone_community_app as clone_community_app
+from .community import list_community_apps as list_community_apps
 from .ensemble import EnsembleDefinition as EnsembleDefinition
 from .ensemble import EvaluationRule as EvaluationRule
 from .ensemble import RuleObjective as RuleObjective
@@ -55,8 +58,10 @@ from .secrets import SecretType as SecretType
 from .shadow import ShadowTest as ShadowTest
 from .shadow import ShadowTestMetadata as ShadowTestMetadata
 from .shadow import StartEvents as StartEvents
+from .shadow import StopIntent as StopIntent
 from .shadow import TerminationEvents as TerminationEvents
 from .shadow import TestComparison as TestComparison
+from .sso import SSOConfiguration as SSOConfiguration
 from .switchback import SwitchbackPlan as SwitchbackPlan
 from .switchback import SwitchbackPlanUnit as SwitchbackPlanUnit
 from .switchback import SwitchbackTest as SwitchbackTest

nextmv/cloud/account.py

@@ -188,30 +188,32 @@ class Account(BaseModel):
 
     You can import the `Account` class directly from `cloud`:
 
-    ```python
-    from nextmv.cloud import Account
-    ```
+    ```python from nextmv.cloud import Account ```
 
     This class provides access to account-level operations in the Nextmv Cloud,
     such as retrieving the queue of runs.
 
-    Note: It is recommended to use `Account.get()` or `Account.new()`
-    instead of direct initialization to ensure proper setup.
+    Note: It is recommended to use `Account.get()` or `Account.new()` instead
+    of direct initialization to ensure proper setup.
 
-    Parameters
+    Attributes
     ----------
-    client : Client
-        Client to use for interacting with the Nextmv Cloud API.
     account_id : str, optional
         ID of the account (organization).
     name : str, optional
         Name of the account (organization).
     members : list[AccountMember], optional
         List of members in the account (organization).
+    client : Client
+        Client to use for interacting with the Nextmv Cloud API. This is an
+        SDK-specific attribute and it is not part of the API representation of
+        an account.
     account_endpoint : str, default="v1/account"
-        Base endpoint for the account (SDK-specific).
+        Base endpoint for the account. This is an SDK-specific attribute and it
+        is not part of the API representation of an account.
     organization_endpoint : str, default="v1/organization/{organization_id}"
-        Base endpoint for organization operations (SDK-specific).
+        Base endpoint for organization operations. This is an SDK-specific
+        attribute and it is not part of the API representation of an account.
 
     Examples
     --------

nextmv/cloud/application/__init__.py

@@ -21,7 +21,7 @@ list_application
 import json
 import shutil
 import sys
-from datetime import datetime, timezone
+from datetime import datetime
 from enum import Enum
 from typing import Any
 
@@ -46,9 +46,7 @@ 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
-from nextmv.cloud.instance import Instance
 from nextmv.cloud.url import UploadURL
-from nextmv.cloud.version import Version
 from nextmv.logger import log
 from nextmv.manifest import Manifest
 from nextmv.model import Model, ModelConfiguration
@@ -123,10 +121,8 @@ class Application(
     Note: It is recommended to use `Application.get()` or `Application.new()`
     instead of direct initialization to ensure proper setup.
 
-    Parameters
+    Attributes
     ----------
-    client : Client
-        Client to use for interacting with the Nextmv Cloud API.
     id : str
         ID of the application.
     name : str, optional
@@ -147,12 +143,19 @@ class Application(
         Creation timestamp of the application.
     updated_at : datetime, optional
         Last update timestamp of the application.
+    client : Client
+        Client to use for interacting with the Nextmv Cloud API. This is an
+        SDK-specific attribute and it is not part of the API representation of
+        an application.
     endpoint : str, default="v1/applications/{id}"
-        Base endpoint for the application (SDK-specific).
+        Base endpoint for the application. This is an SDK-specific attribute
+        and it is not part of the API representation of an application.
     experiments_endpoint : str, default="{base}/experiments"
-        Base endpoint for experiments (SDK-specific).
+        Base endpoint for experiments. This is an SDK-specific attribute and it
+        is not part of the API representation of an application.
     ensembles_endpoint : str, default="{base}/ensembles"
-        Base endpoint for ensembles (SDK-specific).
+        Base endpoint for ensembles. This is an SDK-specific attribute and it
+        is not part of the API representation of an application.
 
     Examples
     --------
@@ -407,14 +410,6 @@ class Application(
         model: Model | None = None,
         model_configuration: ModelConfiguration | None = None,
         rich_print: bool = False,
-        auto_create: bool = False,
-        version_id: str | None = None,
-        version_name: str | None = None,
-        version_description: str | None = None,
-        instance_id: str | None = None,
-        instance_name: str | None = None,
-        instance_description: str | None = None,
-        update_default_instance: bool = False,
     ) -> None:
         """
         Push an app to Nextmv Cloud.
@@ -432,17 +427,6 @@ class Application(
         `nextmv.Model`. The model is encoded, some dependencies and
         accompanying files are packaged, and the app is pushed to Nextmv Cloud.
 
-        By default, this function only pushes the app. If you want to
-        automatically create a new version and instance after pushing, set
-        `auto_create=True`. The `version_id`, `version_name`, and
-        `version_description` arguments allow you to customize the new version
-        that is created. If not specified, defaults will be generated (random
-        ID, timestamped name/description). Similarly, `instance_id`,
-        `instance_name`, and `instance_description` can be used to customize
-        the new instance. If `update_default_instance` is True, the
-        application's default instance will be updated to the newly created
-        instance.
-
         Parameters
         ----------
         manifest : Optional[Manifest], default=None
@@ -461,30 +445,6 @@ class Application(
             with `model`.
         rich_print : bool, default=False
             Whether to use rich printing when verbose output is enabled.
-        auto_create : bool, default=False
-            If True, automatically create a new version and instance 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 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.
-        instance_id : Optional[str], default=None
-            ID of the instance to create after pushing the app. If None, a unique
-            ID will be generated.
-        instance_name : Optional[str], default=None
-            Name of the instance to create after pushing the app. If None, a
-            name will be generated.
-        instance_description : Optional[str], default=None
-            Description of the instance to create after pushing the app. If None,
-            a generic description with a timestamp will be generated.
-        update_default_instance : bool, default=False
-            If True, update the application's default instance to the newly
-            created instance.
 
         Raises
         ------
@@ -588,44 +548,6 @@ class Application(
         except OSError as e:
             raise Exception(f"error deleting output directory: {e}") from e
 
-        if not auto_create:
-            return
-
-        if verbose:
-            if rich_print:
-                rich.print(
-                    f":hourglass_flowing_sand: Push completed for Nextmv application [magenta]{self.id}[/magenta], "
-                    "creating a new version and instance...",
-                    file=sys.stderr,
-                )
-            else:
-                log("⌛️ Push completed for the Nextmv application, creating a new version and instance...")
-
-        now = datetime.now(timezone.utc)
-        version = self.__version_on_push(
-            now=now,
-            version_id=version_id,
-            version_name=version_name,
-            version_description=version_description,
-            verbose=verbose,
-            rich_print=rich_print,
-        )
-        instance = self.__instance_on_push(
-            now=now,
-            version_id=version.id,
-            instance_id=instance_id,
-            instance_name=instance_name,
-            instance_description=instance_description,
-            verbose=verbose,
-            rich_print=rich_print,
-        )
-        self.__update_on_push(
-            instance=instance,
-            update_default_instance=update_default_instance,
-            verbose=verbose,
-            rich_print=rich_print,
-        )
-
     def update(
         self,
         name: str | None = None,
@@ -941,120 +863,6 @@ class Application(
                 log(f'💥️ Successfully pushed to application: "{self.id}".')
                 log(json.dumps(data, indent=2))
 
-    def __version_on_push(
-        self,
-        now: datetime,
-        version_id: str | None = None,
-        version_name: str | None = None,
-        version_description: str | None = None,
-        verbose: bool = False,
-        rich_print: bool = False,
-    ) -> Version:
-        if version_description is None or version_description == "":
-            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 not verbose:
-            return version
-
-        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)
-
-            return version
-
-        log(f'✅ Automatically created new version "{version.id}".')
-        log(json.dumps(version_dict, indent=2))
-
-        return version
-
-    def __instance_on_push(
-        self,
-        now: datetime,
-        version_id: str,
-        instance_id: str | None = None,
-        instance_name: str | None = None,
-        instance_description: str | None = None,
-        verbose: bool = False,
-        rich_print: bool = False,
-    ) -> Instance:
-        if instance_description is None or instance_description == "":
-            instance_description = f"Instance created automatically from push at {now.strftime('%Y-%m-%dT%H:%M:%SZ')}"
-
-        instance = self.new_instance(
-            version_id=version_id,
-            id=instance_id,
-            name=instance_name,
-            description=instance_description,
-        )
-        instance_dict = instance.to_dict()
-
-        if not verbose:
-            return instance
-
-        if rich_print:
-            rich.print(
-                f":white_check_mark: Automatically created new instance [magenta]{instance.id}[/magenta] "
-                f"using version [magenta]{version_id}[/magenta].",
-                file=sys.stderr,
-            )
-            rich.print_json(data=instance_dict)
-
-            return instance
-
-        log(f'✅ Automatically created new instance "{instance.id}" using version "{version_id}".')
-        log(json.dumps(instance_dict, indent=2))
-
-        return instance
-
-    def __update_on_push(
-        self,
-        instance: Instance,
-        update_default_instance: bool = False,
-        verbose: bool = False,
-        rich_print: bool = False,
-    ) -> None:
-        if not update_default_instance:
-            return
-
-        if verbose:
-            if rich_print:
-                rich.print(
-                    f":hourglass_flowing_sand: Updating default instance for app [magenta]{self.id}[/magenta]...",
-                    file=sys.stderr,
-                )
-            else:
-                log("⌛️ Updating default instance for the Nextmv application...")
-
-        updated_app = self.update(default_instance_id=instance.id)
-        if not verbose:
-            return
-
-        if rich_print:
-            rich.print(
-                f":white_check_mark: Updated default instance to "
-                f"[magenta]{updated_app.default_instance_id}[/magenta] for application "
-                f"[magenta]{self.id}[/magenta].",
-                file=sys.stderr,
-            )
-            rich.print_json(data=updated_app.to_dict())
-
-            return
-
-        log(
-            f'✅ Updated default instance to "{updated_app.default_instance_id}" for application "{self.id}".',
-        )
-        log(json.dumps(updated_app.to_dict(), indent=2))
-
 
 def list_applications(client: Client) -> list[Application]:
     """

nextmv/cloud/application/_acceptance.py

@@ -9,6 +9,7 @@ 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
@@ -163,8 +164,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,
@@ -185,8 +186,8 @@ class ApplicationAcceptanceMixin:
             ID of the candidate instance.
         baseline_instance_id : str
             ID of the baseline instance.
-        id : str
-            ID of the acceptance test.
+        id : str | None, default=None
+            ID of the acceptance test. Will be generated if not provided.
         metrics : list[Union[Metric, dict[str, Any]]]
             List of metrics to use for the acceptance test.
         name : Optional[str], default=None
@@ -210,6 +211,11 @@ 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
 
@@ -265,11 +271,10 @@ 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",
@@ -283,8 +288,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,
@@ -302,8 +307,8 @@ class ApplicationAcceptanceMixin:
             ID of the candidate instance.
         baseline_instance_id : str
             ID of the baseline instance.
-        id : str
-            ID of the acceptance test.
+        id : str | None, default=None
+            ID of the acceptance test. Will be generated if not provided.
         metrics : list[Union[Metric, dict[str, Any]]]
             List of metrics to use for the acceptance test.
         name : Optional[str], default=None

nextmv/cloud/application/_input_set.py

@@ -6,6 +6,7 @@ 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
@@ -16,6 +17,32 @@ 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.
@@ -81,8 +108,8 @@ class ApplicationInputSetMixin:
 
     def new_input_set(
         self: "Application",
-        id: str,
-        name: str,
+        id: str | None = None,
+        name: str | None = None,
         description: str | None = None,
         end_time: datetime | None = None,
         instance_id: str | None = None,
@@ -107,10 +134,11 @@ class ApplicationInputSetMixin:
 
         Parameters
         ----------
-        id: str
-            ID of the input set
-        name: str
-            Name of the input set.
+        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.
         description: Optional[str]
             Optional description of the input set.
         end_time: Optional[datetime]
@@ -145,6 +173,14 @@ 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,