lightning-sdk 2025.11.13.post0__py3-none-any.whl

lightning_sdk/cli/utils/richt_print.py

@@ -0,0 +1,35 @@
+import os
+from typing import Any
+
+from rich.console import Console
+
+from lightning_sdk.studio import Studio
+from lightning_sdk.utils.resolve import _get_studio_url
+
+
+def rich_to_str(*renderables: Any) -> str:
+    with open(os.devnull, "w") as f:
+        console = Console(file=f, record=True)
+        console.print(*renderables)
+    return console.export_text(styles=True)
+
+
+# not supported on all terminals (e.g. older ones). in that case it's a name without a link
+# see https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda#hyperlinks-aka-html-like-anchors-in-terminal-emulators
+# for details and
+# https://github.com/Alhadis/OSC8-Adoption/blob/main/README.md for status of OSC8 adoption
+def studio_name_link(studio: Studio, to_ascii: bool = True) -> str:
+    """Hyperlink a studio name.
+
+    Args:
+      studio: the studio whose name to print and link to the studio url
+      to_ascii: whether return a plain ascii string with characters for linking converted to ascii as well.
+        if False, returns the rich markup directly.
+    """
+    url = _get_studio_url(studio)
+
+    studio_link_markup = f"[link={url}]{studio.name}[/link]"
+    if not to_ascii:
+        return studio_link_markup
+
+    return rich_to_str(studio_link_markup).strip("\n")

lightning_sdk/cli/utils/save_to_config.py

@@ -0,0 +1,27 @@
+from lightning_sdk.organization import Organization
+from lightning_sdk.studio import Studio
+from lightning_sdk.teamspace import Teamspace
+from lightning_sdk.utils.config import Config, DefaultConfigKeys
+
+
+def save_teamspace_to_config(teamspace: Teamspace, overwrite: bool = False) -> None:
+    saved = _save_to_config_if_not_exists(DefaultConfigKeys.teamspace_name, teamspace.name, overwrite)
+    saved = _save_to_config_if_not_exists(DefaultConfigKeys.teamspace_owner, teamspace.owner.name, overwrite=saved)
+    saved = _save_to_config_if_not_exists(
+        DefaultConfigKeys.teamspace_owner_type,
+        "organization" if isinstance(teamspace.owner, Organization) else "user",
+        overwrite=saved,
+    )
+
+
+def save_studio_to_config(studio: Studio, overwrite: bool = False) -> None:
+    saved = _save_to_config_if_not_exists(DefaultConfigKeys.studio, studio.name, overwrite)
+    save_teamspace_to_config(studio.teamspace, overwrite=saved)
+
+
+def _save_to_config_if_not_exists(key: str, value: str, overwrite: bool = False) -> bool:
+    cfg = Config()
+    if overwrite or cfg.get(key) is None:
+        cfg.set(key, value)
+        return True
+    return False

lightning_sdk/cli/utils/ssh_connection.py

@@ -0,0 +1,59 @@
+import os
+import platform
+import uuid
+from pathlib import Path
+from typing import Optional
+
+from lightning_sdk.lightning_cloud.login import Auth
+from lightning_sdk.utils.config import _DEFAULT_CONFIG_FILE_PATH
+
+
+def configure_ssh_internal(force_download: bool = False) -> str:
+    """Internal function to configure SSH without Click decorators."""
+    auth = Auth()
+    auth.authenticate()
+    return download_ssh_keys(auth.api_key, force_download=force_download)
+
+
+def download_ssh_keys(
+    api_key: Optional[str],
+    force_download: bool = False,
+    ssh_key_name: str = "lightning_rsa",
+) -> str:
+    """Download the SSH key for a User."""
+    ssh_private_key_path = os.path.join(os.path.expanduser(os.path.dirname(_DEFAULT_CONFIG_FILE_PATH)), ssh_key_name)
+
+    os.makedirs(os.path.dirname(ssh_private_key_path), exist_ok=True)
+
+    if not os.path.isfile(ssh_private_key_path) or force_download:
+        key_id = str(uuid.uuid4())
+        download_file(
+            f"https://lightning.ai/setup/ssh-gen?t={api_key}&id={key_id}&machineName={platform.node()}",
+            Path(ssh_private_key_path),
+            overwrite=True,
+            chmod=0o600,
+        )
+        download_file(
+            f"https://lightning.ai/setup/ssh-public?t={api_key}&id={key_id}",
+            Path(ssh_private_key_path + ".pub"),
+            overwrite=True,
+        )
+
+    return ssh_private_key_path
+
+
+def download_file(url: str, local_path: Path, overwrite: bool = True, chmod: Optional[int] = None) -> None:
+    """Download a file from a URL."""
+    import requests
+
+    if os.path.isfile(local_path) and not overwrite:
+        raise FileExistsError(f"The file {local_path} already exists and overwrite is set to False.")
+
+    response = requests.get(url, stream=True)
+    response.raise_for_status()
+
+    with open(local_path, "wb") as file:
+        for chunk in response.iter_content(chunk_size=8192):
+            file.write(chunk)
+    if chmod is not None:
+        os.chmod(local_path, 0o600)

