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

nextmv/cli/cloud/acceptance/update.py

@@ -0,0 +1,95 @@
+"""
+This module defines the cloud acceptance update command for the Nextmv CLI.
+"""
+
+import json
+from typing import Annotated
+
+import typer
+
+from nextmv.cli.configuration.config import build_app
+from nextmv.cli.message import in_progress, print_json, success
+from nextmv.cli.options import AcceptanceTestIDOption, AppIDOption, ProfileOption
+
+# Set up subcommand application.
+app = typer.Typer()
+
+
+@app.command()
+def update(
+    app_id: AppIDOption,
+    acceptance_test_id: AcceptanceTestIDOption,
+    description: Annotated[
+        str | None,
+        typer.Option(
+            "--description",
+            "-d",
+            help="Updated description of the acceptance test.",
+            metavar="DESCRIPTION",
+        ),
+    ] = None,
+    name: Annotated[
+        str | None,
+        typer.Option(
+            "--name",
+            "-n",
+            help="Updated name of the acceptance test.",
+            metavar="NAME",
+        ),
+    ] = None,
+    output: Annotated[
+        str | None,
+        typer.Option(
+            "--output",
+            "-o",
+            help="Saves the updated acceptance test information to this location.",
+            metavar="OUTPUT_PATH",
+        ),
+    ] = None,
+    profile: ProfileOption = None,
+) -> None:
+    """
+    Update a Nextmv Cloud acceptance test.
+
+    Update the name and/or description of an acceptance test. Any fields not
+    specified will remain unchanged.
+
+    [bold][underline]Examples[/underline][/bold]
+
+    - Update the name of an acceptance test.
+        $ [dim]nextmv cloud acceptance update --app-id hare-app \\
+            --acceptance-test-id test-123 --name "Updated Test Name"[/dim]
+
+    - Update the description of an acceptance test.
+        $ [dim]nextmv cloud acceptance update --app-id hare-app \\
+            --acceptance-test-id test-123 --description "Updated description"[/dim]
+
+    - Update both name and description and save the result.
+        $ [dim]nextmv cloud acceptance update --app-id hare-app \\
+            --acceptance-test-id test-123 --name "New Name" \\
+            --description "New description" --output updated-test.json[/dim]
+    """
+
+    cloud_app = build_app(app_id=app_id, profile=profile)
+
+    in_progress(msg="Updating acceptance test...")
+    acceptance_test = cloud_app.update_acceptance_test(
+        acceptance_test_id=acceptance_test_id,
+        name=name,
+        description=description,
+    )
+    success(
+        f"Acceptance test [magenta]{acceptance_test_id}[/magenta] updated successfully "
+        f"in application [magenta]{app_id}[/magenta]."
+    )
+
+    acceptance_test_dict = acceptance_test.to_dict()
+
+    if output is not None and output != "":
+        with open(output, "w") as f:
+            json.dump(acceptance_test_dict, f, indent=2)
+
+        success(msg=f"Updated acceptance test information saved to [magenta]{output}[/magenta].")
+        return
+
+    print_json(acceptance_test_dict)

nextmv/cli/cloud/account/__init__.py

@@ -0,0 +1,28 @@
+"""
+This module defines the cloud account command tree for the Nextmv CLI.
+"""
+
+import typer
+
+from nextmv.cli.cloud.account.create import app as create_app
+from nextmv.cli.cloud.account.delete import app as delete_app
+from nextmv.cli.cloud.account.get import app as get_app
+from nextmv.cli.cloud.account.update import app as update_app
+
+# Set up subcommand application.
+app = typer.Typer()
+app.add_typer(create_app)
+app.add_typer(delete_app)
+app.add_typer(get_app)
+app.add_typer(update_app)
+
+
+@app.callback()
+def callback() -> None:
+    """
+    Manage SSO for your Nextmv Cloud account (organization).
+
+    Please contact [link=https://www.nextmv.io/contact][bold]Nextmv support[/bold][/link]
+    for assistance configuring SSO for your organization.
+    """
+    pass

nextmv/cli/cloud/account/create.py

