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

nextmv/cli/cloud/shadow/stop.py

@@ -0,0 +1,43 @@
+"""
+This module defines the cloud shadow stop command for the Nextmv CLI.
+"""
+
+import typer
+
+from nextmv.cli.configuration.config import build_app
+from nextmv.cli.message import in_progress, success
+from nextmv.cli.options import AppIDOption, ProfileOption, ShadowTestIDOption
+
+# Set up subcommand application.
+app = typer.Typer()
+
+
+@app.command()
+def stop(
+    app_id: AppIDOption,
+    shadow_test_id: ShadowTestIDOption,
+    profile: ProfileOption = None,
+) -> None:
+    """
+    Stops a Nextmv Cloud shadow test.
+
+    Before stopping a shadow test, it must be in a started state. You may
+    use the [code]nextmv cloud shadow start[/code] command to start
+    a shadow test. Alternatively, define a [code]--start-time[/code] when using
+    the [code]nextmv cloud shadow create[/code] command to have the shadow test
+    start automatically at a specific time.
+
+    [bold][underline]Examples[/underline][/bold]
+
+    - Start the shadow test with the ID [magenta]hop-analysis[/magenta] from application
+      [magenta]hare-app[/magenta].
+        $ [green]nextmv cloud shadow start --app-id hare-app --shadow-test-id hop-analysis[/green]
+    """
+
+    in_progress(msg="Starting shadow test...")
+    cloud_app = build_app(app_id=app_id, profile=profile)
+    cloud_app.start_shadow_test(shadow_test_id=shadow_test_id)
+    success(
+        f"Shadow test [magenta]{shadow_test_id}[/magenta] started successfully "
+        f"in application [magenta]{app_id}[/magenta]."
+    )

nextmv/cli/cloud/shadow/update.py

