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

nextmv/cli/community/clone.py

@@ -13,7 +13,7 @@ import rich
 import typer
 
 from nextmv.cli.community.list import download_file, download_manifest, find_app, versions_table
-from nextmv.cli.error import error
+from nextmv.cli.message import error, success
 from nextmv.cli.options import ProfileOption
 
 # Set up subcommand application.
@@ -134,8 +134,8 @@ def clone(
     # Remove the tarball after extraction
     os.remove(downloaded_object)
 
-    rich.print(
-        f":white_check_mark: Successfully cloned the [magenta]{app}[/magenta] community app, "
+    success(
+        f"Successfully cloned the [magenta]{app}[/magenta] community app, "
         f"using version [magenta]{original_version}[/magenta] in path: [magenta]{full_destination}[/magenta]."
     )
 

nextmv/cli/community/list.py

@@ -12,7 +12,7 @@ from rich.console import Console
 from rich.table import Table
 
 from nextmv.cli.configuration.config import build_client
-from nextmv.cli.error import error
+from nextmv.cli.message import error
 from nextmv.cli.options import ProfileOption
 
 # Set up subcommand application.

nextmv/cli/configuration/__init__.py

@@ -0,0 +1,23 @@
+"""
+This module defines the configuration command tree for the Nextmv CLI.
+"""
+
+import typer
+
+from nextmv.cli.configuration.create import app as create_app
+from nextmv.cli.configuration.delete import app as delete_app
+from nextmv.cli.configuration.list import app as list_app
+
+# Set up subcommand application.
+app = typer.Typer()
+app.add_typer(create_app)
+app.add_typer(delete_app)
+app.add_typer(list_app)
+
+
+@app.callback()
+def callback() -> None:
+    """
+    Configure the CLI and manage profiles.
+    """
+    pass

nextmv/cli/configuration/config.py

@@ -7,7 +7,9 @@ from typing import Any
 
 import yaml
 
-from nextmv.cli.error import error
+from nextmv.cli.message import error
+from nextmv.cloud.account import Account
+from nextmv.cloud.application import Application
 from nextmv.cloud.client import Client
 
 # Some useful constants.
@@ -89,15 +91,15 @@ 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.")
 
         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.")
 
         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.")
     else:
         api_key = config.get(API_KEY_KEY)
         if api_key is None or api_key == "":
@@ -110,6 +112,68 @@ def build_client(profile: str | None = None) -> Client:
     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 not exists:
+        error(
+            f"Application with ID [magenta]{app_id}[/magenta] does not exist. "
+            "Use [code]nextmv cloud app create[/code] to create a new application."
+        )
+
+    return Application(client=client, id=app_id)
+
+
+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, info, 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.
@@ -61,7 +60,7 @@ def create(
     - Default configuration.
         $ [green]nextmv configuration create --api-key NEXTMV_API_KEY[/green]
 
-    - Configure a profile named [italic]hare[/italic].
+    - Configure a profile named [magenta]hare[/magenta].
         $ [green]nextmv configuration create --api-key NEXTMV_API_KEY --profile hare[/green]
     """
 
@@ -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.")
+    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:
-        rich.print(f"\t[bold]Endpoint[/bold]: {endpoint}")
+        info(f"\t[bold]Endpoint[/bold]: {endpoint}")

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.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.
+    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].
         $ [green]nextmv configuration delete --profile hare[/green]
+
+    - Delete a profile named [magenta]hare[/magenta] without confirmation prompt.
+        $ [green]nextmv configuration delete --profile hare --yes[/green]
     """
     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 = Confirm.ask(
+            f"Are you sure you want to delete profile [magenta]{profile}[/magenta]? This action cannot be undone.",
+            default=False,
+        )
 
-    if not confirm:
-        rich.print(f":bulb: Profile [bold magenta]{profile}[/bold magenta] will not be deleted.")
-        return
+        if not confirm:
+            info(msg=f"Profile [magenta]{profile}[/magenta] will not be deleted.", emoji=":bulb:")
+            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

@@ -7,7 +7,7 @@ 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.message import error
 
 # Set up subcommand application.
 app = typer.Typer()

nextmv/cli/main.py

@@ -14,16 +14,20 @@ 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 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.message import error, info, success, warning
 from nextmv.cli.version import app as version_app
+from nextmv.cli.version import version_callback
 
 # Main CLI application.
 app = typer.Typer(
@@ -32,17 +36,31 @@ 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.
@@ -64,15 +82,16 @@ def handle_go_cli() -> None:
     if exists:
         delete = Confirm.ask(
             "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?",
+            default=False,
         )
         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]."
+            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:",
             )
 
 
@@ -109,9 +128,9 @@ 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 must delete it to avoid conflicts."
         )
 
     check_config_in_path()
@@ -126,7 +145,7 @@ 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 deprecated [magenta]{GO_CLI_PATH}[/magenta].")
 
     check_config_in_path()
 
@@ -140,7 +159,30 @@ def check_config_in_path() -> None:
     config_dir_str = str(CONFIG_DIR)
 
     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]."