@@ -0,0 +1,83 @@
+"""
+This module defines the cloud account create command for the Nextmv CLI.
+"""
+
+from typing import Annotated
+
+import typer
+
+from nextmv.cli.configuration.config import build_client
+from nextmv.cli.message import in_progress, print_json
+from nextmv.cli.options import ProfileOption
+from nextmv.cloud.account import Account
+
+# Set up subcommand application.
+app = typer.Typer()
+
+
+@app.command()
+def create(
+    admins: Annotated[
+        list[str],
+        typer.Option(
+            "--admins",
+            "-a",
+            help="Email addresses of the administrators for the account. "
+            "Pass multiple emails by repeating the flag, or separating with commas.",
+            metavar="ADMINS",
+        ),
+    ],
+    name: Annotated[
+        str,
+        typer.Option(
+            "--name",
+            "-n",
+            help="A name for the account.",
+            metavar="NAME",
+        ),
+    ],
+    profile: ProfileOption = None,
+) -> None:
+    """
+    Create a new Nextmv Cloud account in your organization.
+
+    To create managed accounts, SSO must be configured for your organization.
+    Please contact [link=https://www.nextmv.io/contact][bold]Nextmv support[/bold][/link] for assistance.
+
+    At least one administrator email address must be provided. Multiple
+    administrators can be specified by repeating the --admins flag or by
+    separating email addresses with commas.
+
+    [bold][underline]Examples[/underline][/bold]
+
+    - Create an account named [magenta]Bunny Logistics[/magenta] with a single administrator.
+        $ [dim]nextmv cloud account create --name "Bunny Logistics" \\
+            --admins peter.rabbit@carrotexpress.com[/dim]
+
+    - Create an account named [magenta]Hare Delivery Co[/magenta] with multiple administrators.
+        $ [dim]nextmv cloud account create --name "Hare Delivery Co" \\
+            --admins bugs@acme.com --admins roger@toontown.com[/dim]
+
+    - Create an account using the profile named [magenta]hare[/magenta].
+        $ [dim]nextmv cloud account create --name "Cottontail Couriers" \\
+            --admins fluffy@hopmail.com --profile hare[/dim]
+
+    - Create an account with comma-separated administrators.
+        $ [dim]nextmv cloud account create --name "Whiskers Warehouse" \\
+            --admins "thumper@forestmail.com,flopsy@warren.io"[/dim]
+    """
+
+    cloud_client = build_client(profile)
+    in_progress(msg="Creating account...")
+
+    admin_list = []
+    for admin in admins:
+        # It is possible to pass multiple emails separated by commas. The
+        # default way though is to use the flag multiple times to specify
+        # different options.
+        sub_admins = admin.split(",")
+        for sub_admin in sub_admins:
+            admin_list.append(sub_admin.strip())
+
+    account = Account.new(client=cloud_client, name=name, admins=admin_list)
+    print_json(account.to_dict())

nextmv/cli/cloud/account/delete.py

@@ -0,0 +1,59 @@
+"""
+This module defines the cloud account delete command for the Nextmv CLI.
+"""
+
+from typing import Annotated
+
+import typer
+
+from nextmv.cli.configuration.config import build_account
+from nextmv.cli.confirm import get_confirmation
+from nextmv.cli.message import info, success
+from nextmv.cli.options import AccountIDOption, ProfileOption
+
+# Set up subcommand application.
+app = typer.Typer()
+
+
+@app.command()
+def delete(
+    account_id: AccountIDOption,
+    yes: Annotated[
+        bool,
+        typer.Option(
+            "--yes",
+            "-y",
+            help="Agree to deletion confirmation prompt. Useful for non-interactive sessions.",
+        ),
+    ] = False,
+    profile: ProfileOption = None,
+) -> None:
+    """
+    Deletes an account within your SSO-enabled organization.
+
+    You must have the [magenta]administrator[/magenta] role on that account in order to delete it.
+
+    This action is permanent and cannot be undone. Use the --yes
+    flag to skip the confirmation prompt.
+
+    [bold][underline]Examples[/underline][/bold]
+
+    - Delete the account with the ID [magenta]bunnies-account[/magenta].
+        $ [dim]nextmv cloud account delete --account-id bunnies-account[/dim]
+
+    - Delete the account without confirmation prompt.
+        $ [dim]nextmv cloud account delete --account-id bunnies-account --yes[/dim]
+    """
+
+    if not yes:
+        confirm = get_confirmation(
+            f"Are you sure you want to delete account [magenta]{account_id}[/magenta]? This action cannot be undone.",
+        )
+
+        if not confirm:
+            info(f"Account [magenta]{account_id}[/magenta] will not be deleted.")
+            return
+
+    cloud_account = build_account(account_id=account_id, profile=profile)
+    cloud_account.delete()
+    success(f"Account [magenta]{account_id}[/magenta] has been deleted.")

