nextmv 0.39.0.dev1__py3-none-any.whl → 1.0.0__py3-none-any.whl

nextmv/cli/community/clone.py

@@ -0,0 +1,86 @@
+"""
+This module defines the community clone command for the Nextmv CLI.
+"""
+
+from typing import Annotated
+
+import typer
+
+from nextmv.cli.configuration.config import build_client
+from nextmv.cli.message import error
+from nextmv.cli.options import ProfileOption
+from nextmv.cloud.community import clone_community_app
+
+# Set up subcommand application.
+app = typer.Typer()
+
+# Helpful constants.
+LATEST_VERSION = "latest"
+
+
+@app.command()
+def clone(
+    app: Annotated[
+        str,
+        typer.Option("--app", "-a", help="The name of the community app to clone.", metavar="COMMUNITY_APP"),
+    ],
+    directory: Annotated[
+        str | None,
+        typer.Option(
+            "--directory",
+            "-d",
+            help="The directory in which to clone the app. Default is the name of the app at current directory.",
+            metavar="DIRECTORY",
+        ),
+    ] = None,
+    version: Annotated[
+        str | None,
+        typer.Option(
+            "--version",
+            "-v",
+            help="The version of the community app to clone.",
+            metavar="VERSION",
+        ),
+    ] = LATEST_VERSION,
+    profile: ProfileOption = None,
+) -> None:
+    """
+    Clone a community app locally.
+
+    By default, the [magenta]latest[/magenta] version will be used. You can
+    specify a version with the --version flag, and customize the output
+    directory with the --directory flag. If you want to list the available
+    apps, use the [code]nextmv community list[/code] command.
+
+    [bold][underline]Examples[/underline][/bold]
+
+    - Clone the [magenta]go-nextroute[/magenta] community app (under the
+      [magenta]"go-nextroute"[/magenta] directory), using the [magenta]latest[/magenta] version.
+        $ [dim]nextmv community clone --app go-nextroute[/dim]
+
+    - Clone the [magenta]go-nextroute[/magenta] community app under the
+      [magenta]"~/sample/my_app"[/magenta] directory, using the [magenta]latest[/magenta] version.
+        $ [dim]nextmv community clone --app go-nextroute --directory ~/sample/my_app[/dim]
+
+    - Clone the [magenta]go-nextroute[/magenta] community app (under the
+      [magenta]"go-nextroute"[/magenta] directory), using version [magenta]v1.2.0[/magenta].
+        $ [dim]nextmv community clone --app go-nextroute --version v1.2.0[/dim]
+
+    - Clone the [magenta]go-nextroute[/magenta] community app (under the
+      [magenta]"go-nextroute"[/magenta] directory), using the [magenta]latest[/magenta] version
+      and a profile named [magenta]hare[/magenta].
+        $ [dim]nextmv community clone --app go-nextroute --profile hare[/dim]
+    """
+
+    if version is not None and version == "":
+        error("The --version flag cannot be an empty string.")
+
+    client = build_client(profile)
+    clone_community_app(
+        client=client,
+        app=app,
+        directory=directory,
+        version=version,
+        verbose=True,
+        rich_print=True,
+    )

nextmv/cli/community/list.py

