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

nextmv/cli/configuration/config.py

@@ -7,7 +7,10 @@ from typing import Any
 
 import yaml
 
-from nextmv.cli.error import error
+from nextmv.cli.confirm import get_confirmation
+from nextmv.cli.message import error, success, warning
+from nextmv.cloud.account import Account
+from nextmv.cloud.application import Application
 from nextmv.cloud.client import Client
 
 # Some useful constants.
@@ -57,6 +60,18 @@ def save_config(config: dict[str, Any]) -> None:
         yaml.safe_dump(config, file)
 
 
+def non_profile_keys() -> set[str]:
+    """
+    Returns the set of keys that are not profile names in the configuration.
+
+    Returns
+    -------
+    set[str]
+        The set of non-profile keys.
+    """
+    return {API_KEY_KEY, ENDPOINT_KEY}
+
+
 def build_client(profile: str | None = None) -> Client:
     """
     Builds a `cloud.Client` using the API key and endpoint for the given
@@ -89,27 +104,109 @@ def build_client(profile: str | None = None) -> Client:
 
     if profile is not None:
         if profile not in config:
-            error(f"Profile [bold magenta]{profile}[/bold magenta] does not exist.")
+            error(
+                f"Profile [magenta]{profile}[/magenta] does not exist. "
+                "Create it using [code]nextmv configuration create[/code] with the --profile option."
+            )
 
         api_key = config[profile].get(API_KEY_KEY)
         if api_key is None or api_key == "":
-            error(f"API key for profile [bold magenta]{profile}[/bold magenta] is not set or is empty.")
+            error(
+                f"API key for profile [magenta]{profile}[/magenta] is not set or is empty. "
+                "Set it using [code]nextmv configuration create[/code] with the --profile and --api-key options."
+            )
 
         endpoint = config[profile].get(ENDPOINT_KEY)
         if endpoint is None or endpoint == "":
-            error(f"Endpoint for profile [bold magenta]{profile}[/bold magenta] is not set or is empty.")
+            error(
+                f"Endpoint for profile [magenta]{profile}[/magenta] is not set or is empty. "
+                "Please run [code]nextmv configuration create[/code]."
+            )
     else:
         api_key = config.get(API_KEY_KEY)
         if api_key is None or api_key == "":
-            error("Default API key is not set or is empty.")
+            error(
+                "Default API key is not set or is empty. "
+                "Please run [code]nextmv configuration create[/code] with the --api-key option."
+            )
 
         endpoint = config.get(ENDPOINT_KEY)
         if endpoint is None or endpoint == "":
-            error("Default endpoint is not set or is empty.")
+            error("Default endpoint is not set or is empty. Please run [code]nextmv configuration create[/code].")
 
     return Client(api_key=api_key, url=f"https://{endpoint}")
 
 
+def build_app(app_id: str, profile: str | None = None) -> Application:
+    """
+    Builds a `cloud.Application` using the given application ID and the API
+    key and endpoint for the given profile. If no profile is given, the default
+    profile is used. If the application does not exist, an exception is raised.
+
+    Parameters
+    ----------
+    app_id : str
+        The application ID.
+    profile : str | None
+        The profile name to use. If None, the default profile is used.
+
+    Returns
+    -------
+    Application
+        An application object for the given application ID.
+
+    Raises
+    ------
+    typer.Exit
+        If the application does not exist.
+    """
+    client = build_client(profile)
+    exists = Application.exists(client=client, id=app_id)
+    if exists:
+        return Application(client=client, id=app_id)
+
+    warning(f"Application with ID [magenta]{app_id}[/magenta] does not exist.")
+    should_create = get_confirmation(f"Do you want to create a new application with ID [magenta]{app_id}[/magenta]?")
+    if not should_create:
+        error(
+            f"Application with ID [magenta]{app_id}[/magenta] was not created and does not exist. "
+            "Use [code]nextmv cloud app create[/code] to create a new app."
+        )
+
+    app = Application.new(client=client, id=app_id, name=app_id)
+    success(f"Application with ID and name [magenta]{app_id}[/magenta] created successfully.")
+
+    return app
+
+
+def build_account(account_id: str | None = None, profile: str | None = None) -> Account:
+    """
+    Builds a `cloud.Account` using the API key and endpoint for the given
+    profile. If no profile is given, the default profile is used.
+
+    Parameters
+    ----------
+    account_id : str | None
+        The account ID. If None, no account ID is set.
+    profile : str | None
+        The profile name to use. If None, the default profile is used.
+
+    Returns
+    -------
+    Account
+        An account object for the configured profile.
+
+    Raises
+    ------
+    typer.Exit
+        If the configuration is invalid or missing.
+    """
+
+    client = build_client(profile)
+
+    return Account(account_id=account_id, client=client)
+
+
 def obscure_api_key(api_key: str) -> str:
     """
     Obscure an API key for display purposes.

nextmv/cli/configuration/create.py

@@ -4,7 +4,6 @@ This module defines the configuration create command for the Nextmv CLI.
 
 from typing import Annotated
 