nextmv/cli/cloud/account/get.py

@@ -0,0 +1,66 @@
+"""
+This module defines the cloud account get command for the Nextmv CLI.
+"""
+
+import json
+from typing import Annotated
+
+import typer
+
+from nextmv.cli.configuration.config import build_client
+from nextmv.cli.message import in_progress, print_json, success
+from nextmv.cli.options import AccountIDOption, ProfileOption
+from nextmv.cloud.account import Account
+
+# Set up subcommand application.
+app = typer.Typer()
+
+
+@app.command()
+def get(
+    account_id: AccountIDOption,
+    output: Annotated[
+        str | None,
+        typer.Option(
+            "--output",
+            "-o",
+            help="Saves the account information to this location.",
+            metavar="OUTPUT_PATH",
+        ),
+    ] = None,
+    profile: ProfileOption = None,
+) -> None:
+    """
+    Get the information of a Nextmv Cloud account.
+
+    This command is useful to get the attributes of an existing Nextmv Cloud
+    account by its ID.
+
+    [bold][underline]Examples[/underline][/bold]
+
+    - Get the account with the ID [magenta]bunny-logistics[/magenta].
+        $ [dim]nextmv cloud account get --account-id bunny-logistics[/dim]
+
+    - Get the account with the ID [magenta]cottontail-couriers[/magenta] and save the information to an
+      [magenta]account.json[/magenta] file.
+        $ [dim]nextmv cloud account get --account-id cottontail-couriers --output account.json[/dim]
+    """
+
+    client = build_client(profile)
+    in_progress(msg="Getting account...")
+
+    cloud_account = Account.get(
+        client=client,
+        account_id=account_id,
+    )
+    cloud_account_dict = cloud_account.to_dict()
+
+    if output is not None and output != "":
+        with open(output, "w") as f:
+            json.dump(cloud_account_dict, f, indent=2)
+
+        success(msg=f"Account information saved to [magenta]{output}[/magenta].")
+
+        return
+
+    print_json(cloud_account_dict)

nextmv/cli/cloud/account/update.py

@@ -0,0 +1,70 @@
+"""
+This module defines the cloud account update command for the Nextmv CLI.
+"""
+
+import json
+from typing import Annotated
+
+import typer
+
+from nextmv.cli.configuration.config import build_account
+from nextmv.cli.message import print_json, success
+from nextmv.cli.options import AccountIDOption, ProfileOption
+
+# Set up subcommand application.
+app = typer.Typer()
+
+
+@app.command()
+def update(
+    account_id: AccountIDOption,
+    name: Annotated[
+        str,
+        typer.Option(
+            "--name",
+            "-n",
+            help="A new name for the account.",
+            metavar="NAME",
+        ),
+    ],
+    output: Annotated[
+        str | None,
+        typer.Option(
+            "--output",
+            "-o",
+            help="Saves the updated account information to this location.",
+            metavar="OUTPUT_PATH",
+        ),
+    ] = None,
+    profile: ProfileOption = None,
+) -> None:
+    """
+    Updates information of a Nextmv Cloud account.
+
+    This command allows you to update the name of an existing account.
+
+    [bold][underline]Examples[/underline][/bold]
+
+    - Update the account named [magenta]hare-delivery[/magenta] to [magenta]Hare Delivery Co[/magenta].
+        $ [dim]nextmv cloud account update --account-id hare-delivery \\
+            --name "Hare Delivery Co"[/dim]
+
+    - Update an account and save the updated information to an [magenta]updated_account.json[/magenta] file.
+        $ [dim]nextmv cloud account update --account-id cottontail-couriers \\
+            --name "Cottontail Express" --output updated_account.json[/dim]
+    """
+
+    cloud_account = build_account(account_id=account_id, profile=profile)
+    updated_account = cloud_account.update(name=name)
+    success(f"Account [magenta]{account_id}[/magenta] updated successfully.")
+    updated_account_dict = updated_account.to_dict()
+
+    if output is not None and output != "":
+        with open(output, "w") as f:
+            json.dump(updated_account_dict, f, indent=2)
+
+        success(msg=f"Updated account information saved to [magenta]{output}[/magenta].")
+
+        return
+
+    print_json(updated_account_dict)

nextmv/cli/cloud/app/__init__.py