@@ -0,0 +1,95 @@
+"""
+This module defines the cloud shadow 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 AppIDOption, ProfileOption, ShadowTestIDOption
+
+# Set up subcommand application.
+app = typer.Typer()
+
+
+@app.command()
+def update(
+    app_id: AppIDOption,
+    shadow_test_id: ShadowTestIDOption,
+    description: Annotated[
+        str | None,
+        typer.Option(
+            "--description",
+            "-d",
+            help="Updated description of the shadow test.",
+            metavar="DESCRIPTION",
+        ),
+    ] = None,
+    name: Annotated[
+        str | None,
+        typer.Option(
+            "--name",
+            "-n",
+            help="Updated name of the shadow test.",
+            metavar="NAME",
+        ),
+    ] = None,
+    output: Annotated[
+        str | None,
+        typer.Option(
+            "--output",
+            "-o",
+            help="Saves the updated shadow test information to this location.",
+            metavar="OUTPUT_PATH",
+        ),
+    ] = None,
+    profile: ProfileOption = None,
+) -> None:
+    """
+    Update a Nextmv Cloud shadow test.
+
+    Update the name and/or description of a shadow test. Any fields not
+    specified will remain unchanged.
+
+    [bold][underline]Examples[/underline][/bold]
+
+    - Update the name of a shadow test.
+        $ [green]nextmv cloud shadow update --app-id hare-app --shadow-test-id carrot-feast \\
+            --name "Spring Carrot Harvest"[/green]
+
+    - Update the description of a shadow test.
+        $ [green]nextmv cloud shadow update --app-id hare-app --shadow-test-id bunny-hop-routes \\
+            --description "Optimizing hop paths through the meadow"[/green]
+
+    - Update both name and description and save the result.
+        $ [green]nextmv cloud shadow update --app-id hare-app --shadow-test-id lettuce-delivery \\
+            --name "Warren Lettuce Express" --description "Fast lettuce delivery to all burrows" \\
+            --output updated-shadow-test.json[/green]
+    """
+
+    cloud_app = build_app(app_id=app_id, profile=profile)
+
+    in_progress(msg="Updating shadow test...")
+    shadow_test = cloud_app.update_shadow_test(
+        shadow_test_id=shadow_test_id,
+        name=name,
+        description=description,
+    )
+
+    shadow_test_dict = shadow_test.to_dict()
+    success(
+        f"Shadow test [magenta]{shadow_test_id}[/magenta] updated successfully "
+        f"in application [magenta]{app_id}[/magenta]."
+    )
+
+    if output is not None and output != "":
+        with open(output, "w") as f:
+            json.dump(shadow_test_dict, f, indent=2)
+
+        success(msg=f"Updated shadow test information saved to [magenta]{output}[/magenta].")
+        return
+
+    print_json(shadow_test_dict)

nextmv/cli/cloud/upload/__init__.py

@@ -0,0 +1,22 @@
+"""
+This module defines the cloud upload command tree for the Nextmv CLI.
+"""
+
+import typer
+
+from nextmv.cli.cloud.upload.create import app as create_app
+
+# Set up subcommand application.
+app = typer.Typer()
+app.add_typer(create_app)
+
+
+@app.callback()
+def callback() -> None:
+    """
+    Create temporary upload URLs for Nextmv Cloud applications.
+
+    When data is too large, or you are working with multiple files, you can use
+    upload URLs to upload data directly to Nextmv Cloud storage.
+    """
+    pass

nextmv/cli/cloud/upload/create.py

@@ -0,0 +1,39 @@
+"""
+This module defines the cloud upload create command for the Nextmv CLI.
+"""
+
+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 AppIDOption, ProfileOption
+
+# Set up subcommand application.
+app = typer.Typer()
+
+
+@app.command()
+def create(
+    app_id: AppIDOption,
+    profile: ProfileOption = None,
+) -> None:
+    """
+    Create a new Nextmv Cloud application upload URL.
+
+    [bold][underline]Examples[/underline][/bold]
+
+    - Create an upload URL for application [magenta]hare-app[/magenta].
+        $ [green]nextmv cloud upload create --app-id hare-app[/green]
+
+    - Create an upload URL for application [magenta]hare-app[/magenta] using profile [magenta]hare[/magenta].
+        $ [green]nextmv cloud upload create --app-id hare-app --profile hare[/green]
+    """
+
+    cloud_app = build_app(app_id=app_id, profile=profile)
+    in_progress(msg="Creating upload URL...")
+    upload_url = cloud_app.upload_url()
+    success(
+        f"Upload URL created for application [magenta]{app_id}[/magenta]. "
+        "This URL is valid for [magenta]10 minutes[/magenta]."
+    )
+    print_json(upload_url.to_dict())

nextmv/cli/cloud/version/__init__.py

@@ -0,0 +1,33 @@
+"""
+This module defines the cloud version command tree for the Nextmv CLI.
+"""
+
+import typer
+
+from nextmv.cli.cloud.version.create import app as create_app
+from nextmv.cli.cloud.version.delete import app as delete_app
+from nextmv.cli.cloud.version.exists import app as exists_app
+from nextmv.cli.cloud.version.get import app as get_app
+from nextmv.cli.cloud.version.list import app as list_app
+from nextmv.cli.cloud.version.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(update_app)
+
+
+@app.callback()
+def callback() -> None:
+    """
+    Create and manage Nextmv Cloud application versions.
+
+    A version represents a snapshot of an application's code at a specific
+    point in time. Versions are used to track changes to the decision model.
+    You can think of versions as Git tags for your Nextmv Cloud applications.
+    """
+    pass

nextmv/cli/cloud/version/create.py

@@ -0,0 +1,97 @@
+"""
+This module defines the cloud version create command for the Nextmv CLI.
+"""
+
+from typing import Annotated
+
+import typer
+
+from nextmv.cli.configuration.config import build_app
+from nextmv.cli.message import in_progress, print_json
+from nextmv.cli.options import AppIDOption, ProfileOption
+
+# Set up subcommand application.
+app = typer.Typer()
+
+
+@app.command()
+def create(
+    app_id: AppIDOption,
+    description: Annotated[
+        str | None,
+        typer.Option(
+            "--description",
+            "-d",
+            help="An optional description for the version.",
+            metavar="DESCRIPTION",
+        ),
+    ] = None,
+    exist_ok: Annotated[
+        bool,
+        typer.Option(
+            "--exist-ok",
+            "-e",
+            help="If a version with the given ID already exists, do not raise an error, and simply return it.",
+        ),
+    ] = False,
+    name: Annotated[
+        str | None,
+        typer.Option(
+            "--name",
+            "-n",
+            help="A name for the version. If a name is not provided, the version ID will be used as the name.",
+            metavar="NAME",
+        ),
+    ] = None,
+    version_id: Annotated[
+        str | None,
+        typer.Option(
+            "--version-id",
+            "-v",
+            help="The ID to assign to the new version. If not provided, a random ID will be generated.",
+            envvar="NEXTMV_VERSION_ID",
+            metavar="VERSION_ID",
+        ),
+    ] = None,
+    profile: ProfileOption = None,
+) -> None:
+    """
+    Create a new Nextmv Cloud application version.
+
+    Use the [code]--exist-ok[/code] flag to avoid errors when creating a
+    version with an ID that already exists. This is useful for scripts that
+    need to ensure a version exists without worrying about whether it was
+    created previously.
+
+    [bold][underline]Examples[/underline][/bold]
+
+    - Create a version for application [magenta]hare-app[/magenta]. A random ID will be generated.
+        $ [green]nextmv cloud version create --app-id hare-app[/green]
+
+    - Create a version with a specific name.
+        $ [green]nextmv cloud version create --app-id hare-app --name "v1.0.0"[/green]
+
+    - Create a version with a specific ID.
+        $ [green]nextmv cloud version create --app-id hare-app --version-id v1[/green]
+
+    - Create a version with a name and description.
+        $ [green]nextmv cloud version create --app-id hare-app --name "v1.0.0" \\
+            --description "Initial release with routing optimization"[/green]
+
+    - Create a version, or get it if it already exists.
+        $ [green]nextmv cloud version create --app-id hare-app --version-id v1 --exist-ok[/green]
+    """
+
+    cloud_app = build_app(app_id=app_id, profile=profile)
+    if exist_ok:
+        in_progress(msg="Creating or getting version...")
+    else:
+        in_progress(msg="Creating version...")
+
+    version = cloud_app.new_version(
+        id=version_id,
+        name=name,
+        description=description,
+        exist_ok=exist_ok,
+    )
+    print_json(version.to_dict())

nextmv/cli/cloud/version/delete.py

@@ -0,0 +1,62 @@
+"""
+This module defines the cloud version delete command for the Nextmv CLI.
+"""
+
+from typing import Annotated
+
+import typer
+from rich.prompt import Confirm
+
+from nextmv.cli.configuration.config import build_app
+from nextmv.cli.message import info, success
+from nextmv.cli.options import AppIDOption, ProfileOption, VersionIDOption
+
+# Set up subcommand application.
+app = typer.Typer()
+
+
+@app.command()
+def delete(
+    app_id: AppIDOption,
+    version_id: VersionIDOption,
+    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 version.
+
+    This action is permanent and cannot be undone. Use the [code]--yes[/code]
+    flag to skip the confirmation prompt.
+
+    [bold][underline]Examples[/underline][/bold]
+
+    - Delete the version with the ID [magenta]v1[/magenta] from application [magenta]hare-app[/magenta].
+        $ [green]nextmv cloud version delete --app-id hare-app --version-id v1[/green]
+
+    - Delete the version without confirmation prompt.
+        $ [green]nextmv cloud version delete --app-id hare-app --version-id v1 --yes[/green]
+    """
+
+    if not yes:
+        confirm = Confirm.ask(
+            f"Are you sure you want to delete version [magenta]{version_id}[/magenta] "
+            f"from application [magenta]{app_id}[/magenta]? This action cannot be undone.",
+            default=False,
+        )
+
+        if not confirm:
+            info(msg=f"Version [magenta]{version_id}[/magenta] will not be deleted.", emoji=":bulb:")
+            return
+
+    cloud_app = build_app(app_id=app_id, profile=profile)
+    cloud_app.delete_version(version_id=version_id)
+    success(
+        f"Version [magenta]{version_id}[/magenta] deleted successfully from application [magenta]{app_id}[/magenta]."
+    )