lightning_sdk/cli/utils/studio_selection.py

@@ -0,0 +1,113 @@
+import os
+from contextlib import suppress
+from typing import Dict, List, Optional, Union
+
+import click
+from simple_term_menu import TerminalMenu
+
+from lightning_sdk.cli.legacy.exceptions import StudioCliError
+from lightning_sdk.studio import VM, Studio
+from lightning_sdk.teamspace import Teamspace
+from lightning_sdk.utils.resolve import _get_authed_user
+
+
+class StudiosMenu:
+    """This class is used to select a studio from a list of possible studios within a teamspace.
+
+    It can be used to select a studio from a list of possible studios, or to resolve a studio from a name.
+    """
+
+    def __init__(self, teamspace: Teamspace, vm: bool = False) -> None:
+        """Initialize the StudiosMenu with a teamspace.
+
+        Args:
+            teamspace: The teamspace to list studios from
+        """
+        self.teamspace = teamspace
+        self.vm = vm
+
+    def _get_studio_from_interactive_menu(self, possible_studios: Dict[str, Union[Studio, VM]]) -> Union[Studio, VM]:
+        studio_names = sorted(possible_studios.keys())
+        terminal_menu = self._prepare_terminal_menu_studios(studio_names, vm=self.vm)
+        terminal_menu.show()
+
+        selected_name = studio_names[terminal_menu.chosen_menu_index]
+        return possible_studios[selected_name]
+
+    def _get_studio_from_name(self, studio: str, possible_studios: Dict[str, Union[Studio, VM]]) -> Union[Studio, VM]:
+        if studio in possible_studios:
+            return possible_studios[studio]
+
+        click.echo(f"Could not find {'VM' if self.vm else 'Studio'} {studio}, please select it from the list:")
+        return self._get_studio_from_interactive_menu(possible_studios)
+
+    @staticmethod
+    def _prepare_terminal_menu_studios(
+        studio_names: List[str], title: Optional[str] = None, vm: bool = False
+    ) -> TerminalMenu:
+        if title is None:
+            title = f"Please select a {'VM' if vm else 'Studio'} out of the following:"
+
+        return TerminalMenu(studio_names, title=title, clear_menu_on_exit=True)
+
+    def _get_possible_studios(self) -> Dict[str, Union[Studio, VM]]:
+        """Get all available studios in the teamspace."""
+        studios: Dict[str, Union[Studio, VM]] = {}
+
+        user = _get_authed_user()
+        teamspace_studios = self.teamspace.vms if self.vm else self.teamspace.studios
+        for studio in teamspace_studios:
+            if studio._studio.user_id == user.id:
+                studios[studio.name] = studio
+        return studios
+
+    def __call__(self, studio: Optional[str] = None) -> Union[Studio, VM]:
+        """Select a studio from the teamspace.
+
+        Args:
+            studio: Optional studio name to select. If not provided, will show interactive menu.
+
+        Returns:
+            Selected Studio/VM object
+
+        Raises:
+            StudioCliError: If studio selection fails
+        """
+        try:
+            # try to resolve the studio from the name, environment or config
+            resolved_studio = None
+
+            selected_cls = VM if self.vm else Studio
+
+            with suppress(Exception):
+                resolved_studio = selected_cls(name=studio, teamspace=self.teamspace, create_ok=False)
+
+            if resolved_studio is not None:
+                return resolved_studio
+
+            if os.environ.get("LIGHTNING_NON_INTERACTIVE", "0") == "1" and studio is None:
+                raise ValueError(
+                    f"{'VM' if self.vm else 'Studio'} selection is not supported in non-interactive mode. "
+                    "Please provide a studio name."
+                )
+
+            click.echo(f"Listing studios in teamspace {self.teamspace.owner.name}/{self.teamspace.name}...")
+
+            possible_studios = self._get_possible_studios()
+
+            if not possible_studios:
+                raise ValueError(f"No studios found in teamspace {self.teamspace.name}")
+
+            if studio is None:
+                return self._get_studio_from_interactive_menu(possible_studios)
+
+            return self._get_studio_from_name(studio, possible_studios)
+
+        except KeyboardInterrupt:
+            raise KeyboardInterrupt from None
+
+        except Exception as e:
+            raise StudioCliError(
+                f"Could not resolve a {'VM' if self.vm else 'Studio'}. "
+                "Please pass it as an argument or contact Lightning AI directly to resolve this issue."
+            ) from e