-import rich
 import typer
 
 from nextmv.cli.configuration.config import (
@@ -15,7 +14,7 @@ from nextmv.cli.configuration.config import (
     obscure_api_key,
     save_config,
 )
-from nextmv.cli.error import error
+from nextmv.cli.message import error, message, success
 
 # Set up subcommand application.
 app = typer.Typer()
@@ -34,6 +33,14 @@ def create(
             metavar="NEXTMV_API_KEY",
         ),
     ],
+    endpoint: Annotated[  # Hidden because it is meant for internal use.
+        str | None,
+        typer.Option(
+            "--endpoint",
+            "-e",
+            hidden=True,
+        ),
+    ] = DEFAULT_ENDPOINT,
     profile: Annotated[  # Similar to nextmv.cli.options.ProfileOption but with different help text.
         str | None,
         typer.Option(
@@ -44,14 +51,6 @@ def create(
             metavar="PROFILE_NAME",
         ),
     ] = None,
-    endpoint: Annotated[  # Hidden because it is meant for internal use.
-        str | None,
-        typer.Option(
-            "--endpoint",
-            "-e",
-            hidden=True,
-        ),
-    ] = DEFAULT_ENDPOINT,
 ) -> None:
     """
     Create a new configuration or update an existing one.
@@ -59,14 +58,14 @@ def create(
     [bold][underline]Examples[/underline][/bold]
 
     - Default configuration.
-        $ [green]nextmv configuration create --api-key NEXTMV_API_KEY[/green]
+        $ [dim]nextmv configuration create --api-key NEXTMV_API_KEY[/dim]
 
-    - Configure a profile named [italic]hare[/italic].
-        $ [green]nextmv configuration create --api-key NEXTMV_API_KEY --profile hare[/green]
+    - Configure a profile named [magenta]hare[/magenta].
+        $ [dim]nextmv configuration create --api-key NEXTMV_API_KEY --profile hare[/dim]
     """
 
     if profile is not None and profile.strip().lower() == "default":
-        error("[code]default[/code] is a reserved profile name.")
+        error("[magenta]default[/magenta] is a reserved profile name.")
 
     endpoint = str(endpoint)
     if endpoint.startswith("https://"):
@@ -88,8 +87,8 @@ def create(
 
     save_config(config)
 
-    rich.print(":white_check_mark: Configuration saved successfully.")
-    rich.print(f"\t[bold]Profile[/bold]: {profile or 'Default'}")
-    rich.print(f"\t[bold]API Key[/bold]: {obscure_api_key(api_key)}")
+    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]")
     if endpoint != DEFAULT_ENDPOINT:
-        rich.print(f"\t[bold]Endpoint[/bold]: {endpoint}")
+        message(f"\t[bold]Endpoint[/bold]: [magenta]{endpoint}[/magenta]")

nextmv/cli/configuration/delete.py

@@ -4,12 +4,11 @@ This module defines the configuration delete command for the Nextmv CLI.
 
 from typing import Annotated
 
-import rich
 import typer
-from rich.prompt import Confirm
 
 from nextmv.cli.configuration.config import load_config, save_config
-from nextmv.cli.error import error
+from nextmv.cli.confirm import get_confirmation
+from nextmv.cli.message import error, info, success
 
 # Set up subcommand application.
 app = typer.Typer()
@@ -27,29 +26,42 @@ def delete(
             metavar="PROFILE_NAME",
         ),
     ],
+    yes: Annotated[
+        bool,
+        typer.Option(
+            "--yes",
+            "-y",
+            help="Agree to deletion confirmation prompt. Useful for non-interactive sessions.",
+        ),
+    ] = False,
 ) -> None:
     """
     Delete a profile from the configuration.
 
+    Use the --yes flag to skip the confirmation prompt.
+
     [bold][underline]Examples[/underline][/bold]
 
     - Delete a profile named [magenta]hare[/magenta].
-        $ [green]nextmv configuration delete --profile hare[/green]
+        $ [dim]nextmv configuration delete --profile hare[/dim]
+
+    - Delete a profile named [magenta]hare[/magenta] without confirmation prompt.
+        $ [dim]nextmv configuration delete --profile hare --yes[/dim]
     """
     config = load_config()
     if profile not in config:
-        error(f"Profile [bold magenta]{profile}[/bold magenta] does not exist.")
+        error(f"Profile [magenta]{profile}[/magenta] does not exist.")
 
-    confirm = Confirm.ask(
-        f"Are you sure you want to delete profile [bold magenta]{profile}[/bold magenta]? This action cannot be undone",
-        default=False,
-    )
+    if not yes:
+        confirm = get_confirmation(
+            f"Are you sure you want to delete profile [magenta]{profile}[/magenta]? This action cannot be undone.",
+        )
 
-    if not confirm:
-        rich.print(f":bulb: Profile [bold magenta]{profile}[/bold magenta] will not be deleted.")
-        return
+        if not confirm:
+            info(f"Profile [magenta]{profile}[/magenta] will not be deleted.")
+            return
 
     del config[profile]
     save_config(config)
 
-    rich.print(f":white_check_mark: Profile [bold magenta]{profile}[/bold magenta] deleted successfully.")
+    success(f"Profile [magenta]{profile}[/magenta] deleted successfully.")

