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

nextmv/cli/configuration/create.py

@@ -14,7 +14,7 @@ from nextmv.cli.configuration.config import (
     obscure_api_key,
     save_config,
 )
-from nextmv.cli.message import error, message, success
+from nextmv.cli.message import error, info, success
 
 # Set up subcommand application.
 app = typer.Typer()
@@ -58,14 +58,14 @@ def create(
     [bold][underline]Examples[/underline][/bold]
 
     - Default configuration.
-        $ [dim]nextmv configuration create --api-key NEXTMV_API_KEY[/dim]
+        $ [green]nextmv configuration create --api-key NEXTMV_API_KEY[/green]
 
     - Configure a profile named [magenta]hare[/magenta].
-        $ [dim]nextmv configuration create --api-key NEXTMV_API_KEY --profile hare[/dim]
+        $ [green]nextmv configuration create --api-key NEXTMV_API_KEY --profile hare[/green]
     """
 
     if profile is not None and profile.strip().lower() == "default":
-        error("[magenta]default[/magenta] is a reserved profile name.")
+        error("[code]default[/code] is a reserved profile name.")
 
     endpoint = str(endpoint)
     if endpoint.startswith("https://"):
@@ -88,7 +88,7 @@ def create(
     save_config(config)
 
     success("Configuration saved successfully.")
-    message(f"\t[bold]Profile[/bold]: [magenta]{profile or 'Default'}[/magenta]")
-    message(f"\t[bold]API Key[/bold]: [magenta]{obscure_api_key(api_key)}[/magenta]")
+    info(f"\t[bold]Profile[/bold]: {profile or 'Default'}")
+    info(f"\t[bold]API Key[/bold]: {obscure_api_key(api_key)}")
     if endpoint != DEFAULT_ENDPOINT:
-        message(f"\t[bold]Endpoint[/bold]: [magenta]{endpoint}[/magenta]")
+        info(f"\t[bold]Endpoint[/bold]: {endpoint}")

nextmv/cli/configuration/delete.py

@@ -5,9 +5,9 @@ This module defines the configuration delete command for the Nextmv CLI.
 from typing import Annotated
 
 import typer
+from rich.prompt import Confirm
 
 from nextmv.cli.configuration.config import load_config, save_config
-from nextmv.cli.confirm import get_confirmation
 from nextmv.cli.message import error, info, success
 
 # Set up subcommand application.
@@ -36,29 +36,29 @@ def delete(
     ] = False,
 ) -> None:
     """
-    Delete a profile from the configuration.
-
-    Use the --yes flag to skip the confirmation prompt.
+    Delete a profile from the configuration. Use the [code]--yes[/code]
+    flag to skip the confirmation prompt.
 
     [bold][underline]Examples[/underline][/bold]
 
     - Delete a profile named [magenta]hare[/magenta].
-        $ [dim]nextmv configuration delete --profile hare[/dim]
+        $ [green]nextmv configuration delete --profile hare[/green]
 
     - Delete a profile named [magenta]hare[/magenta] without confirmation prompt.
-        $ [dim]nextmv configuration delete --profile hare --yes[/dim]
+        $ [green]nextmv configuration delete --profile hare --yes[/green]
     """
     config = load_config()
     if profile not in config:
         error(f"Profile [magenta]{profile}[/magenta] does not exist.")
 
     if not yes:
-        confirm = get_confirmation(
+        confirm = Confirm.ask(
             f"Are you sure you want to delete profile [magenta]{profile}[/magenta]? This action cannot be undone.",
+            default=False,
         )
 
         if not confirm:
-            info(f"Profile [magenta]{profile}[/magenta] will not be deleted.")
+            info(msg=f"Profile [magenta]{profile}[/magenta] will not be deleted.", emoji=":bulb:")
             return
 
     del config[profile]

nextmv/cli/configuration/list.py

@@ -6,7 +6,7 @@ import typer
 from rich.console import Console
 from rich.table import Table
 
-from nextmv.cli.configuration.config import API_KEY_KEY, ENDPOINT_KEY, load_config, non_profile_keys, obscure_api_key
+from nextmv.cli.configuration.config import API_KEY_KEY, ENDPOINT_KEY, load_config, obscure_api_key
 from nextmv.cli.message import error
 
 # Set up subcommand application.
@@ -22,7 +22,7 @@ def list() -> None:
     [bold][underline]Examples[/underline][/bold]
 
     - Show current configuration and all profiles.
-        $ [dim]nextmv configuration list[/dim]
+        $ [green]nextmv configuration list[/green]
     """
 
     config = load_config()
@@ -38,7 +38,7 @@ def list() -> None:
 
     for k, v in config.items():
         # Skip default configuration.
-        if k in non_profile_keys():
+        if k in {API_KEY_KEY, ENDPOINT_KEY}:
             continue
 
         profile = {

nextmv/cli/main.py

@@ -13,25 +13,22 @@ about the features used here. An example of Rich markup can be found in the
 epilog of the Typer application defined below.
 """
 
+import os
 import sys
 from typing import Annotated
 
 import rich
 import typer
-from typer import rich_utils
+from rich.prompt import Confirm
 
 from nextmv.cli.cloud import app as cloud_app
 from nextmv.cli.community import app as community_app
 from nextmv.cli.configuration import app as configuration_app
 from nextmv.cli.configuration.config import CONFIG_DIR, GO_CLI_PATH, load_config
-from nextmv.cli.confirm import get_confirmation
 from nextmv.cli.message import error, info, success, warning
 from nextmv.cli.version import app as version_app
 from nextmv.cli.version import version_callback
 
-# Disable dim text for the extended help of commands.
-rich_utils.STYLE_HELPTEXT = ""
-
 # Main CLI application.
 app = typer.Typer(
     help="The Nextmv Command Line Interface (CLI).",
@@ -69,15 +66,6 @@ def callback(
     environment.
     """
 
-    # Skip checks for help commands.
-    if "--help" in sys.argv or "-h" in sys.argv:
-        return
-
-    # Skip checks for certain commands.
-    ignored_commands = {"configuration", "version"}
-    if ctx.invoked_subcommand in ignored_commands:
-        return
-
     handle_go_cli()
     handle_config_existence(ctx)
 
@@ -92,20 +80,19 @@ def handle_go_cli() -> None:
 
     exists = go_cli_exists()
     if exists:
-        delete = get_confirmation(
+        delete = Confirm.ask(
             "Do you want to delete the [italic red]deprecated[/italic red] Nextmv CLI "
-            f"at [magenta]{GO_CLI_PATH}[/magenta] now?"
+            f"at [magenta]{GO_CLI_PATH}[/magenta] now?",
+            default=False,
         )
         if delete:
             remove_go_cli()
-            return
-
-        info(
-            "You can delete the [italic red]deprecated[/italic red] Nextmv CLI later by removing "
-            f"[magenta]{GO_CLI_PATH}[/magenta]. "
-            "Make sure you also clean up your [code]PATH[/code], "
-            f"by removing references to [magenta]{CONFIG_DIR}[/magenta] from it."
-        )
+        else:
+            info(
+                msg="You can delete the [italic red]deprecated[/italic red] Nextmv CLI later by removing "
+                f"[magenta]{GO_CLI_PATH}[/magenta]. Make sure you also clean up your [code]PATH[/code].",
+                emoji=":bulb:",
+            )
 
 
 def handle_config_existence(ctx: typer.Context) -> None:
@@ -118,6 +105,10 @@ def handle_config_existence(ctx: typer.Context) -> None:
         The Typer context object.
     """
 
+    ignored_commands = {"configuration", "version"}
+    if ctx.invoked_subcommand in ignored_commands:
+        return
+
     config = load_config()
     if config == {}:
         error("No configuration found. Please run [code]nextmv configuration create[/code].")
@@ -139,9 +130,11 @@ def go_cli_exists() -> bool:
     if exists:
         warning(
             "A [italic red]deprecated[/italic red] Nextmv CLI is installed at "
-            f"[magenta]{GO_CLI_PATH}[/magenta]. You should delete it to avoid conflicts."
+            f"[magenta]{GO_CLI_PATH}[/magenta]. You must delete it to avoid conflicts."
         )
 
+    check_config_in_path()
+
     return exists
 
 
@@ -152,7 +145,24 @@ def remove_go_cli() -> None:
 
     if GO_CLI_PATH.exists():
         GO_CLI_PATH.unlink()
-        success(f"Deleted [italic red]deprecated[/italic red] [magenta]{GO_CLI_PATH}[/magenta].")
+        success(f"Deleted deprecated [magenta]{GO_CLI_PATH}[/magenta].")
+
+    check_config_in_path()
+
+
+def check_config_in_path() -> None:
+    """
+    Check if the configuration directory is in the PATH and notify the user.
+    """
+
+    path_dirs = os.environ.get("PATH", "").split(os.pathsep)
+    config_dir_str = str(CONFIG_DIR)
+
+    if config_dir_str in path_dirs:
+        warning(
+            f"[magenta]{CONFIG_DIR}[/magenta] was found in your [code]PATH[/code]. "
+            f"You should remove any entries related to [magenta]{CONFIG_DIR}[/magenta] from your [code]PATH[/code]."
+        )
 
 
 def main() -> None:

nextmv/cli/message.py

@@ -11,107 +11,106 @@ import rich
 import typer
 
 
-def message(msg: str, emoji: str | None = None) -> None:
+def error(msg: str) -> None:
     """
-    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.
+    Pretty-print an error message and exit with code 1. Your message should end
+    with a period.
 
     Parameters
     ----------
     msg : str
-        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:`.
+        The error message to display.
+
+    Raises
+    ------
+    typer.Exit
+        Exits the program with code 1.
     """
 
-    msg = _format(msg)
-    if emoji:
-        rich.print(f"{emoji} {msg}", file=sys.stderr)
-        return
+    msg = msg.rstrip("\n")
+    if not msg.endswith("."):
+        msg += "."
 
-    rich.print(msg, file=sys.stderr)
+    rich.print(f"[red]Error:[/red] {msg}", file=sys.stderr)
+
+    raise typer.Exit(code=1)
 
 
-def info(msg: str) -> None:
+def success(msg: str) -> None:
     """
-    Pretty-print an informational message. Your message should end with a
-    period.
+    Pretty-print a success message. Your message should end with a period.
 
     Parameters
     ----------
     msg : str
-        The informational message to display.
+        The success message to display.
     """
 
-    message(msg, emoji=":bulb:")
+    msg = msg.rstrip("\n")
+    if not msg.endswith("."):
+        msg += "."
 
+    rich.print(f":white_check_mark: {msg}", file=sys.stderr)
 
-def in_progress(msg: str) -> None:
+
+def warning(msg: str) -> None:
     """
-    Pretty-print an in-progress message with an hourglass emoji. Your message
-    should end with a period.
+    Pretty-print a warning message. Your message should end with a period.
 
     Parameters
     ----------
     msg : str
-        The in-progress message to display.
+        The warning message to display.
     """
 
-    message(msg, emoji=":hourglass_flowing_sand:")
+    msg = msg.rstrip("\n")
+    if not msg.endswith("."):
+        msg += "."
 
+    rich.print(f":construction: {msg}", file=sys.stderr)
 
-def success(msg: str) -> None:
+
+def info(msg: str, emoji: str | None = None) -> 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. 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 success message to display.
+        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:`.
     """
 
-    message(msg, emoji=":white_check_mark:")
-
-
-def warning(msg: str) -> None:
-    """
-    Pretty-print a warning message. Your message should end with a period.
+    msg = msg.rstrip("\n")
+    if not msg.endswith("."):
+        msg += "."
 
-    Parameters
-    ----------
-    msg : str
-        The warning message to display.
-    """
+    if emoji:
+        rich.print(f"{emoji} {msg}", file=sys.stderr)
+        return
 
-    msg = _format(msg)
-    rich.print(f":construction: [yellow] Warning:[/yellow] {msg}", file=sys.stderr)
+    rich.print(msg, file=sys.stderr)
 
 
-def error(msg: str) -> None:
+def in_progress(msg: str) -> None:
     """
-    Pretty-print an error message and exit with code 1. 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 error message to display.
-
-    Raises
-    ------
-    typer.Exit
-        Exits the program with code 1.
+        The in-progress message to display.
     """
 
-    msg = _format(msg)
-    rich.print(f":x: [red]Error:[/red] {msg}", file=sys.stderr)
-
-    raise typer.Exit(code=1)
+    info(msg, emoji=":hourglass_flowing_sand:")
 
 
 def print_json(data: dict[str, Any] | list[dict[str, Any]]) -> None:
@@ -152,19 +151,3 @@ 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/cli/options.py

@@ -190,31 +190,3 @@ SecretsCollectionIDOption = Annotated[
         metavar="SECRETS_COLLECTION_ID",
     ),
 ]
-
-# shadow_test_id option - can be used in any command that requires a shadow test ID.
-# Define it as follows in commands or callbacks, as necessary:
-# shadow_test_id: ShadowTestIDOption
-ShadowTestIDOption = Annotated[
-    str,
-    typer.Option(
-        "--shadow-test-id",
-        "-s",
-        help="The Nextmv Cloud shadow test ID to use for this action.",
-        envvar="NEXTMV_SHADOW_TEST_ID",
-        metavar="SHADOW_TEST_ID",
-    ),
-]
-
-# switchback_test_id option - can be used in any command that requires a switchback test ID.
-# Define it as follows in commands or callbacks, as necessary:
-# switchback_test_id: SwitchbackTestIDOption
-SwitchbackTestIDOption = Annotated[
-    str,
-    typer.Option(
-        "--switchback-test-id",
-        "-s",
-        help="The Nextmv Cloud switchback test ID to use for this action.",
-        envvar="NEXTMV_SWITCHBACK_TEST_ID",
-        metavar="SWITCHBACK_TEST_ID",
-    ),
-]

nextmv/cli/version.py

@@ -18,7 +18,7 @@ def version() -> None:
     [bold][underline]Examples[/underline][/bold]
 
     - Show the version.
-        $ [dim]nextmv version[/dim]
+        $ [green]nextmv version[/green]
     """
 
     version_callback(True)

nextmv/cloud/__init__.py

@@ -1,5 +1,42 @@
 """Functionality for interacting with the Nextmv Cloud."""
 
+# These imports are kept for backwards compatibility but the preferred import path is
+# from nextmv directly. These imports will be removed in a future release.
+from nextmv.manifest import MANIFEST_FILE_NAME as MANIFEST_FILE_NAME
+from nextmv.manifest import Manifest as Manifest
+from nextmv.manifest import ManifestBuild as ManifestBuild
+from nextmv.manifest import ManifestContent as ManifestContent
+from nextmv.manifest import ManifestContentMultiFile as ManifestContentMultiFile
+from nextmv.manifest import ManifestContentMultiFileInput as ManifestContentMultiFileInput
+from nextmv.manifest import ManifestContentMultiFileOutput as ManifestContentMultiFileOutput
+from nextmv.manifest import ManifestOption as ManifestOption
+from nextmv.manifest import ManifestPython as ManifestPython
+from nextmv.manifest import ManifestPythonModel as ManifestPythonModel
+from nextmv.manifest import ManifestRuntime as ManifestRuntime
+from nextmv.manifest import ManifestType as ManifestType
+from nextmv.polling import PollingOptions as PollingOptions
+from nextmv.polling import poll as poll
+from nextmv.run import ErrorLog as ErrorLog
+from nextmv.run import ExternalRunResult as ExternalRunResult
+from nextmv.run import Format as Format
+from nextmv.run import FormatInput as FormatInput
+from nextmv.run import FormatOutput as FormatOutput
+from nextmv.run import Metadata as Metadata
+from nextmv.run import RunConfiguration as RunConfiguration
+from nextmv.run import RunInformation as RunInformation
+from nextmv.run import RunLog as RunLog
+from nextmv.run import RunQueuing as RunQueuing
+from nextmv.run import RunResult as RunResult
+from nextmv.run import RunType as RunType
+from nextmv.run import RunTypeConfiguration as RunTypeConfiguration
+from nextmv.run import TrackedRun as TrackedRun
+from nextmv.run import TrackedRunStatus as TrackedRunStatus
+from nextmv.run import run_duration as run_duration
+from nextmv.safe import safe_id as safe_id
+from nextmv.safe import safe_name_and_id as safe_name_and_id
+from nextmv.status import Status as Status
+from nextmv.status import StatusV2 as StatusV2
+
 from .acceptance_test import AcceptanceTest as AcceptanceTest
 from .acceptance_test import AcceptanceTestResults as AcceptanceTestResults
 from .acceptance_test import Comparison as Comparison
@@ -15,6 +52,7 @@ from .acceptance_test import MetricToleranceType as MetricToleranceType
 from .acceptance_test import MetricType as MetricType
 from .acceptance_test import ResultStatistics as ResultStatistics
 from .acceptance_test import StatisticType as StatisticType
+from .acceptance_test import ToleranceType as ToleranceType
 from .account import Account as Account
 from .account import AccountMember as AccountMember
 from .account import Queue as Queue
@@ -30,9 +68,6 @@ 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,17 +90,6 @@ from .secrets import Secret as Secret
 from .secrets import SecretsCollection as SecretsCollection
 from .secrets import SecretsCollectionSummary as SecretsCollectionSummary
 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 .switchback import SwitchbackPlan as SwitchbackPlan
-from .switchback import SwitchbackPlanUnit as SwitchbackPlanUnit
-from .switchback import SwitchbackTest as SwitchbackTest
-from .switchback import SwitchbackTestMetadata as SwitchbackTestMetadata
-from .switchback import TestComparisonSingle as TestComparisonSingle
 from .url import DownloadURL as DownloadURL
 from .url import UploadURL as UploadURL
 from .version import Version as Version

nextmv/cloud/acceptance_test.py

@@ -13,7 +13,7 @@ StatisticType : Enum
     Type of statistical process for collapsing multiple values of a metric.
 Comparison : Enum
     Comparison operators to use for comparing two metrics.
-MetricToleranceType : Enum
+ToleranceType : Enum
     Type of tolerance used for a metric.
 ExperimentStatus : Enum
     Status of an acceptance test experiment.
@@ -46,6 +46,7 @@ from enum import Enum
 
 from nextmv.base_model import BaseModel
 from nextmv.cloud.batch_experiment import ExperimentStatus
+from nextmv.deprecated import deprecated
 
 
 class MetricType(str, Enum):
@@ -211,6 +212,69 @@ class Comparison(str, Enum):
     """Not equal to metric type."""
 
 
+class ToleranceType(str, Enum):
+    """
+    !!! warning
+        `ToleranceType` is deprecated, use `MetricToleranceType` instead.
+
+    Type of tolerance used for a metric.
+
+    You can import the `ToleranceType` class directly from `cloud`:
+
+    ```python
+    from nextmv.cloud import ToleranceType
+    ```
+
+    This enumeration defines the different types of tolerances that can be used
+    when comparing metrics in acceptance tests.
+
+    Attributes
+    ----------
+    undefined : str
+        Undefined tolerance type (empty string).
+    absolute : str
+        Absolute tolerance type, using a fixed value.
+    relative : str
+        Relative tolerance type, using a percentage.
+
+    Examples
+    --------
+    >>> from nextmv.cloud import ToleranceType
+    >>> tol_type = ToleranceType.absolute
+    >>> tol_type
+    <ToleranceType.absolute: 'absolute'>
+    """
+
+    undefined = ""
+    """ToleranceType is deprecated, please use MetricToleranceType instead.
+    Undefined tolerance type."""
+    absolute = "absolute"
+    """ToleranceType is deprecated, please use MetricToleranceType instead.
+    Absolute tolerance type."""
+    relative = "relative"
+    """ToleranceType is deprecated, please use MetricToleranceType instead.
+    Relative tolerance type."""
+
+
+# Override __getattribute__ to emit deprecation warnings when enum values are accessed
+_original_getattribute = ToleranceType.__class__.__getattribute__
+
+
+def _deprecated_getattribute(cls, name: str):
+    # Only emit deprecation warning if this is specifically the ToleranceType class
+    if cls is ToleranceType and name in ("undefined", "absolute", "relative"):
+        deprecated(
+            f"ToleranceType.{name}",
+            "ToleranceType is deprecated and will be removed in a future version. "
+            "Please use MetricToleranceType instead",
+        )
+
+    return _original_getattribute(cls, name)
+
+
+ToleranceType.__class__.__getattribute__ = _deprecated_getattribute
+
+
 class MetricToleranceType(str, Enum):
     """
     Type of tolerance used for a metric.

nextmv/cloud/account.py

@@ -21,7 +21,7 @@ from pydantic import AliasChoices, Field
 
 from nextmv.base_model import BaseModel
 from nextmv.cloud.client import Client
-from nextmv.status import StatusV2
+from nextmv.status import Status, StatusV2
 
 
 class QueuedRun(BaseModel):
@@ -57,6 +57,8 @@ class QueuedRun(BaseModel):
         ID of the application version used for the run.
     execution_class : str
         Execution class used for the run.
+    status : Status
+        Deprecated: use status_v2.
     status_v2 : StatusV2
         Status of the run.
 
@@ -72,6 +74,7 @@ class QueuedRun(BaseModel):
     ...     "application_instance_id": "appins-123456",
     ...     "application_version_id": "appver-123456",
     ...     "execution_class": "standard",
+    ...     "status": "RUNNING",
     ...     "status_v2": "RUNNING"
     ... })
     >>> print(queued_run.name)
@@ -96,6 +99,8 @@ class QueuedRun(BaseModel):
     """ID of the application version used for the run."""
     execution_class: str
     """Execution class used for the run."""
+    status: Status
+    """Deprecated: use status_v2."""
     status_v2: StatusV2
     """Status of the run."""