lightning_sdk/cli/utils/teamspace_selection.py

@@ -0,0 +1,125 @@
+import os
+from contextlib import suppress
+from typing import Dict, List, Optional
+
+import click
+from simple_term_menu import TerminalMenu
+
+from lightning_sdk.cli.legacy.exceptions import StudioCliError
+from lightning_sdk.cli.utils.resolve import resolve_teamspace_owner_name_format
+from lightning_sdk.teamspace import Organization, Teamspace
+from lightning_sdk.user import Owner, User
+from lightning_sdk.utils.resolve import ApiException, _get_authed_user, _resolve_teamspace
+
+
+class TeamspacesMenu:
+    """This class is used to select a teamspace from a list of possible teamspaces.
+
+    It can be used to select a teamspace from a list of possible teamspaces, or to resolve a teamspace from a name.
+    """
+
+    def __init__(self, owner: Optional[Owner] = None) -> None:
+        self._owner: Owner = owner
+
+    def _get_teamspace_from_interactive_menu(self, possible_teamspaces: Dict[str, str]) -> str:
+        teamspace_ids = sorted(possible_teamspaces.keys())
+        terminal_menu = self._prepare_terminal_menu_teamspaces(
+            [possible_teamspaces[k] for k in teamspace_ids], self._owner
+        )
+        terminal_menu.show()
+
+        selected_id = teamspace_ids[terminal_menu.chosen_menu_index]
+        return possible_teamspaces[selected_id]
+
+    def _get_teamspace_from_name(self, teamspace: str, possible_teamspaces: Dict[str, str]) -> str:
+        for _, ts in possible_teamspaces.items():
+            if ts == teamspace:
+                return ts
+
+        click.echo(f"Could not find Teamspace {self._owner.name}/{teamspace}, please select it from the list:")
+        return self._get_teamspace_from_interactive_menu(possible_teamspaces)
+
+    @staticmethod
+    def _prepare_terminal_menu_teamspaces(
+        possible_teamspaces: List[str],
+        owner: Owner,
+        title: Optional[str] = None,
+    ) -> TerminalMenu:
+        if title is None:
+            title = f"Please select a Teamspace (owned by {owner.name}) out of the following:"
+
+        return TerminalMenu(possible_teamspaces, title=title, clear_menu_on_exit=True)
+
+    def _get_possible_teamspaces(self, user: User) -> Dict[str, str]:
+        user_api = user._user_api
+
+        memberships = user_api._get_all_teamspace_memberships(
+            user_id=user.id, org_id=self._owner.id if isinstance(self._owner, Organization) else None
+        )
+
+        teamspaces = {}
+        # get all teamspace memberships
+        for membership in memberships:
+            teamspace_id = membership.project_id
+            teamspace_name = membership.name
+
+            if membership.owner_id == self._owner.id:
+                teamspaces[teamspace_id] = teamspace_name
+
+        return teamspaces
+
+    def __call__(self, teamspace: Optional[str] = None) -> Teamspace:
+        resolved_teamspace = None
+        resolved_teamspace = resolve_teamspace_owner_name_format(teamspace)
+        if resolved_teamspace is not None:
+            return resolved_teamspace
+
+        if self._owner is None:
+            # resolve owner if required
+            from lightning_sdk.cli.utils.owner_selection import OwnerMenu
+
+            menu = OwnerMenu()
+            self._owner = menu()
+
+        if isinstance(self._owner, Organization):
+            org = self._owner
+            user = None
+        elif isinstance(self._owner, User):
+            org = None
+            user = self._owner
+
+        with suppress(ApiException, ValueError, RuntimeError):
+            resolved_teamspace = _resolve_teamspace(teamspace=teamspace, org=org, user=user)
+
+        if resolved_teamspace is not None:
+            return resolved_teamspace
+
+        if os.environ.get("LIGHTNING_NON_INTERACTIVE", "0") == "1":
+            raise ValueError(
+                "Teamspace selection is not supported in non-interactive mode. "
+                "Please provide a teamspace name in the format of 'owner/teamspace'."
+            )
+
+        # if the teamspace is not resolved, try to get the teamspace from the interactive menu
+        # this could mean that either no teamspace was provided or the provided teamspace is not valid
+        try:
+            auth_user = _get_authed_user()
+
+            possible_teamspaces = self._get_possible_teamspaces(auth_user)
+            if teamspace is None:
+                teamspace_name = self._get_teamspace_from_interactive_menu(possible_teamspaces=possible_teamspaces)
+            else:
+                teamspace_name = self._get_teamspace_from_name(
+                    teamspace=teamspace, possible_teamspaces=possible_teamspaces
+                )
+
+            return Teamspace(teamspace_name, org=org, user=user)
+
+        except KeyboardInterrupt:
+            raise KeyboardInterrupt from None
+
+        except Exception as e:
+            raise StudioCliError(
+                f"Could not find the given Teamspace owned by {self._owner.name}. "
+                "Please contact Lightning AI directly to resolve this issue."
+            ) from e