nextmv/cli/configuration/list.py

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

nextmv/cli/confirm.py

@@ -0,0 +1,34 @@
+import sys
+
+from rich.prompt import Confirm
+
+
+def get_confirmation(msg: str, default: bool = False) -> bool:
+    """
+    Method to get a yes/no confirmation from the user.
+
+    Parameters
+    ----------
+    msg : str
+        The message to display to the user.
+    default : bool, optional
+        The default value if the user just presses Enter. Default is False.
+
+    Returns
+    -------
+    bool
+        True if the user confirmed, False otherwise.
+    """
+
+    # If this is not an interactive terminal, do not ask for confirmation, to
+    # avoid hanging indefinitely waiting for a user response.
+    if not sys.stdin.isatty():
+        return default
+
+    return Confirm.ask(
+        msg,
+        default=default,
+        case_sensitive=False,
+        show_default=True,
+        show_choices=True,
+    )

nextmv/cli/main.py

@@ -13,17 +13,24 @@ 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 rich.prompt import Confirm
+from typer import rich_utils
 
-from nextmv.cli.community.community import app as community_app
+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.configuration.configuration import app as configuration_app
-from nextmv.cli.error import error
+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(
@@ -32,22 +39,45 @@ app = typer.Typer(
     rich_markup_mode="rich",
     context_settings={"help_option_names": ["--help", "-h"]},
     no_args_is_help=True,
+    invoke_without_command=True,
+    pretty_exceptions_show_locals=False,
 )
 
 # Register subcommands. The `name` parameter is required when the subcommand
 # module has a callback function defined.
+app.add_typer(cloud_app, name="cloud")
 app.add_typer(community_app, name="community")
 app.add_typer(configuration_app, name="configuration")
 app.add_typer(version_app)
 
 
 @app.callback()
-def callback(ctx: typer.Context) -> None:
+def callback(
+    ctx: typer.Context,
+    version: Annotated[
+        bool | None,
+        typer.Option(
+            "--version",
+            "-v",
+            help="Show the current version of the Nextmv CLI.",
+            callback=version_callback,
+        ),
+    ] = None,
+) -> None:
     """
     Callback function that runs before any command. Useful for checks on the
     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)
 
@@ -62,18 +92,20 @@ def handle_go_cli() -> None:
 
     exists = go_cli_exists()
     if exists:
-        delete = Confirm.ask(
+        delete = get_confirmation(
             "Do you want to delete the [italic red]deprecated[/italic red] Nextmv CLI "
-            f"at [italic]{GO_CLI_PATH}[/italic] now?",
-            default=True,
+            f"at [magenta]{GO_CLI_PATH}[/magenta] now?"
         )
         if delete:
             remove_go_cli()
-        else:
-            rich.print(
-                ":bulb: You can delete the [italic red]deprecated[/italic red] Nextmv CLI "
-                f"later by removing [italic]{GO_CLI_PATH}[/italic]. Make sure you also clean up your [code]PATH[/code]."
-            )
+            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."
+        )
 
 
 def handle_config_existence(ctx: typer.Context) -> None:
@@ -86,10 +118,6 @@ 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].")
@@ -109,13 +137,11 @@ def go_cli_exists() -> bool:
     # Check if the Go CLI executable exists
     exists = GO_CLI_PATH.exists()
     if exists:
-        rich.print(
-            ":construction: A [italic red]deprecated[/italic red] Nextmv CLI is installed at "
-            f"[italic]{GO_CLI_PATH}[/italic]. You must delete it to avoid conflicts."
+        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."
         )
 
-    check_config_in_path()
-
     return exists
 
 
@@ -126,21 +152,27 @@ def remove_go_cli() -> None:
 
     if GO_CLI_PATH.exists():
         GO_CLI_PATH.unlink()
-        rich.print(f":white_check_mark: Deleted deprecated {GO_CLI_PATH}.")
+        success(f"Deleted [italic red]deprecated[/italic red] [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.
+def main() -> None:
     """
+    Entry point for the CLI with global exception handling.
 
-    path_dirs = os.environ.get("PATH", "").split(os.pathsep)
-    config_dir_str = str(CONFIG_DIR)
+    Catches all exceptions except Typer/Click exceptions (which handle their
+    own exit codes) and displays a clean error message instead of a traceback.
+    """
 
-    if config_dir_str in path_dirs:
-        rich.print(
-            f":construction: [italic]{CONFIG_DIR}[/italic] was found in your [code]PATH[/code]. "
-            f"You should remove any entries related to [italic]{CONFIG_DIR}[/italic] from your [code]PATH[/code]."
-        )
+    try:
+        app()
+    except (typer.Exit, typer.Abort, SystemExit):
+        raise
+    except Exception as e:
+        # We do not use the messages.error function here because doing so would
+        # raise a Typer exception, which would print a traceback.
+        msg = str(e).rstrip("\n")
+        if not msg.endswith("."):
+            msg += "."
+
+        rich.print(f"[red]Error:[/red] {msg}", file=sys.stderr)
+        sys.exit(1)