nextmv/cli/cloud/version/exists.py

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

nextmv/cli/cloud/version/get.py

@@ -0,0 +1,62 @@
+"""
+This module defines the cloud version get 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 AppIDOption, ProfileOption, VersionIDOption
+
+# Set up subcommand application.
+app = typer.Typer()
+
+
+@app.command()
+def get(
+    app_id: AppIDOption,
+    version_id: VersionIDOption,
+    output: Annotated[
+        str | None,
+        typer.Option(
+            "--output",
+            "-o",
+            help="Saves the version information to this location.",
+            metavar="OUTPUT_PATH",
+        ),
+    ] = None,
+    profile: ProfileOption = None,
+) -> None:
+    """
+    Get a Nextmv Cloud application version.
+
+    This command is useful to get the attributes of an existing Nextmv Cloud
+    application version by its ID.
+
+    [bold][underline]Examples[/underline][/bold]
+
+    - Get the version with the ID [magenta]v1[/magenta] from application [magenta]hare-app[/magenta].
+        $ [green]nextmv cloud version get --app-id hare-app --version-id v1[/green]
+
+    - Get the version with the ID [magenta]v1[/magenta] and save the information to a
+      [magenta]version.json[/magenta] file.
+        $ [green]nextmv cloud version get --app-id hare-app --version-id v1 --output version.json[/green]
+    """
+
+    cloud_app = build_app(app_id=app_id, profile=profile)
+    in_progress(msg="Getting version...")
+    version = cloud_app.version(version_id=version_id)
+    version_dict = version.to_dict()
+
+    if output is not None and output != "":
+        with open(output, "w") as f:
+            json.dump(version_dict, f, indent=2)
+
+        success(msg=f"Version information saved to [magenta]{output}[/magenta].")
+
+        return
+
+    print_json(version_dict)

nextmv/cli/cloud/version/list.py

@@ -0,0 +1,60 @@
+"""
+This module defines the cloud version list 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 AppIDOption, ProfileOption
+
+# Set up subcommand application.
+app = typer.Typer()
+
+
+@app.command()
+def list(
+    app_id: AppIDOption,
+    output: Annotated[
+        str | None,
+        typer.Option(
+            "--output",
+            "-o",
+            help="Saves the version list information to this location.",
+            metavar="OUTPUT_PATH",
+        ),
+    ] = None,
+    profile: ProfileOption = None,
+) -> None:
+    """
+    List all versions of a Nextmv Cloud application.
+
+    [bold][underline]Examples[/underline][/bold]
+
+    - List all versions of application [magenta]hare-app[/magenta].
+        $ [green]nextmv cloud version list --app-id hare-app[/green]
+
+    - List all versions using the profile named [magenta]hare[/magenta].
+        $ [green]nextmv cloud version list --app-id hare-app --profile hare[/green]
+
+    - List all versions and save the information to a [magenta]versions.json[/magenta] file.
+        $ [green]nextmv cloud version list --app-id hare-app --output versions.json[/green]
+    """
+
+    cloud_app = build_app(app_id=app_id, profile=profile)
+    in_progress(msg="Listing versions...")
+    versions = cloud_app.list_versions()
+    versions_dicts = [version.to_dict() for version in versions]
+
+    if output is not None and output != "":
+        with open(output, "w") as f:
+            json.dump(versions_dicts, f, indent=2)
+
+        success(msg=f"Version list information saved to [magenta]{output}[/magenta].")
+
+        return
+
+    print_json(versions_dicts)