lightning_sdk/cli/vm/__init__.py

@@ -0,0 +1,20 @@
+import click
+
+
+def register_commands(group: click.Group) -> None:
+    """Register studio commands with the given group."""
+    from lightning_sdk.cli.vm.create import create_vm
+    from lightning_sdk.cli.vm.delete import delete_vm
+    from lightning_sdk.cli.vm.list import list_vms
+    from lightning_sdk.cli.vm.ssh import ssh_vm
+    from lightning_sdk.cli.vm.start import start_vm
+    from lightning_sdk.cli.vm.stop import stop_vm
+    from lightning_sdk.cli.vm.switch import switch_vm
+
+    group.add_command(create_vm)
+    group.add_command(delete_vm)
+    group.add_command(list_vms)
+    group.add_command(ssh_vm)
+    group.add_command(start_vm)
+    group.add_command(stop_vm)
+    group.add_command(switch_vm)

lightning_sdk/cli/vm/create.py

@@ -0,0 +1,33 @@
+from typing import Optional
+
+import click
+
+from lightning_sdk.cli.studio.create import create_impl
+from lightning_sdk.machine import CloudProvider
+
+
+@click.command("create")
+@click.option("--name", help="The name of the VM to create. If not provided, a random name will be generated.")
+@click.option("--teamspace", help="Override default teamspace (format: owner/teamspace)")
+@click.option(
+    "--cloud-provider",
+    help="The cloud provider to start the VM on. Defaults to teamspace default.",
+    type=click.Choice(m.name for m in list(CloudProvider)),
+)
+@click.option(
+    "--cloud-account",
+    help="The cloud account to create the VM on. Defaults to teamspace default.",
+    type=click.STRING,
+)
+def create_vm(
+    name: Optional[str] = None,
+    teamspace: Optional[str] = None,
+    cloud_provider: Optional[str] = None,
+    cloud_account: Optional[str] = None,
+) -> None:
+    """Create a new VM.
+
+    Example:
+        lightning vm create
+    """
+    create_impl(name=name, teamspace=teamspace, cloud_provider=cloud_provider, cloud_account=cloud_account, vm=True)