@@ -0,0 +1,200 @@
+"""
+This module defines the community list command for the Nextmv CLI.
+"""
+
+from typing import Annotated
+
+import rich
+import typer
+from rich.console import Console
+from rich.table import Table
+
+from nextmv.cli.configuration.config import build_client
+from nextmv.cli.message import error
+from nextmv.cli.options import ProfileOption
+from nextmv.cloud.client import Client
+from nextmv.cloud.community import CommunityApp, list_community_apps
+
+# Set up subcommand application.
+app = typer.Typer()
+console = Console()
+
+
+@app.command()
+def list(
+    app: Annotated[
+        str | None,
+        typer.Option(
+            "--app",
+            "-a",
+            help="The community app to list versions for.",
+            metavar="COMMUNITY_APP",
+        ),
+    ] = None,
+    flat: Annotated[bool, typer.Option("--flat", "-f", help="Flatten the list output.")] = False,
+    profile: ProfileOption = None,
+) -> None:
+    """
+    List the available community apps
+
+    Use the --app flag to list that app's versions. Use the --flat flag to
+    flatten the list of names/versions. If you want to clone a community app
+    locally, use the [code]nextmv community clone[/code] command.
+
+    [bold][underline]Examples[/underline][/bold]
+
+    - List the available community apps.
+        $ [dim]nextmv community list[/dim]
+
+    - List the available versions of the [magenta]go-nextroute[/magenta] community app.
+        $ [dim]nextmv community list --app go-nextroute[/dim]
+
+    - List the names of the available community apps as a flat list.
+        $ [dim]nextmv community list --flat[/dim]
+
+    - List the available versions of the [magenta]go-nextroute[/magenta] community app as a flat list.
+        $ [dim]nextmv community list --app go-nextroute --flat[/dim]
+
+    - List the available community apps using a profile named [magenta]hare[/magenta].
+        $ [dim]nextmv community list --profile hare[/dim]
+    """
+
+    if app is not None and app == "":
+        error("The --app flag cannot be an empty string.")
+
+    client = build_client(profile)
+    if flat and app is None:
+        _apps_list(client)
+        raise typer.Exit()
+    elif not flat and app is None:
+        _apps_table(client)
+        raise typer.Exit()
+    elif flat and app is not None and app != "":
+        _versions_list(client, app)
+        raise typer.Exit()
+    elif not flat and app is not None and app != "":
+        _versions_table(client, app)
+        raise typer.Exit()
+
+
+def _apps_table(client: Client) -> None:
+    """
+    This function prints a table of community apps.
+
+    Parameters
+    ----------
+    client : Client
+        The Nextmv Cloud client to use for the request.
+    """
+
+    apps = list_community_apps(client)
+    table = Table("Name", "Type", "Latest", "Description", border_style="cyan", header_style="cyan")
+    for app in apps:
+        table.add_row(
+            app.name,
+            app.app_type,
+            app.latest_app_version if app.latest_app_version is not None else "",
+            app.description,
+        )
+
+    console.print(table)
+
+
+def _apps_list(client: Client) -> None:
+    """
+    This function prints a flat list of community app names.
+
+    Parameters
+    ----------
+    client : Client
+        The Nextmv Cloud client to use for the request.
+    """
+
+    apps = list_community_apps(client)
+    names = [app.name for app in apps]
+    print("\n".join(names))
+
+
+def _versions_table(client: Client, app: str) -> None:
+    """
+    This function prints a table of versions for a specific community app.
+
+    Parameters
+    ----------
+    client : Client
+        The Nextmv Cloud client to use for the request.
+    app : str
+        The name of the community app.
+    """
+
+    comm_app = _find_app(client, app)
+    latest_version = comm_app.latest_app_version if comm_app.latest_app_version is not None else ""
+
+    # Add the latest version with indicator
+    table = Table("Version", "Latest?", border_style="cyan", header_style="cyan")
+    table.add_row(f"[cyan underline]{latest_version}[/cyan underline]", "[cyan]<--[/cyan]")
+    table.add_row("", "")  # Empty row to separate latest from others.
+
+    # Add all other versions (excluding the latest)
+    versions = comm_app.app_versions if comm_app.app_versions is not None else []
+    for version in versions:
+        if version != latest_version:
+            table.add_row(version, "")
+
+    console.print(table)
+
+
+def _versions_list(client: Client, app: str) -> None:
+    """
+    This function prints a flat list of versions for a specific community app.
+
+    Parameters
+    ----------
+    client : Client
+        The Nextmv Cloud client to use for the request.
+    app : str
+        The name of the community app.
+    """
+
+    comm_app = _find_app(client, app)
+    versions = comm_app.app_versions if comm_app.app_versions is not None else []
+
+    versions_output = ""
+    for version in versions:
+        versions_output += f"{version}\n"
+
+    print(versions_output.rstrip("\n"))
+
+
+def _find_app(client: Client, app: str) -> CommunityApp:
+    """
+    Finds and returns a community app from the manifest by its name.
+
+    Parameters
+    ----------
+    client : Client
+        The Nextmv Cloud client to use for the request.
+    app : str
+        The name of the community app to find.
+
+    Returns
+    -------
+    CommunityApp
+        The community app if found.
+
+    Raises
+    ------
+    ValueError
+        If the community app is not found.
+    """
+
+    comm_apps = list_community_apps(client)
+    for comm_app in comm_apps:
+        if comm_app.name == app:
+            return comm_app
+
+    # We don't use error() here to allow printing something before exiting.
+    rich.print(f"[red]Error:[/red] Community app [magenta]{app}[/magenta] was not found. Here are the available apps:")
+    _apps_table(client)
+
+    raise typer.Exit(code=1)

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

@@ -0,0 +1,228 @@
+"""
+This module contains configuration utilities for the Nextmv CLI.
+"""
+
+from pathlib import Path
+from typing import Any
+
+import yaml
+
+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.
+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 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
+    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. "
+                "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 [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 [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. "
+                "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. 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.
+
+    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, message, 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.
+        $ [dim]nextmv configuration create --api-key NEXTMV_API_KEY[/dim]
+
+    - 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("[magenta]default[/magenta] 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.")
+    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:
+        message(f"\t[bold]Endpoint[/bold]: [magenta]{endpoint}[/magenta]")

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 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.
+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 --yes 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]
+
+    - 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 [magenta]{profile}[/magenta] does not exist.")
+
+    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:
+            info(f"Profile [magenta]{profile}[/magenta] will not be deleted.")
+            return
+
+    del config[profile]
+    save_config(config)
+
+    success(f"Profile [magenta]{profile}[/magenta] deleted successfully.")