@@ -0,0 +1,35 @@
+"""
+This module defines the cloud app command tree for the Nextmv CLI.
+"""
+
+import typer
+
+from nextmv.cli.cloud.app.create import app as create_app
+from nextmv.cli.cloud.app.delete import app as delete_app
+from nextmv.cli.cloud.app.exists import app as exists_app
+from nextmv.cli.cloud.app.get import app as get_app
+from nextmv.cli.cloud.app.list import app as list_app
+from nextmv.cli.cloud.app.push import app as push_app
+from nextmv.cli.cloud.app.update import app as update_app
+
+# Set up subcommand application.
+app = typer.Typer()
+app.add_typer(create_app)
+app.add_typer(delete_app)
+app.add_typer(exists_app)
+app.add_typer(get_app)
+app.add_typer(list_app)
+app.add_typer(push_app)
+app.add_typer(update_app)
+
+
+@app.callback()
+def callback() -> None:
+    """
+    Create, manage, and push Nextmv Cloud applications.
+
+    A Nextmv application is an entity that contains a decision model as
+    executable code. An application can make a run by taking an input,
+    executing the decision model, and producing an output.
+    """
+    pass

nextmv/cli/cloud/app/create.py

@@ -0,0 +1,140 @@
+"""
+This module defines the cloud app create command for the Nextmv CLI.
+"""
+
+from typing import Annotated
+
+import typer
+
+from nextmv.cli.configuration.config import build_client
+from nextmv.cli.message import in_progress, print_json
+from nextmv.cli.options import ProfileOption
+from nextmv.cloud.application import Application
+
+# Set up subcommand application.
+app = typer.Typer()
+
+
+@app.command()
+def create(
+    app_id: Annotated[
+        str | None,
+        typer.Option(
+            "--app-id",
+            "-a",
+            help="An optional ID for the Nextmv Cloud application. If not provided, a random ID will be generated.",
+            envvar="NEXTMV_APP_ID",
+            metavar="APP_ID",
+        ),
+    ] = None,
+    default_experiment_instance: Annotated[
+        str | None,
+        typer.Option(
+            "--default-experiment-instance",
+            "-x",
+            help="An optional default experiment instance ID for the application.",
+            metavar="DEFAULT_EXPERIMENT_INSTANCE",
+        ),
+    ] = None,
+    default_instance_id: Annotated[
+        str | None,
+        typer.Option(
+            "--default-instance-id",
+            "-i",
+            help="An optional default instance ID for the application.",
+            metavar="DEFAULT_INSTANCE_ID",
+        ),
+    ] = None,
+    description: Annotated[
+        str | None,
+        typer.Option(
+            "--description",
+            "-d",
+            help="An optional description for the application.",
+            metavar="DESCRIPTION",
+        ),
+    ] = None,
+    exist_ok: Annotated[
+        bool,
+        typer.Option(
+            "--exist-ok",
+            "-e",
+            help="If an application with the given ID already exists, do not raise an error, and simply return it.",
+        ),
+    ] = False,
+    is_workflow: Annotated[
+        bool,
+        typer.Option(
+            "--is-workflow",
+            "-w",
+            help="Whether the application is a workflow.",
+        ),
+    ] = False,
+    name: Annotated[
+        str | None,
+        typer.Option(
+            "--name",
+            "-n",
+            help="An optional name for the application. If not provided, the application ID will be used as the name.",
+            metavar="NAME",
+        ),
+    ] = None,
+    profile: ProfileOption = None,
+) -> None:
+    """
+    Create a new Nextmv Cloud application.
+
+    Use the --exist-ok flag to avoid errors when creating an application with
+    an ID that already exists. This is useful for scripts that need to ensure
+    an application exists without worrying about whether it was created
+    previously.
+
+    An application can be marked as a workflow using the --is-workflow flag.
+    Workflows allow for more complex decision-making processes by leveraging
+    [link=https://github.com/nextmv-io/nextpipe][bold]Nextpipe[/bold][/link] to
+    orchestrate multiple decision models.
+
+    [bold][underline]Examples[/underline][/bold]
+
+    - Create an application with the name [magenta]Hare App[/magenta]. A random ID will be generated.
+        $ [dim]nextmv cloud app create --name "Hare App"[/dim]
+
+    - Create an application with the specific ID [magenta]hare-app[/magenta].
+        $ [dim]nextmv cloud app create --name "Hare App" --app-id hare-app[/dim]
+
+    - Create an application with an ID and description.
+        $ [dim]nextmv cloud app create --name "Hare App" --app-id hare-app \\
+            --description "An application for routing hares"[/dim]
+
+    - Create an application, or get it if it already exists.
+        $ [dim]nextmv cloud app create --name "Hare App" --app-id hare-app --exist-ok[/dim]
+
+    - Create a workflow application.
+        $ [dim]nextmv cloud app create --name "Hare Workflow" --app-id hare-workflow --is-workflow[/dim]
+
+    - Create an application with a default instance ID.
+        $ [dim]nextmv cloud app create --name "Hare App" --app-id hare-app \\
+            --default-instance-id burrow[/dim]
+
+    - Create an application with a default experiment instance.
+        $ [dim]nextmv cloud app create --name "Hare App" --app-id hare-app \\
+            --default-experiment-instance experiment-v1[/dim]
+    """
+
+    client = build_client(profile)
+    if exist_ok:
+        in_progress(msg="Creating or getting application...")
+    else:
+        in_progress(msg="Creating application...")
+
+    cloud_app = Application.new(
+        client=client,
+        name=name,
+        id=app_id,
+        description=description,
+        is_workflow=is_workflow,
+        exist_ok=exist_ok,
+        default_instance_id=default_instance_id,
+        default_experiment_instance=default_experiment_instance,
+    )
+    print_json(cloud_app.to_dict())

