nextmv 0.18.0__py3-none-any.whl → 1.0.0.dev2__py3-none-any.whl

nextmv/cli/configuration/config.py

@@ -0,0 +1,195 @@
+"""
+This module contains configuration utilities for the Nextmv CLI.
+"""
+
+from pathlib import Path
+from typing import Any
+
+import yaml
+
+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.
+CONFIG_DIR = Path.home() / ".nextmv"
+CONFIG_FILE = CONFIG_DIR / "config.yaml"
+API_KEY_KEY = "apikey"
+ENDPOINT_KEY = "endpoint"
+DEFAULT_ENDPOINT = "api.cloud.nextmv.io"
+GO_CLI_PATH = CONFIG_DIR / "nextmv"
+
+
+def load_config() -> dict[str, Any]:
+    """
+    Load the current configuration from the config file. Returns an empty
+    dictionary if no configuration file exists.
+
+    Returns
+    -------
+    dict[str, Any]
+        The current configuration as a dictionary.
+    """
+
+    if not CONFIG_FILE.exists():
+        return {}
+
+    with CONFIG_FILE.open() as file:
+        config = yaml.safe_load(file)
+
+    if config is None:
+        return {}
+    return config
+
+
+def save_config(config: dict[str, Any]) -> None:
+    """
+    Save the given configuration to the config file.
+
+    Parameters
+    ----------
+    config : dict[str, Any]
+        The configuration to save.
+    """
+
+    CONFIG_DIR.mkdir(parents=True, exist_ok=True)
+
+    with CONFIG_FILE.open("w") as file:
+        yaml.safe_dump(config, file)
+
+
+def build_client(profile: str | None = None) -> Client:
+    """
+    Builds a `cloud.Client` using the API key and endpoint for the given
+    profile. If no profile is given, the default profile is used. If either the
+    API key or endpoint is missing, an exception is raised. If the config is
+    not available, an exception is raised.
+
+    Parameters
+    ----------
+    profile : str | None
+        The profile name to use. If None, the default profile is used.
+
+    Returns
+    -------
+    Client
+        A client configured with the API key and endpoint for the selected
+        profile or the default configuration.
+
+    Raises
+    ------
+    typer.Exit
+        If no configuration is found, if the requested profile does not exist,
+        or if the API key or endpoint (for either the selected profile or the
+        default configuration) is not set or is empty.
+    """
+
+    config = load_config()
+    if config == {}:
+        error("No configuration found. Please run [code]nextmv configuration create[/code].")
+
+    if profile is not None:
+        if profile not in config:
+            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 [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 [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 == "":
+            error("Default API key is not set or is empty.")
+
+        endpoint = config.get(ENDPOINT_KEY)
+        if endpoint is None or endpoint == "":
+            error("Default endpoint is not set or is empty.")
+
+    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.
+
+    Parameters
+    ----------
+    api_key : str
+        The API key to obscure.
+
+    Returns
+    -------
+    str
+        The obscured API key.
+    """
+
+    if len(api_key) <= 4:
+        return "*" * len(api_key)
+
+    return api_key[:2] + "*" * 4 + api_key[-2:]

nextmv/cli/configuration/create.py

@@ -0,0 +1,94 @@
+"""
+This module defines the configuration create command for the Nextmv CLI.
+"""
+
+from typing import Annotated
+
+import typer
+
+from nextmv.cli.configuration.config import (
+    API_KEY_KEY,
+    DEFAULT_ENDPOINT,
+    ENDPOINT_KEY,
+    load_config,
+    obscure_api_key,
+    save_config,
+)
+from nextmv.cli.message import error, info, success
+
+# Set up subcommand application.
+app = typer.Typer()
+
+
+@app.command()
+def create(
+    api_key: Annotated[
+        str,
+        typer.Option(
+            "--api-key",
+            "-a",
+            help="A valid Nextmv Cloud API key. "
+            + "Get one from [link=https://cloud.nextmv.io][bold]https://cloud.nextmv.io[/bold][/link].",
+            envvar="NEXTMV_API_KEY",
+            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(
+            "--profile",
+            "-p",
+            help="Profile name to save the configuration under.",
+            envvar="NEXTMV_PROFILE",
+            metavar="PROFILE_NAME",
+        ),
+    ] = None,
+) -> None:
+    """
+    Create a new configuration or update an existing one.
+
+    [bold][underline]Examples[/underline][/bold]
+
+    - Default configuration.
+        $ [green]nextmv configuration create --api-key NEXTMV_API_KEY[/green]
+
+    - Configure a profile named [magenta]hare[/magenta].
+        $ [green]nextmv configuration create --api-key NEXTMV_API_KEY --profile hare[/green]
+    """
+
+    if profile is not None and profile.strip().lower() == "default":
+        error("[code]default[/code] is a reserved profile name.")
+
+    endpoint = str(endpoint)
+    if endpoint.startswith("https://"):
+        endpoint = endpoint[len("https://") :]
+    elif endpoint.startswith("http://"):
+        endpoint = endpoint[len("http://") :]
+
+    config = load_config()
+
+    if profile is None:
+        config[API_KEY_KEY] = api_key
+        config[ENDPOINT_KEY] = endpoint
+    else:
+        if profile not in config:
+            config[profile] = {}
+
+        config[profile][API_KEY_KEY] = api_key
+        config[profile][ENDPOINT_KEY] = endpoint
+
+    save_config(config)
+
+    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:
+        info(f"\t[bold]Endpoint[/bold]: {endpoint}")

nextmv/cli/configuration/delete.py

@@ -0,0 +1,67 @@
+"""
+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.message import error, info, success
+
+# Set up subcommand application.
+app = typer.Typer()
+
+
+@app.command()
+def delete(
+    profile: Annotated[  # Similar to nextmv.cli.options.ProfileOption but with different help text.
+        str,
+        typer.Option(
+            "--profile",
+            "-p",
+            help="Profile name to delete.",
+            envvar="NEXTMV_PROFILE",
+            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 [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 [magenta]{profile}[/magenta] does not exist.")
+
+    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:
+            info(msg=f"Profile [magenta]{profile}[/magenta] will not be deleted.", emoji=":bulb:")
+            return
+
+    del config[profile]
+    save_config(config)
+
+    success(f"Profile [magenta]{profile}[/magenta] deleted successfully.")

nextmv/cli/configuration/list.py

@@ -0,0 +1,77 @@
+"""
+This module defines the configuration list command for the Nextmv CLI.
+"""
+
+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.message import error
+
+# Set up subcommand application.
+app = typer.Typer()
+console = Console()
+
+
+@app.command()
+def list() -> None:
+    """
+    List the current configuration and all profiles.
+
+    [bold][underline]Examples[/underline][/bold]
+
+    - Show current configuration and all profiles.
+        $ [green]nextmv configuration list[/green]
+    """
+
+    config = load_config()
+    if config == {}:
+        error("No configuration found. Please run [code]nextmv configuration[/code].")
+
+    default = {
+        "api_key": config.get(API_KEY_KEY),
+        "endpoint": config.get(ENDPOINT_KEY),
+        "name": "Default",
+    }
+    profiles = [default]
+
+    for k, v in config.items():
+        # Skip default configuration.
+        if k in {API_KEY_KEY, ENDPOINT_KEY}:
+            continue
+
+        profile = {
+            "name": k,
+            "api_key": v.get(API_KEY_KEY),
+            "endpoint": v.get(ENDPOINT_KEY),
+        }
+        profiles.append(profile)
+
+    table = Table("Profile name", "API Key", "Endpoint")
+    not_set = "[italic]Not set[/italic]"
+    for profile in profiles:
+        if profile["name"] != "Default":
+            table.add_row(
+                profile["name"],
+                obscure_api_key(profile["api_key"]) if profile.get("api_key") is not None else not_set,
+                profile["endpoint"] if profile.get("endpoint") is not None else not_set,
+            )
+            continue
+
+        api_key = not_set
+        if profile.get("api_key") is not None:
+            api_key = obscure_api_key(profile["api_key"])
+
+        endpoint = not_set
+        if profile.get("endpoint") is not None:
+            endpoint = profile["endpoint"]
+
+        table.add_row(
+            f"[bold yellow]{profile['name']}[/bold yellow]",
+            f"[bold yellow]{api_key}[/bold yellow]",
+            f"[bold yellow]{endpoint}[/bold yellow]",
+        )
+        table.add_section()
+
+    console.print(table)

nextmv/cli/main.py

@@ -0,0 +1,188 @@
+"""
+The Nextmv Command Line Interface (CLI).
+
+This module is the main entry point for the Nextmv CLI application. The Nextmv
+CLI is built with [Typer](https://typer.tiangolo.com/) and provides various
+commands to interact with Nextmv services. You should visit the "Learn" section
+of the Typer documentation to learn about the features that are used here.
+
+The Nextmv CLI also uses [Rich](https://rich.readthedocs.io/en/stable/) for
+rich text and formatting in the terminal. The command documentation is created
+using Rich markup. You should also visit the Rich documentation to learn more
+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 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.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(
+    help="The Nextmv Command Line Interface (CLI).",
+    epilog="[dim]\n---\n\n[italic]:rabbit: Made by Nextmv with :heart:[/italic][/dim]",
+    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,
+    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.
+    """
+
+    handle_go_cli()
+    handle_config_existence(ctx)
+
+
+def handle_go_cli() -> None:
+    """
+    Handle the presence of the deprecated Go CLI by notifying the user.
+
+    This function checks if the Go CLI is installed and prompts the user to
+    remove it to avoid conflicts with the Python CLI.
+    """
+
+    exists = go_cli_exists()
+    if exists:
+        delete = Confirm.ask(
+            "Do you want to delete the [italic red]deprecated[/italic red] Nextmv CLI "
+            f"at [magenta]{GO_CLI_PATH}[/magenta] now?",
+            default=False,
+        )
+        if delete:
+            remove_go_cli()
+        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:
+    """
+    Check if configuration exists and show an error if it does not.
+
+    Parameters
+    ----------
+    ctx : typer.Context
+        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].")
+
+
+def go_cli_exists() -> bool:
+    """
+    Check if the Go CLI is installed by looking for the 'nextmv' executable
+    under the config dir.
+
+    Returns
+    -------
+    bool
+        True if the Go CLI is installed, False otherwise.
+    """
+
+    # Check if the Go CLI executable exists
+    exists = GO_CLI_PATH.exists()
+    if exists:
+        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()
+
+    return exists
+
+
+def remove_go_cli() -> None:
+    """
+    Remove the Go CLI executable if it exists and notify about PATH cleanup.
+    """
+
+    if GO_CLI_PATH.exists():
+        GO_CLI_PATH.unlink()
+        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:
+    """
+    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)