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

nextmv/cli/cloud/app/get.py

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

nextmv/cli/cloud/app/list.py

@@ -0,0 +1,61 @@
+"""
+This module defines the cloud app list 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 ProfileOption
+from nextmv.cloud.application import list_applications
+
+# Set up subcommand application.
+app = typer.Typer()
+
+
+@app.command()
+def list(
+    output: Annotated[
+        str | None,
+        typer.Option(
+            "--output",
+            "-o",
+            help="Saves the app list information to this location.",
+            metavar="OUTPUT_PATH",
+        ),
+    ] = None,
+    profile: ProfileOption = None,
+) -> None:
+    """
+    List all Nextmv Cloud applications.
+
+    [bold][underline]Examples[/underline][/bold]
+
+    - List all applications.
+        $ [green]nextmv cloud app list[/green]
+
+    - List all applications using the profile named [magenta]hare[/magenta].
+        $ [green]nextmv cloud app list --profile hare[/green]
+
+    - List all applications and save the information to an [magenta]apps.json[/magenta] file.
+        $ [green]nextmv cloud app list --output apps.json[/green]
+    """
+
+    client = build_client(profile)
+    in_progress(msg="Listing applications...")
+
+    cloud_apps = list_applications(client)
+    cloud_apps_dicts = [app.to_dict() for app in cloud_apps]
+
+    if output is not None and output != "":
+        with open(output, "w") as f:
+            json.dump(cloud_apps_dicts, f, indent=2)
+
+        success(msg=f"Application list information saved to [magenta]{output}[/magenta].")
+
+        return
+
+    print_json(cloud_apps_dicts)

nextmv/cli/cloud/app/push.py

@@ -0,0 +1,137 @@
+"""
+This module defines the cloud app push command for the Nextmv CLI.
+"""
+
+from typing import Annotated
+
+import typer
+
+from nextmv.cli.configuration.config import build_app
+from nextmv.cli.options import AppIDOption, ProfileOption
+from nextmv.manifest import Manifest
+
+# Set up subcommand application.
+app = typer.Typer()
+
+
+@app.command()
+def push(
+    app_id: AppIDOption,
+    app_dir: Annotated[
+        str | None,
+        typer.Option(
+            "--app-dir",
+            "-d",
+            help="The path to the application's root directory.",
+            metavar="APP_DIR",
+        ),
+    ] = ".",
+    manifest: Annotated[
+        str | None,
+        typer.Option(
+            "--manifest",
+            "-m",
+            help="Path to the application manifest file ([magenta]app.yaml[/magenta]).",
+            metavar="MANIFEST_PATH",
+        ),
+    ] = None,
+    no_version: Annotated[
+        bool,
+        typer.Option(
+            "--no-version",
+            "-n",
+            help="The application will be pushed without creating a new version. "
+            "Default is to create a new version on each push.",
+            rich_help_panel="Versioning control",
+        ),
+    ] = False,
+    version_id: Annotated[
+        str | None,
+        typer.Option(
+            "--version-id",
+            "-v",
+            help="Custom version ID when pushing the application. Automatically generated if not provided.",
+            rich_help_panel="Versioning control",
+            metavar="VERSION_ID",
+        ),
+    ] = None,
+    version_name: Annotated[
+        str | None,
+        typer.Option(
+            "--version-name",
+            "-e",
+            help="Custom version name when pushing the application. Automatically generated if not provided.",
+            rich_help_panel="Versioning control",
+            metavar="VERSION_NAME",
+        ),
+    ] = None,
+    version_description: Annotated[
+        str | None,
+        typer.Option(
+            "--version-description",
+            "-r",
+            help="Custom version description when pushing the application. Automatically generated if not provided.",
+            rich_help_panel="Versioning control",
+            metavar="VERSION_DESCRIPTION",
+        ),
+    ] = None,
+    profile: ProfileOption = None,
+) -> None:
+    """
+    Push (deploy) a Nextmv application to Nextmv Cloud.
+
+    Use the [code]--app-dir[/code] option to specify the path to your
+    application's root directory. By default, the current working directory is
+    used.
+
+    You can also provide a custom manifest file using the [code]--manifest[/code]
+    option. If not provided, the CLI will look for a file named [magenta]app.yaml[/magenta]
+    in the application's root.
+
+    The default behavior of this command is to create a new application version
+    [italic]after[/italic] the app has been pushed. You can use the
+    [code]--no-version[/code] option to skip this step. The
+    [code]--version-...[/code] options allow you to customize the attributes of
+    the version that is created. If any of these options are not provided,
+    automatically generated values will be used.
+
+    [bold][underline]Examples[/underline][/bold]
+
+    - Push an application, with ID [magenta]hare-app[/magenta], from the current directory.
+        $ [green]nextmv cloud app push --app-id hare-app[/green]
+
+    - Push an application, with ID [magenta]hare-app[/magenta], from the [magenta]./my-app[/magenta] directory.
+        $ [green]nextmv cloud app push --app-id hare-app --app-dir ./my-app[/green]
+
+    - Push an application, with ID [magenta]hare-app[/magenta], using a custom manifest file.
+        $ [green]nextmv cloud app push --app-id hare-app --manifest ./custom-manifest.yaml[/green]
+
+    - Push an application, with ID [magenta]hare-app[/magenta], from a specific
+      [magenta]./my-app[/magenta] directory with a custom manifest under [magenta]./custom-manifest.yaml[/magenta].
+        $ [green]nextmv cloud app push --app-id hare-app --app-dir ./my-app \\
+            --manifest ./custom-manifest.yaml[/green]
+
+    - Push an application without creating a new version.
+        $ [green]nextmv cloud app push --app-id hare-app --no-version[/green]
+
+    - Push an application with a custom version ID.
+        $ [green]nextmv cloud app push --app-id hare-app --version-id v1.0.0[/green]
+
+    - Push an application with custom version ID, name, and description.
+        $ [green]nextmv cloud app push --app-id hare-app --version-id v1.0.0 \\
+            --version-name "Release 1.0.0" \\
+            --version-description "First stable release"[/green]
+    """
+
+    cloud_app = build_app(app_id=app_id, profile=profile)
+    loaded_manifest = Manifest.from_yaml(dirpath=manifest) if manifest is not None and manifest != "" else None
+    cloud_app.push(
+        manifest=loaded_manifest,
+        app_dir=app_dir,
+        verbose=True,
+        rich_print=True,
+        no_version=no_version,
+        version_id=version_id,
+        version_name=version_name,
+        version_description=version_description,
+    )

nextmv/cli/cloud/app/update.py

@@ -0,0 +1,124 @@
+"""
+This module defines the cloud app 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
+
+# Set up subcommand application.
+app = typer.Typer()
+
+
+@app.command()
+def update(
+    app_id: AppIDOption,
+    default_experiment_instance: Annotated[
+        str | None,
+        typer.Option(
+            "--default-experiment-instance",
+            "-x",
+            help="A new 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="A new default instance ID for the application.",
+            metavar="DEFAULT_INSTANCE_ID",
+        ),
+    ] = None,
+    description: Annotated[
+        str | None,
+        typer.Option(
+            "--description",
+            "-d",
+            help="A new description for the application.",
+            metavar="DESCRIPTION",
+        ),
+    ] = None,
+    name: Annotated[
+        str | None,
+        typer.Option(
+            "--name",
+            "-n",
+            help="A new name for the application.",
+            metavar="NAME",
+        ),
+    ] = None,
+    output: Annotated[
+        str | None,
+        typer.Option(
+            "--output",
+            "-o",
+            help="Saves the updated app information to this location.",
+            metavar="OUTPUT_PATH",
+        ),
+    ] = None,
+    profile: ProfileOption = None,
+) -> None:
+    """
+    Updates a Nextmv Cloud application.
+
+    Please note that you cannot change the type of an application, you must
+    create a new one.
+
+    [bold][underline]Examples[/underline][/bold]
+
+    - Update an application's name.
+        $ [green]nextmv cloud app update --app-id hare-app --name "New Hare App"[/green]
+
+    - Update an application's description.
+        $ [green]nextmv cloud app update --app-id hare-app --name "Hare App" \\
+            --description "An updated description for routing hares"[/green]
+
+    - Update an application's default instance ID.
+        $ [green]nextmv cloud app update --app-id hare-app --name "Hare App" \\
+            --default-instance-id burrow[/green]
+
+    - Update an application's default experiment instance.
+        $ [green]nextmv cloud app update --app-id hare-app --name "Hare App" \\
+            --default-experiment-instance experiment-v1[/green]
+
+    - Update multiple application properties at once.
+        $ [green]nextmv cloud app update --app-id hare-app --name "Hare App" \\
+            --description "Updated description" --default-instance-id burrow \\
+            --default-experiment-instance experiment-v1[/green]
+
+    - Update an application and save the updated information to an [magenta]updated_app.json[/magenta] file.
+        $ [green]nextmv cloud app update --app-id hare-app --name "New Hare App" --output updated_app.json[/green]
+    """
+
+    if name is None and description is None and default_instance_id is None and default_experiment_instance is None:
+        error(
+            "Provide at least one option to update: [code]--name[/code], [code]--description[/code], "
+            "[code]--default-instance-id[/code], or [code]--default-experiment-instance[/code]."
+        )
+
+    cloud_app = build_app(app_id=app_id, profile=profile)
+    updated_app = cloud_app.update(
+        name=name,
+        description=description,
+        default_instance_id=default_instance_id,
+        default_experiment_instance=default_experiment_instance,
+    )
+    success(f"Application [magenta]{app_id}[/magenta] updated successfully.")
+    updated_app_dict = updated_app.to_dict()
+
+    if output is not None and output != "":
+        with open(output, "w") as f:
+            json.dump(updated_app_dict, f, indent=2)
+
+        success(msg=f"Updated application information saved to [magenta]{output}[/magenta].")
+
+        return
+
+    print_json(updated_app_dict)

nextmv/cli/cloud/batch/__init__.py

@@ -0,0 +1,29 @@
+"""
+This module defines the cloud batch command tree for the Nextmv CLI.
+"""
+
+import typer
+
+from nextmv.cli.cloud.batch.create import app as create_app
+from nextmv.cli.cloud.batch.delete import app as delete_app
+from nextmv.cli.cloud.batch.get import app as get_app
+from nextmv.cli.cloud.batch.list import app as list_app
+from nextmv.cli.cloud.batch.metadata import app as metadata_app
+from nextmv.cli.cloud.batch.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(list_app)
+app.add_typer(metadata_app)
+app.add_typer(update_app)
+
+
+@app.callback()
+def callback() -> None:
+    """
+    Create and manage Nextmv Cloud batch experiments.
+    """
+    pass