nextmv/cli/cloud/app/delete.py

@@ -0,0 +1,57 @@
+"""
+This module defines the cloud app delete command for the Nextmv CLI.
+"""
+
+from typing import Annotated
+
+import typer
+
+from nextmv.cli.configuration.config import build_app
+from nextmv.cli.confirm import get_confirmation
+from nextmv.cli.message import info, success
+from nextmv.cli.options import AppIDOption, ProfileOption
+
+# Set up subcommand application.
+app = typer.Typer()
+
+
+@app.command()
+def delete(
+    app_id: AppIDOption,
+    yes: Annotated[
+        bool,
+        typer.Option(
+            "--yes",
+            "-y",
+            help="Agree to deletion confirmation prompt. Useful for non-interactive sessions.",
+        ),
+    ] = False,
+    profile: ProfileOption = None,
+) -> None:
+    """
+    Deletes a Nextmv Cloud application.
+
+    This action is permanent and cannot be undone. Use the --yes
+    flag to skip the confirmation prompt.
+
+    [bold][underline]Examples[/underline][/bold]
+
+    - Delete the application with the ID [magenta]hare-app[/magenta].
+        $ [dim]nextmv cloud app delete --app-id hare-app[/dim]
+
+    - Delete the application with the ID [magenta]hare-app[/magenta] without confirmation prompt.
+        $ [dim]nextmv cloud app delete --app-id hare-app --yes[/dim]
+    """
+
+    if not yes:
+        confirm = get_confirmation(
+            f"Are you sure you want to delete application [magenta]{app_id}[/magenta]? This action cannot be undone.",
+        )
+
+        if not confirm:
+            info(f"Application [magenta]{app_id}[/magenta] will not be deleted.")
+            return
+
+    cloud_app = build_app(app_id=app_id, profile=profile)
+    cloud_app.delete()
+    success(f"Application [magenta]{app_id}[/magenta] deleted successfully.")

nextmv/cli/cloud/app/exists.py

@@ -0,0 +1,44 @@
+"""
+This module defines the cloud app exists command for the Nextmv CLI.
+"""
+
+import typer
+
+from nextmv.cli.configuration.config import build_client
+from nextmv.cli.message import in_progress, print_json
+from nextmv.cli.options import AppIDOption, ProfileOption
+from nextmv.cloud.application import Application
+
+# Set up subcommand application.
+app = typer.Typer()
+
+
+@app.command()
+def exists(
+    app_id: AppIDOption,
+    profile: ProfileOption = None,
+) -> None:
+    """
+    Check if a Nextmv Cloud application exists.
+
+    This command is useful in scripting applications to verify the existence of
+    a Nextmv Cloud application by its ID.
+
+    [bold][underline]Examples[/underline][/bold]
+
+    - Check if the application with the ID [magenta]hare-app[/magenta] exists.
+        $ [dim]nextmv cloud app exists --app-id hare-app[/dim]
+
+    - Check if the application with the ID [magenta]hare-app[/magenta] exists.
+      Use the profile named [magenta]hare[/magenta].
+        $ [dim]nextmv cloud app exists --app-id hare-app --profile hare[/dim]
+    """
+
+    client = build_client(profile)
+    in_progress(msg="Checking if application exists...")
+
+    ok = Application.exists(
+        client=client,
+        id=app_id,
+    )
+    print_json({"exists": ok})