nextmv 1.0.0.dev10__tar.gz → 1.1.0.dev0__tar.gz

{nextmv-1.0.0.dev10 → nextmv-1.1.0.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nextmv
-Version: 1.0.0.dev10
+Version: 1.1.0.dev0
 Summary: The all-purpose Python SDK for Nextmv
 Project-URL: Homepage, https://www.nextmv.io
 Project-URL: Documentation, https://nextmv-py.docs.nextmv.io/en/latest/nextmv/

nextmv-1.1.0.dev0/nextmv/__about__.py

@@ -0,0 +1 @@
+__version__ = "v1.1.0.dev0"

{nextmv-1.0.0.dev10 → nextmv-1.1.0.dev0}/nextmv/cli/cloud/__init__.py

@@ -17,6 +17,7 @@ from nextmv.cli.cloud.run import app as run_app
 from nextmv.cli.cloud.scenario import app as scenario_app
 from nextmv.cli.cloud.secrets import app as secrets_app
 from nextmv.cli.cloud.shadow import app as shadow_app
+from nextmv.cli.cloud.sso import app as sso_app
 from nextmv.cli.cloud.switchback import app as switchback_app
 from nextmv.cli.cloud.upload import app as upload_app
 from nextmv.cli.cloud.version import app as version_app
@@ -36,6 +37,7 @@ app.add_typer(run_app, name="run")
 app.add_typer(scenario_app, name="scenario")
 app.add_typer(secrets_app, name="secrets")
 app.add_typer(shadow_app, name="shadow")
+app.add_typer(sso_app, name="sso")
 app.add_typer(switchback_app, name="switchback")
 app.add_typer(upload_app, name="upload")
 app.add_typer(version_app, name="version")

{nextmv-1.0.0.dev10 → nextmv-1.1.0.dev0}/nextmv/cli/cloud/account/__init__.py

@@ -20,9 +20,11 @@ app.add_typer(update_app)
 @app.callback()
 def callback() -> None:
     """
-    Manage SSO for your Nextmv Cloud account (organization).
+    Manage 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.
+    Please contact [link=https://www.nextmv.io/contact][bold]Nextmv
+    support[/bold][/link] for assistance configuring SSO for your organization.
+    You may use the [code]nextmv cloud sso[/code] command tree to manage the
+    SSO configuration for your organization.
     """
     pass

{nextmv-1.0.0.dev10 → nextmv-1.1.0.dev0}/nextmv/cli/cloud/account/create.py

@@ -42,7 +42,10 @@ def create(
     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.
+    Please contact [link=https://www.nextmv.io/contact][bold]Nextmv
+    support[/bold][/link] for assistance. You may use the [code]nextmv cloud
+    sso[/code] command tree to manage the SSO configuration for your
+    organization.
 
     At least one administrator email address must be provided. Multiple
     administrators can be specified by repeating the --admins flag or by

nextmv-1.1.0.dev0/nextmv/cli/cloud/sso/__init__.py

@@ -0,0 +1,32 @@
+"""
+This module defines the cloud sso command tree for the Nextmv CLI.
+"""
+
+import typer
+
+from nextmv.cli.cloud.sso.create import app as create_app
+from nextmv.cli.cloud.sso.delete import app as delete_app
+from nextmv.cli.cloud.sso.disable import app as disable_app
+from nextmv.cli.cloud.sso.enable import app as enable_app
+from nextmv.cli.cloud.sso.get import app as get_app
+from nextmv.cli.cloud.sso.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(disable_app)
+app.add_typer(enable_app)
+app.add_typer(get_app)
+app.add_typer(update_app)
+
+
+@app.callback()
+def callback() -> None:
+    """
+    Manage SSO for your Nextmv Cloud organization (account).
+
+    Please contact [link=https://www.nextmv.io/contact][bold]Nextmv support[/bold][/link]
+    for assistance configuring SSO for your organization.
+    """
+    pass

nextmv-1.1.0.dev0/nextmv/cli/cloud/sso/create.py

@@ -0,0 +1,97 @@
+"""
+This module defines the cloud sso 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.sso import SSOConfiguration
+
+# Set up subcommand application.
+app = typer.Typer()
+
+
+@app.command()
+def create(
+    allow_non_domain_users: Annotated[
+        bool,
+        typer.Option(
+            "--allow-non-domain-users",
+            "-a",
+            help="Allow users who are not part of the SSO domain to access the Nextmv Cloud organization (account).",
+        ),
+    ] = False,
+    enabled: Annotated[
+        bool,
+        typer.Option(
+            "--enabled",
+            "-e",
+            help="Enable SSO for the Nextmv Cloud organization (account) at the time of creation. "
+            "Run [code]nextmv cloud sso enable[/code] to enable SSO after creation.",
+        ),
+    ] = False,
+    metadata_url: Annotated[
+        str | None,
+        typer.Option(
+            "--metadata-url",
+            "-u",
+            help="The URL to the SSO metadata document.",
+            metavar="METADATA_URL",
+        ),
+    ] = None,
+    metadata_document: Annotated[
+        str | None,
+        typer.Option(
+            "--metadata-document",
+            "-d",
+            help="The SSO metadata document as a string.",
+            metavar="METADATA_DOCUMENT",
+        ),
+    ] = None,
+    profile: ProfileOption = None,
+) -> None:
+    """
+    Create a new SSO configuration for your Nextmv Cloud organization.
+
+    SSO must be configured to enable managed accounts in your organization.
+    Please contact [link=https://www.nextmv.io/contact][bold]Nextmv support[/bold][/link] for assistance.
+
+    You must provide either a metadata URL or a metadata document. The metadata
+    document contains the SAML configuration details from your identity provider.
+
+    [bold][underline]Examples[/underline][/bold]
+
+    - Create an SSO configuration using a metadata URL.
+        $ [dim]nextmv cloud sso create --metadata-url "https://sso.carrotexpress.com/saml/metadata"[/dim]
+
+    - Create and enable SSO configuration immediately.
+        $ [dim]nextmv cloud sso create --metadata-url "https://sso.bunnylogistics.io/metadata" \\
+            --enabled[/dim]
+
+    - Create SSO configuration allowing non-domain users.
+        $ [dim]nextmv cloud sso create --metadata-url "https://idp.hopmail.com/saml/metadata" \\
+            --allow-non-domain-users[/dim]
+
+    - Create SSO configuration using a metadata document string.
+        $ [dim]nextmv cloud sso create --metadata-document "<EntityDescriptor ...</EntityDescriptor>"[/dim]
+
+    - Create SSO configuration using the profile named [magenta]hare[/magenta].
+        $ [dim]nextmv cloud sso create --metadata-url "https://sso.cottontailcouriers.net/metadata" \\
+            --profile hare[/dim]
+    """
+
+    cloud_client = build_client(profile)
+    in_progress(msg="Creating configuration...")
+
+    configuration = SSOConfiguration.new(
+        client=cloud_client,
+        allow_non_domain_users=allow_non_domain_users,
+        enabled=enabled,
+        metadata_url=metadata_url,
+        metadata_document=metadata_document,
+    )
+    print_json(configuration.to_dict())

nextmv-1.1.0.dev0/nextmv/cli/cloud/sso/delete.py

@@ -0,0 +1,58 @@
+"""
+This module defines the cloud sso delete command for the Nextmv CLI.
+"""
+
+from typing import Annotated
+
+import typer
+
+from nextmv.cli.configuration.config import build_sso_config
+from nextmv.cli.confirm import get_confirmation
+from nextmv.cli.message import info, success
+from nextmv.cli.options import ProfileOption
+
+# Set up subcommand application.
+app = typer.Typer()
+
+
+@app.command()
+def delete(
+    yes: Annotated[
+        bool,
+        typer.Option(
+            "--yes",
+            "-y",
+            help="Agree to deletion confirmation prompt. Useful for non-interactive sessions.",
+        ),
+    ] = False,
+    profile: ProfileOption = None,
+) -> None:
+    """
+    Deletes the SSO configuration.
+
+    You must have the [magenta]administrator[/magenta] role on the organization 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 SSO configuration.
+        $ [dim]nextmv cloud sso delete[/dim]
+
+    - Delete the SSO configuration without confirmation prompt.
+        $ [dim]nextmv cloud sso delete --yes[/dim]
+    """
+
+    if not yes:
+        confirm = get_confirmation(
+            "Are you sure you want to delete the sso configuration? This action cannot be undone.",
+        )
+
+        if not confirm:
+            info("SSO configuration will not be deleted.")
+            return
+
+    sso_config = build_sso_config(profile)
+    sso_config.delete()
+    success("SSO configuration has been deleted.")

nextmv-1.1.0.dev0/nextmv/cli/cloud/sso/disable.py

@@ -0,0 +1,56 @@
+"""
+This module defines the cloud sso disable command for the Nextmv CLI.
+"""
+
+from typing import Annotated
+
+import typer
+
+from nextmv.cli.configuration.config import build_sso_config
+from nextmv.cli.confirm import get_confirmation
+from nextmv.cli.message import info, success
+from nextmv.cli.options import ProfileOption
+
+# Set up subcommand application.
+app = typer.Typer()
+
+
+@app.command()
+def disable(
+    yes: Annotated[
+        bool,
+        typer.Option(
+            "--yes",
+            "-y",
+            help="Agree to disable confirmation prompt. Useful for non-interactive sessions.",
+        ),
+    ] = False,
+    profile: ProfileOption = None,
+) -> None:
+    """
+    Disables the SSO configuration.
+
+    Use the --yes flag to skip the confirmation prompt. Use the [code]nextmv
+    cloud sso enable[/code] command to re-enable SSO.
+
+    [bold][underline]Examples[/underline][/bold]
+
+    - Disable the SSO configuration.
+        $ [dim]nextmv cloud sso disable[/dim]
+
+    - Disable the SSO configuration without confirmation prompt.
+        $ [dim]nextmv cloud sso disable --yes[/dim]
+    """
+
+    if not yes:
+        confirm = get_confirmation(
+            "Are you sure you want to disable the sso configuration?.",
+        )
+
+        if not confirm:
+            info("SSO configuration will not be disabled.")
+            return
+
+    sso_config = build_sso_config(profile)
+    sso_config.disable()
+    success("SSO configuration has been disabled.")

nextmv-1.1.0.dev0/nextmv/cli/cloud/sso/enable.py

@@ -0,0 +1,56 @@
+"""
+This module defines the cloud sso enable command for the Nextmv CLI.
+"""
+
+from typing import Annotated
+
+import typer
+
+from nextmv.cli.configuration.config import build_sso_config
+from nextmv.cli.confirm import get_confirmation
+from nextmv.cli.message import info, success
+from nextmv.cli.options import ProfileOption
+
+# Set up subcommand application.
+app = typer.Typer()
+
+
+@app.command()
+def enable(
+    yes: Annotated[
+        bool,
+        typer.Option(
+            "--yes",
+            "-y",
+            help="Agree to enable confirmation prompt. Useful for non-interactive sessions.",
+        ),
+    ] = False,
+    profile: ProfileOption = None,
+) -> None:
+    """
+    Enables the SSO configuration.
+
+    Use the --yes flag to skip the confirmation prompt. Use the [code]nextmv
+    cloud sso disable[/code] command to disable SSO.
+
+    [bold][underline]Examples[/underline][/bold]
+
+    - Enable the SSO configuration.
+        $ [dim]nextmv cloud sso enable[/dim]
+
+    - Enable the SSO configuration without confirmation prompt.
+        $ [dim]nextmv cloud sso enable --yes[/dim]
+    """
+
+    if not yes:
+        confirm = get_confirmation(
+            "Are you sure you want to enable the sso configuration?.",
+        )
+
+        if not confirm:
+            info("SSO configuration will not be enabled.")
+            return
+
+    sso_config = build_sso_config(profile)
+    sso_config.enable()
+    success("SSO configuration has been enabled.")

nextmv-1.1.0.dev0/nextmv/cli/cloud/sso/get.py

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

nextmv-1.1.0.dev0/nextmv/cli/cloud/sso/update.py

@@ -0,0 +1,78 @@
+"""
+This module defines the cloud sso update command for the Nextmv CLI.
+"""
+
+import json
+from typing import Annotated
+
+import typer
+
+from nextmv.cli.configuration.config import build_sso_config
+from nextmv.cli.message import print_json, success
+from nextmv.cli.options import ProfileOption
+
+# Set up subcommand application.
+app = typer.Typer()
+
+
+@app.command()
+def update(
+    metadata_url: Annotated[
+        str | None,
+        typer.Option(
+            "--metadata-url",
+            "-u",
+            help="The URL to the SSO metadata document to update.",
+            metavar="METADATA_URL",
+        ),
+    ] = None,
+    metadata_document: Annotated[
+        str | None,
+        typer.Option(
+            "--metadata-document",
+            "-d",
+            help="The SSO metadata document as a string to update.",
+            metavar="METADATA_DOCUMENT",
+        ),
+    ] = None,
+    output: Annotated[
+        str | None,
+        typer.Option(
+            "--output",
+            "-o",
+            help="Saves the updated SSO configuration information to this location.",
+            metavar="OUTPUT_PATH",
+        ),
+    ] = None,
+    profile: ProfileOption = None,
+) -> None:
+    """
+    Updates information of a Nextmv Cloud SSO configuration.
+
+    This command allows you to update the metadata URL or metadata document of
+    an existing SSO configuration.
+
+    [bold][underline]Examples[/underline][/bold]
+
+    - Update the SSO configuration with a new metadata URL.
+        $ [dim]nextmv cloud sso update --metadata-url "https://example.com/metadata.xml"[/dim]
+
+    - Update the SSO configuration with a new metadata document and save the updated information to an
+        [magenta]updated_sso_config.json[/magenta] file.
+        $ [dim]nextmv cloud sso update --metadata-document "<xml>...</xml>" --output updated_sso_config.json[/dim]
+    """
+
+    sso_config = build_sso_config(profile)
+    updated_config = sso_config.update(metadata_url=metadata_url, metadata_document=metadata_document)
+    success("SSO configuration updated successfully.")
+    updated_config_dict = updated_config.to_dict()
+
+    if output is not None and output != "":
+        with open(output, "w") as f:
+            json.dump(updated_config_dict, f, indent=2)
+
+        success(msg=f"Updated SSO configuration information saved to [magenta]{output}[/magenta].")
+
+        return
+
+    print_json(updated_config_dict)

{nextmv-1.0.0.dev10 → nextmv-1.1.0.dev0}/nextmv/cli/configuration/config.py

@@ -12,6 +12,7 @@ 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
+from nextmv.cloud.sso import SSOConfiguration
 
 # Some useful constants.
 CONFIG_DIR = Path.home() / ".nextmv"
@@ -207,6 +208,32 @@ def build_account(account_id: str | None = None, profile: str | None = None) ->
     return Account(account_id=account_id, client=client)
 
 
+def build_sso_config(profile: str | None = None) -> SSOConfiguration:
+    """
+    Builds a `cloud.SSOConfiguration` using the API key and endpoint for the given
+    profile. If no profile is given, the default profile is used.
+
+    Parameters
+    ----------
+    profile : str | None
+        The profile name to use. If None, the default profile is used.
+
+    Returns
+    -------
+    SSOConfiguration
+        An SSOConfiguration object for the configured profile.
+
+    Raises
+    ------
+    typer.Exit
+        If the configuration is invalid or missing.
+    """
+
+    client = build_client(profile)
+
+    return SSOConfiguration(client=client)
+
+
 def obscure_api_key(api_key: str) -> str:
     """
     Obscure an API key for display purposes.

{nextmv-1.0.0.dev10 → nextmv-1.1.0.dev0}/nextmv/cloud/__init__.py

@@ -61,6 +61,7 @@ from .shadow import StartEvents as StartEvents
 from .shadow import StopIntent as StopIntent
 from .shadow import TerminationEvents as TerminationEvents
 from .shadow import TestComparison as TestComparison
+from .sso import SSOConfiguration as SSOConfiguration
 from .switchback import SwitchbackPlan as SwitchbackPlan
 from .switchback import SwitchbackPlanUnit as SwitchbackPlanUnit
 from .switchback import SwitchbackTest as SwitchbackTest

{nextmv-1.0.0.dev10 → nextmv-1.1.0.dev0}/nextmv/cloud/account.py

@@ -188,30 +188,32 @@ class Account(BaseModel):
 
     You can import the `Account` class directly from `cloud`:
 
-    ```python
-    from nextmv.cloud import Account
-    ```
+    ```python from nextmv.cloud import Account ```
 
     This class provides access to account-level operations in the Nextmv Cloud,
     such as retrieving the queue of runs.
 
-    Note: It is recommended to use `Account.get()` or `Account.new()`
-    instead of direct initialization to ensure proper setup.
+    Note: It is recommended to use `Account.get()` or `Account.new()` instead
+    of direct initialization to ensure proper setup.
 
-    Parameters
+    Attributes
     ----------
-    client : Client
-        Client to use for interacting with the Nextmv Cloud API.
     account_id : str, optional
         ID of the account (organization).
     name : str, optional
         Name of the account (organization).
     members : list[AccountMember], optional
         List of members in the account (organization).
+    client : Client
+        Client to use for interacting with the Nextmv Cloud API. This is an
+        SDK-specific attribute and it is not part of the API representation of
+        an account.
     account_endpoint : str, default="v1/account"
-        Base endpoint for the account (SDK-specific).
+        Base endpoint for the account. This is an SDK-specific attribute and it
+        is not part of the API representation of an account.
     organization_endpoint : str, default="v1/organization/{organization_id}"
-        Base endpoint for organization operations (SDK-specific).
+        Base endpoint for organization operations. This is an SDK-specific
+        attribute and it is not part of the API representation of an account.
 
     Examples
     --------

{nextmv-1.0.0.dev10 → nextmv-1.1.0.dev0}/nextmv/cloud/application/__init__.py

@@ -121,10 +121,8 @@ class Application(
     Note: It is recommended to use `Application.get()` or `Application.new()`
     instead of direct initialization to ensure proper setup.
 
-    Parameters
+    Attributes
     ----------
-    client : Client
-        Client to use for interacting with the Nextmv Cloud API.
     id : str
         ID of the application.
     name : str, optional
@@ -145,12 +143,19 @@ class Application(
         Creation timestamp of the application.
     updated_at : datetime, optional
         Last update timestamp of the application.
+    client : Client
+        Client to use for interacting with the Nextmv Cloud API. This is an
+        SDK-specific attribute and it is not part of the API representation of
+        an application.
     endpoint : str, default="v1/applications/{id}"
-        Base endpoint for the application (SDK-specific).
+        Base endpoint for the application. This is an SDK-specific attribute
+        and it is not part of the API representation of an application.
     experiments_endpoint : str, default="{base}/experiments"
-        Base endpoint for experiments (SDK-specific).
+        Base endpoint for experiments. This is an SDK-specific attribute and it
+        is not part of the API representation of an application.
     ensembles_endpoint : str, default="{base}/ensembles"
-        Base endpoint for ensembles (SDK-specific).
+        Base endpoint for ensembles. This is an SDK-specific attribute and it
+        is not part of the API representation of an application.
 
     Examples
     --------