nextmv 1.0.0__py3-none-any.whl → 1.0.0.dev0__py3-none-any.whl

nextmv/cli/cloud/switchback/list.py

@@ -1,63 +0,0 @@
-"""
-This module defines the cloud switchback 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 list of switchback tests to this location.",
-            metavar="OUTPUT_PATH",
-        ),
-    ] = None,
-    profile: ProfileOption = None,
-) -> None:
-    """
-    List all Nextmv Cloud switchback tests for an application.
-
-    This command retrieves all switchback tests associated with the specified
-    application.
-
-    [bold][underline]Examples[/underline][/bold]
-
-    - List all switchback tests for application [magenta]hare-app[/magenta].
-        $ [dim]nextmv cloud switchback list --app-id hare-app[/dim]
-
-    - List all switchback tests and save to a file.
-        $ [dim]nextmv cloud switchback list --app-id hare-app --output tests.json[/dim]
-
-    - List all switchback tests using a specific profile.
-        $ [dim]nextmv cloud switchback list --app-id hare-app --profile prod[/dim]
-    """
-
-    cloud_app = build_app(app_id=app_id, profile=profile)
-    in_progress(msg="Listing switchback tests...")
-    switchback_tests = cloud_app.list_switchback_tests()
-    switchback_tests_dict = [test.to_dict() for test in switchback_tests]
-
-    if output is not None and output != "":
-        with open(output, "w") as f:
-            json.dump(switchback_tests_dict, f, indent=2)
-
-        success(msg=f"Switchback tests list saved to [magenta]{output}[/magenta].")
-
-        return
-
-    print_json(switchback_tests_dict)

nextmv/cli/cloud/switchback/metadata.py

@@ -1,68 +0,0 @@
-"""
-This module defines the cloud switchback metadata 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, SwitchbackTestIDOption
-
-# Set up subcommand application.
-app = typer.Typer()
-
-
-@app.command()
-def metadata(
-    app_id: AppIDOption,
-    switchback_test_id: SwitchbackTestIDOption,
-    output: Annotated[
-        str | None,
-        typer.Option(
-            "--output",
-            "-o",
-            help="Saves the switchback test metadata to this location.",
-            metavar="OUTPUT_PATH",
-        ),
-    ] = None,
-    profile: ProfileOption = None,
-) -> None:
-    """
-    Get metadata for a Nextmv Cloud switchback test.
-
-    This command retrieves metadata for a specific switchback test, including
-    status, creation date, and other high-level information without the full
-    run details.
-
-    [bold][underline]Examples[/underline][/bold]
-
-    - Get metadata for switchback test [magenta]bunny-warren-optimization[/magenta] from application
-      [magenta]hare-app[/magenta].
-        $ [dim]nextmv cloud switchback metadata --app-id hare-app \\
-            --switchback-test-id bunny-warren-optimization[/dim]
-
-    - Get metadata and save to a file.
-        $ [dim]nextmv cloud switchback metadata --app-id hare-app --switchback-test-id lettuce-delivery \\
-            --output metadata.json[/dim]
-
-    - Get metadata using a specific profile.
-        $ [dim]nextmv cloud switchback metadata --app-id hare-app --switchback-test-id hop-schedule \\
-            --profile prod[/dim]
-    """
-
-    cloud_app = build_app(app_id=app_id, profile=profile)
-    in_progress(msg="Getting switchback test metadata...")
-    switchback_metadata = cloud_app.switchback_test_metadata(switchback_test_id=switchback_test_id)
-    switchback_metadata_dict = switchback_metadata.to_dict()
-
-    if output is not None and output != "":
-        with open(output, "w") as f:
-            json.dump(switchback_metadata_dict, f, indent=2)
-
-        success(msg=f"Switchback test metadata saved to [magenta]{output}[/magenta].")
-        return
-
-    print_json(switchback_metadata_dict)

nextmv/cli/cloud/switchback/start.py