lightning_sdk/cli/vm/delete.py

@@ -0,0 +1,25 @@
+from typing import Optional
+
+import click
+
+from lightning_sdk.cli.studio.delete import delete_impl
+
+
+@click.command("delete")
+@click.option(
+    "--name",
+    help=(
+        "The name of the VM to delete. "
+        "If not provided, will try to infer from environment, "
+        "use the default value from the config or prompt for interactive selection."
+    ),
+)
+@click.option("--teamspace", help="Override default teamspace (format: owner/teamspace)")
+def delete_vm(name: Optional[str] = None, teamspace: Optional[str] = None) -> None:
+    """Delete a VM.
+
+    Example:
+      lightning vm delete --name my-vm
+
+    """
+    return delete_impl(name=name, teamspace=teamspace, vm=True)

lightning_sdk/cli/vm/list.py

@@ -0,0 +1,30 @@
+from typing import Optional
+
+import click
+
+from lightning_sdk.cli.studio.list import list_impl
+
+
+@click.command("list")
+@click.option("--teamspace", help="Override default teamspace (format: owner/teamspace)")
+@click.option(
+    "--all",
+    is_flag=True,
+    flag_value=True,
+    default=False,
+    help="List all VMs, not just the ones belonging to the authed user",
+)
+@click.option(
+    "--sort-by",
+    default=None,
+    type=click.Choice(["name", "teamspace", "status", "machine", "cloud-account"], case_sensitive=False),
+    help="the attribute to sort the VMs by.",
+)
+def list_vms(teamspace: Optional[str] = None, all: bool = False, sort_by: Optional[str] = None) -> None:  # noqa: A002
+    """List VMs in a teamspace.
+
+    Example:
+        lightning vm list --teamspace owner/teamspace
+
+    """
+    return list_impl(teamspace=teamspace, all=all, sort_by=sort_by, vm=True)

lightning_sdk/cli/vm/ssh.py

@@ -0,0 +1,31 @@
+from typing import List, Optional
+
+import click
+
+from lightning_sdk.cli.studio.ssh import ssh_impl
+
+
+@click.command("ssh")
+@click.option(
+    "--name",
+    help=(
+        "The name of the VM to ssh into. "
+        "If not provided, will try to infer from environment, "
+        "use the default value from the config or prompt for interactive selection."
+    ),
+)
+@click.option("--teamspace", help="Override default teamspace (format: owner/teamspace)", type=click.STRING)
+@click.option(
+    "--option",
+    "-o",
+    help="Additional options to pass to the SSH command. Can be specified multiple times.",
+    multiple=True,
+    type=click.STRING,
+)
+def ssh_vm(name: Optional[str] = None, teamspace: Optional[str] = None, option: Optional[List[str]] = None) -> None:
+    """SSH into a VM.
+
+    Example:
+        lightning vm ssh --name my-vm
+    """
+    return ssh_impl(name=name, teamspace=teamspace, option=option, vm=False)

lightning_sdk/cli/vm/start.py

@@ -0,0 +1,60 @@
+from typing import Optional
+
+import click
+
+from lightning_sdk.cli.studio.start import start_impl
+from lightning_sdk.machine import CloudProvider, Machine
+
+
+@click.command("start")
+@click.option(
+    "--name",
+    help=(
+        "The name of the VM to start. "
+        "If not provided, will try to infer from environment, "
+        "use the default value from the config or prompt for interactive selection."
+    ),
+)
+@click.option("--teamspace", help="Override default teamspace (format: owner/teamspace)")
+@click.option("--create", is_flag=True, help="Create the VM if it doesn't exist")
+@click.option(
+    "--machine",
+    help="The machine type to start the VM on. Defaults to CPU-4",
+    type=click.Choice(m.name for m in Machine.__dict__.values() if isinstance(m, Machine) and m._include_in_cli),
+)
+@click.option("--interruptible", is_flag=True, help="Start the VM on an interruptible instance.")
+@click.option(
+    "--cloud-provider",
+    help=("The cloud provider to start the VM on. Defaults to teamspace default. Only used if --create is specified."),
+    type=click.Choice(m.name for m in list(CloudProvider)),
+)
+@click.option(
+    "--cloud-account",
+    help="The cloud account to start the VM on. Defaults to teamspace default. Only used if --create is specified.",
+    type=click.STRING,
+)
+def start_vm(
+    name: Optional[str] = None,
+    teamspace: Optional[str] = None,
+    create: bool = False,
+    machine: str = "CPU",
+    interruptible: bool = False,
+    cloud_provider: Optional[str] = None,
+    cloud_account: Optional[str] = None,
+) -> None:
+    """Start a VM.
+
+    Example:
+        lightning vm start --name my-vm
+
+    """
+    return start_impl(
+        name=name,
+        teamspace=teamspace,
+        create=create,
+        machine=machine,
+        interruptible=interruptible,
+        cloud_provider=cloud_provider,
+        cloud_account=cloud_account,
+        vm=True,
+    )