nextmv/cli/cloud/version/update.py

@@ -0,0 +1,92 @@
+"""
+This module defines the cloud version 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 error, print_json, success
+from nextmv.cli.options import AppIDOption, ProfileOption, VersionIDOption
+
+# Set up subcommand application.
+app = typer.Typer()
+
+
+@app.command()
+def update(
+    app_id: AppIDOption,
+    version_id: VersionIDOption,
+    description: Annotated[
+        str | None,
+        typer.Option(
+            "--description",
+            "-d",
+            help="A new description for the version.",
+            metavar="DESCRIPTION",
+        ),
+    ] = None,
+    name: Annotated[
+        str | None,
+        typer.Option(
+            "--name",
+            "-n",
+            help="A new name for the version.",
+            metavar="NAME",
+        ),
+    ] = None,
+    output: Annotated[
+        str | None,
+        typer.Option(
+            "--output",
+            "-o",
+            help="Saves the updated version information to this location.",
+            metavar="OUTPUT_PATH",
+        ),
+    ] = None,
+    profile: ProfileOption = None,
+) -> None:
+    """
+    Updates a Nextmv Cloud application version.
+
+    [bold][underline]Examples[/underline][/bold]
+
+    - Update a version's name.
+        $ [green]nextmv cloud version update --app-id hare-app --version-id v1 --name "Version 1.0"[/green]
+
+    - Update a version's description.
+        $ [green]nextmv cloud version update --app-id hare-app --version-id v1 \\
+            --description "Initial stable release"[/green]
+
+    - Update a version's name and description at once.
+        $ [green]nextmv cloud version update --app-id hare-app --version-id v1 \\
+            --name "Version 1.0" --description "Initial stable release"[/green]
+
+    - Update a version and save the updated information to a [magenta]updated_version.json[/magenta] file.
+        $ [green]nextmv cloud version update --app-id hare-app --version-id v1 \\
+            --name "Version 1.0" --output updated_version.json[/green]
+    """
+
+    if name is None and description is None:
+        error("Provide at least one option to update: [code]--name[/code] or [code]--description[/code].")
+
+    cloud_app = build_app(app_id=app_id, profile=profile)
+    updated_version = cloud_app.update_version(
+        version_id=version_id,
+        name=name,
+        description=description,
+    )
+    success(f"Version [magenta]{version_id}[/magenta] updated successfully in application [magenta]{app_id}[/magenta].")
+    updated_version_dict = updated_version.to_dict()
+
+    if output is not None and output != "":
+        with open(output, "w") as f:
+            json.dump(updated_version_dict, f, indent=2)
+
+        success(msg=f"Updated version information saved to [magenta]{output}[/magenta].")
+
+        return
+
+    print_json(updated_version_dict)

nextmv/cli/community/__init__.py

@@ -0,0 +1,24 @@
+"""
+This module defines the community command tree for the Nextmv CLI.
+"""
+
+import typer
+
+from nextmv.cli.community.clone import app as clone_app
+from nextmv.cli.community.list import app as list_app
+
+# Set up subcommand application.
+app = typer.Typer()
+app.add_typer(list_app)
+app.add_typer(clone_app)
+
+
+@app.callback()
+def callback() -> None:
+    """
+    Interact with community apps, which are pre-built decision models.
+
+    Community apps are maintained in the following GitHub repository:
+    [link=https://github.com/nextmv-io/community-apps][bold]nextmv-io/community-apps[/bold][/link].
+    """
+    pass