@@ -1,43 +0,0 @@
-"""
-This module defines the cloud switchback start 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, SwitchbackTestIDOption
-
-# Set up subcommand application.
-app = typer.Typer()
-
-
-@app.command()
-def start(
-    app_id: AppIDOption,
-    switchback_test_id: SwitchbackTestIDOption,
-    profile: ProfileOption = None,
-) -> None:
-    """
-    Starts a Nextmv Cloud switchback test.
-
-    Before starting a switchback test, it must be created in draft state. You
-    may use the [code]nextmv cloud switchback create[/code] command to create a
-    new switchback test. Alternatively, define a --start when using the
-    [code]nextmv cloud switchback create[/code] command to have the switchback
-    test start automatically at a specific time.
-
-    [bold][underline]Examples[/underline][/bold]
-
-    - Start the switchback test with the ID [magenta]hop-analysis[/magenta] from application
-      [magenta]hare-app[/magenta].
-        $ [dim]nextmv cloud switchback start --app-id hare-app --switchback-test-id hop-analysis[/dim]
-    """
-
-    in_progress(msg="Starting switchback test...")
-    cloud_app = build_app(app_id=app_id, profile=profile)
-    cloud_app.start_switchback_test(switchback_test_id=switchback_test_id)
-    success(
-        f"Switchback test [magenta]{switchback_test_id}[/magenta] started successfully "
-        f"in application [magenta]{app_id}[/magenta]."
-    )

nextmv/cli/cloud/switchback/stop.py

@@ -1,53 +0,0 @@
-"""
-This module defines the cloud switchback stop command for the Nextmv CLI.
-"""
-
-from typing import Annotated
-
-import typer
-
-from nextmv.cli.configuration.config import build_app
-from nextmv.cli.message import enum_values, in_progress, success
-from nextmv.cli.options import AppIDOption, ProfileOption, SwitchbackTestIDOption
-from nextmv.cloud.shadow import StopIntent
-
-# Set up subcommand application.
-app = typer.Typer()
-
-
-@app.command()
-def stop(
-    app_id: AppIDOption,
-    intent: Annotated[
-        StopIntent,
-        typer.Option(
-            "--intent",
-            "-i",
-            help=f"Intent for stopping the switchback test. Allowed values are: {enum_values(StopIntent)}.",
-            metavar="INTENT",
-        ),
-    ],
-    switchback_test_id: SwitchbackTestIDOption,
-    profile: ProfileOption = None,
-) -> None:
-    """
-    Stops a Nextmv Cloud switchback test.
-
-    Before stopping a switchback test, it must be in a started state. Experiments
-    in a [magenta]draft[/magenta] state, that haven't started, can be deleted
-    with the [code]nextmv cloud switchback delete[/code] command.
-
-    [bold][underline]Examples[/underline][/bold]
-
-    - Stop the switchback test with the ID [magenta]hop-analysis[/magenta] from application
-      [magenta]hare-app[/magenta].
-        $ [dim]nextmv cloud switchback stop --app-id hare-app --switchback-test-id hop-analysis[/dim]
-    """
-
-    in_progress(msg="Stopping switchback test...")
-    cloud_app = build_app(app_id=app_id, profile=profile)
-    cloud_app.stop_switchback_test(switchback_test_id=switchback_test_id, intent=StopIntent(intent))
-    success(
-        f"Switchback test [magenta]{switchback_test_id}[/magenta] stopped successfully "
-        f"in application [magenta]{app_id}[/magenta]."
-    )

nextmv/cli/cloud/switchback/update.py

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

nextmv/cli/confirm.py

@@ -1,34 +0,0 @@
-import sys
-
-from rich.prompt import Confirm
-
-
-def get_confirmation(msg: str, default: bool = False) -> bool:
-    """
-    Method to get a yes/no confirmation from the user.
-
-    Parameters
-    ----------
-    msg : str
-        The message to display to the user.
-    default : bool, optional
-        The default value if the user just presses Enter. Default is False.
-
-    Returns
-    -------
-    bool
-        True if the user confirmed, False otherwise.
-    """
-
-    # If this is not an interactive terminal, do not ask for confirmation, to
-    # avoid hanging indefinitely waiting for a user response.
-    if not sys.stdin.isatty():
-        return default
-
-    return Confirm.ask(
-        msg,
-        default=default,
-        case_sensitive=False,
-        show_default=True,
-        show_choices=True,
-    )

nextmv/cloud/application/_shadow.py

@@ -1,320 +0,0 @@
-"""
-Application mixin for managing shadow tests.
-"""
-
-from typing import TYPE_CHECKING
-
-from nextmv.cloud.shadow import ShadowTest, ShadowTestMetadata, StartEvents, StopIntent, TerminationEvents
-from nextmv.run import Run
-from nextmv.safe import safe_id
-
-if TYPE_CHECKING:
-    from . import Application
-
-
-class ApplicationShadowMixin:
-    """
-    Mixin class for managing shadow tests within an application.
-    """
-
-    def shadow_test(self: "Application", shadow_test_id: str) -> ShadowTest:
-        """
-        Get a shadow test. This method also returns the runs of the shadow
-        test under the `.runs` attribute.
-
-        Parameters
-        ----------
-        shadow_test_id : str
-            ID of the shadow test.
-
-        Returns
-        -------
-        ShadowTest
-            The requested shadow test details.
-
-        Raises
-        ------
-        requests.HTTPError
-            If the response status code is not 2xx.
-
-        Examples
-        --------
-        >>> shadow_test = app.shadow_test("shadow-123")
-        >>> print(shadow_test.name)
-        'My Shadow Test'
-        """
-
-        response = self.client.request(
-            method="GET",
-            endpoint=f"{self.experiments_endpoint}/shadow/{shadow_test_id}",
-        )
-
-        exp = ShadowTest.from_dict(response.json())
-
-        runs_response = self.client.request(
-            method="GET",
-            endpoint=f"{self.experiments_endpoint}/shadow/{shadow_test_id}/runs",
-        )
-
-        runs = [Run.from_dict(run) for run in runs_response.json().get("runs", [])]
-        exp.runs = runs
-
-        return exp
-
-    def shadow_test_metadata(self: "Application", shadow_test_id: str) -> ShadowTestMetadata:
-        """
-        Get metadata for a shadow test.
-
-        Parameters
-        ----------
-        shadow_test_id : str
-            ID of the shadow test.
-
-        Returns
-        -------
-        ShadowTestMetadata
-            The requested shadow test metadata.
-
-        Raises
-        ------
-        requests.HTTPError
-            If the response status code is not 2xx.
-
-        Examples
-        --------
-        >>> metadata = app.shadow_test_metadata("shadow-123")
-        >>> print(metadata.name)
-        'My Shadow Test'
-        """
-
-        response = self.client.request(
-            method="GET",
-            endpoint=f"{self.experiments_endpoint}/shadow/{shadow_test_id}/metadata",
-        )
-
-        return ShadowTestMetadata.from_dict(response.json())
-
-    def delete_shadow_test(self: "Application", shadow_test_id: str) -> None:
-        """
-        Delete a shadow test.
-
-        Deletes a shadow test along with all the associated information,
-        such as its runs.
-
-        Parameters
-        ----------
-        shadow_test_id : str
-            ID of the shadow test to delete.
-
-        Raises
-        ------
-        requests.HTTPError
-            If the response status code is not 2xx.
-
-        Examples
-        --------
-        >>> app.delete_shadow_test("shadow-123")
-        """
-
-        _ = self.client.request(
-            method="DELETE",
-            endpoint=f"{self.experiments_endpoint}/shadow/{shadow_test_id}",
-        )
-
-    def list_shadow_tests(self: "Application") -> list[ShadowTest]:
-        """
-        List all shadow tests.
-
-        Returns
-        -------
-        list[ShadowTest]
-            List of shadow tests.
-
-        Raises
-        ------
-        requests.HTTPError
-            If the response status code is not 2xx.
-        """
-
-        response = self.client.request(
-            method="GET",
-            endpoint=f"{self.experiments_endpoint}/shadow",
-        )
-
-        return [ShadowTest.from_dict(shadow_test) for shadow_test in response.json()]
-
-    def new_shadow_test(
-        self: "Application",
-        comparisons: dict[str, list[str]],
-        termination_events: TerminationEvents,
-        shadow_test_id: str | None = None,
-        name: str | None = None,
-        description: str | None = None,
-        start_events: StartEvents | None = None,
-    ) -> ShadowTest:
-        """
-        Create a new shadow test in draft mode. Shadow tests are experiments
-        that run instances in parallel to compare their results.
-
-        Use the `comparisons` parameter to define how to set up instance
-        comparisons. The keys of the `comparisons` dictionary are the baseline
-        instance IDs, and the values are the candidate lists of instance IDs to
-        compare against the respective baseline.
-
-        You may specify `start_events` to make the shadow test start at a
-        specific time. Alternatively, you may use the `start_shadow_test`
-        method to start the test.
-
-        The `termination_events` parameter is required and provides control
-        over when the shadow test should terminate. Alternatively, you may use
-        the `stop_shadow_test` method to stop the test.
-
-        Parameters
-        ----------
-        comparisons : dict[str, list[str]]
-            Dictionary defining the baseline and candidate instance IDs for
-            comparison. The keys are baseline instance IDs, and the values are
-            lists of candidate instance IDs to compare against the respective
-            baseline.
-        termination_events : TerminationEvents
-            Termination events for the shadow test.
-        shadow_test_id : Optional[str]
-            ID of the shadow test. Will be generated if not provided.
-        name : Optional[str]
-            Name of the shadow test. If not provided, the ID will be used as
-            the name.
-        description : Optional[str]
-            Optional description of the shadow test.
-        start_events : Optional[StartEvents]
-            Start events for the shadow test.
-
-        Returns
-        -------
-        ShadowTest
-            The created shadow test.
-
-        Raises
-        ------
-        requests.HTTPError
-            If the response status code is not 2xx.
-        """
-
-        # Generate ID if not provided
-        if shadow_test_id is None:
-            shadow_test_id = safe_id("shadow")
-
-        # Use ID as name if name not provided
-        if name is None or name == "":
-            name = shadow_test_id
-
-        payload = {
-            "id": shadow_test_id,
-            "name": name,
-            "comparisons": comparisons,
-            "termination_events": termination_events.to_dict(),
-        }
-
-        if description is not None:
-            payload["description"] = description
-        if start_events is not None:
-            payload["start_events"] = start_events.to_dict()
-
-        response = self.client.request(
-            method="POST",
-            endpoint=f"{self.experiments_endpoint}/shadow",
-            payload=payload,
-        )
-
-        return ShadowTest.from_dict(response.json())
-
-    def start_shadow_test(self: "Application", shadow_test_id: str) -> None:
-        """
-        Start a shadow test. Create a shadow test in draft mode using the
-        `new_shadow_test` method, then use this method to start the test.
-
-        Parameters
-        ----------
-        shadow_test_id : str
-            ID of the shadow test to start.
-
-        Raises
-        ------
-        requests.HTTPError
-            If the response status code is not 2xx.
-        """
-
-        _ = self.client.request(
-            method="PUT",
-            endpoint=f"{self.experiments_endpoint}/shadow/{shadow_test_id}/start",
-        )
-
-    def stop_shadow_test(self: "Application", shadow_test_id: str, intent: StopIntent) -> None:
-        """
-        Stop a shadow test. The test should already have started before using
-        this method.
-
-        Parameters
-        ----------
-        shadow_test_id : str
-            ID of the shadow test to stop.
-        intent : StopIntent
-            Intent for stopping the shadow test.
-        Raises
-        ------
-        requests.HTTPError
-            If the response status code is not 2xx.
-        """
-
-        payload = {
-            "intent": intent.value,
-        }
-
-        _ = self.client.request(
-            method="PUT",
-            endpoint=f"{self.experiments_endpoint}/shadow/{shadow_test_id}/stop",
-            payload=payload,
-        )
-
-    def update_shadow_test(
-        self: "Application",
-        shadow_test_id: str,
-        name: str | None = None,
-        description: str | None = None,
-    ) -> ShadowTest:
-        """
-        Update a shadow test.
-
-        Parameters
-        ----------
-        shadow_test_id : str
-            ID of the shadow test to update.
-        name : Optional[str], default=None
-            Optional name of the shadow test.
-        description : Optional[str], default=None
-            Optional description of the shadow test.
-
-        Returns
-        -------
-        ShadowTest
-            The information with the updated shadow test.
-
-        Raises
-        ------
-        requests.HTTPError
-            If the response status code is not 2xx.
-        """
-
-        payload = {}
-
-        if name is not None:
-            payload["name"] = name
-        if description is not None:
-            payload["description"] = description
-
-        response = self.client.request(
-            method="PATCH",
-            endpoint=f"{self.experiments_endpoint}/shadow/{shadow_test_id}",
-            payload=payload,
-        )
-
-        return ShadowTest.from_dict(response.json())