lightning_sdk/cli/vm/stop.py

@@ -0,0 +1,25 @@
+from typing import Optional
+
+import click
+
+from lightning_sdk.cli.studio.stop import stop_impl
+
+
+@click.command("stop")
+@click.option(
+    "--name",
+    help=(
+        "The name of the VM to stop. "
+        "If not provided, will try to infer from environment, "
+        "use the default value from the config or prompt for interactive selection."
+    ),
+)
+@click.option("--teamspace", help="Override default teamspace (format: owner/teamspace)")
+def stop_vm(name: Optional[str] = None, teamspace: Optional[str] = None) -> None:
+    """Stop a VM.
+
+    Example:
+        lightning vm stop --name my-vm
+
+    """
+    return stop_impl(name=name, teamspace=teamspace, vm=True)

lightning_sdk/cli/vm/switch.py

@@ -0,0 +1,38 @@
+from typing import Optional
+
+import click
+
+from lightning_sdk.cli.studio.switch import switch_impl
+from lightning_sdk.machine import Machine
+
+
+@click.command("switch")
+@click.option(
+    "--name",
+    help=(
+        "The name of the VM to switch to a different machine. "
+        "If not provided, will try to infer from environment, "
+        "use the default value from the config or prompt for interactive selection."
+    ),
+)
+@click.option("--teamspace", help="Override default teamspace (format: owner/teamspace)")
+@click.option(
+    "--machine",
+    help="The machine type to switch the studio to.",
+    type=click.Choice(m.name for m in Machine.__dict__.values() if isinstance(m, Machine)),
+)
+@click.option("--interruptible", is_flag=True, help="Switch the studio to an interruptible instance.")
+def switch_vm(
+    name: Optional[str] = None,
+    teamspace: Optional[str] = None,
+    machine: Optional[str] = None,
+    interruptible: bool = False,
+) -> None:
+    """Switch a VM to a different machine type."""
+    return switch_impl(
+        name=name,
+        teamspace=teamspace,
+        machine=machine,
+        interruptible=interruptible,
+        vm=True,
+    )

lightning_sdk/constants.py

@@ -0,0 +1,32 @@
+import os
+from uuid import uuid4
+
+_LIGHTNING_DEBUG = {
+    "": False,
+    "0": False,
+    "false": False,
+    "no": False,
+    "1": True,
+    "true": True,
+    "yes": True,
+}.get(os.getenv("LIGHTNING_DEBUG", "").lower(), False)
+
+
+class Store:
+    def __init__(self) -> None:
+        self._d = {}
+        # This is needed to ensure the ids are the same within created threads and processes.
+        self._list = [str(uuid4().hex) for _ in range(500)]
+
+    def __getitem__(self, key: str) -> str:
+        """Get item."""
+        if key in self._d:
+            return self._d[key]
+
+        value = self._list.pop(0) if self._list else str(uuid4().hex)
+        self._d[key] = value
+        return value
+
+
+__GLOBAL_LIGHTNING_UNIQUE_IDS_STORE__ = Store()
+_LIGHTNING_DISABLE_VERSION_CHECK = int(os.getenv("LIGHTNING_DISABLE_VERSION_CHECK", "0"))