+        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:
+    """
+    Entry point for the CLI with global exception handling.
+
+    Catches all exceptions except Typer/Click exceptions (which handle their
+    own exit codes) and displays a clean error message instead of a traceback.
+    """
+
+    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)

nextmv/cli/message.py

@@ -0,0 +1,153 @@
+"""
+The message module is used to print messages to the user with pre-defined
+formatting. Logging, in general, is always printed to stderr.
+"""
+
+import sys
+from enum import Enum
+from typing import Any
+
+import rich
+import typer
+
+
+def error(msg: str) -> None:
+    """
+    Pretty-print an error message and exit with code 1. Your message should end
+    with a period.
+
+    Parameters
+    ----------
+    msg : str
+        The error message to display.
+
+    Raises
+    ------
+    typer.Exit
+        Exits the program with code 1.
+    """
+
+    msg = msg.rstrip("\n")
+    if not msg.endswith("."):
+        msg += "."
+
+    rich.print(f"[red]Error:[/red] {msg}", file=sys.stderr)
+
+    raise typer.Exit(code=1)
+
+
+def success(msg: str) -> None:
+    """
+    Pretty-print a success message. Your message should end with a period.
+
+    Parameters
+    ----------
+    msg : str
+        The success message to display.
+    """
+
+    msg = msg.rstrip("\n")
+    if not msg.endswith("."):
+        msg += "."
+
+    rich.print(f":white_check_mark: {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.
+    """
+
+    msg = msg.rstrip("\n")
+    if not msg.endswith("."):
+        msg += "."
+
+    rich.print(f":construction: {msg}", file=sys.stderr)
+
+
+def info(msg: str, emoji: str | None = None) -> 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.
+
+    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:`.
+    """
+
+    msg = msg.rstrip("\n")
+    if not msg.endswith("."):
+        msg += "."
+
+    if emoji:
+        rich.print(f"{emoji} {msg}", file=sys.stderr)
+        return
+
+    rich.print(msg, file=sys.stderr)
+
+
+def in_progress(msg: str) -> None:
+    """
+    Pretty-print an in-progress message with an hourglass emoji. Your message
+    should end with a period.
+
+    Parameters
+    ----------
+    msg : str
+        The in-progress message to display.
+    """
+
+    info(msg, emoji=":hourglass_flowing_sand:")
+
+
+def print_json(data: dict[str, Any] | list[dict[str, Any]]) -> None:
+    """
+    Pretty-print json-serializable data as JSON to stdout.
+
+    Parameters
+    ----------
+    data : dict[str, Any] | list[dict[str, Any]]
+        The data to print as JSON.
+    """
+
+    rich.print_json(data=data)
+
+
+def enum_values(enum_class: Enum) -> str:
+    """
+    Get a nicely formatted string of the values of an Enum class, using commas
+    and an oxford comma.
+
+    Parameters
+    ----------
+    enum_class : Enum
+        The Enum class to get the values from.
+
+    Returns
+    -------
+    str
+        A nicely formatted string of the values of the Enum class.
+    """
+
+    values = [f"[magenta]{member.value}[/magenta]" for member in enum_class]
+    if len(values) == 0:
+        return ""
+    if len(values) == 1:
+        return values[0]
+    if len(values) == 2:
+        return " and ".join(values)
+
+    return ", ".join(values[:-1]) + ", and " + values[-1]