lightning-sdk 0.1.49__py3-none-any.whl → 2025.11.5__py3-none-any.whl

{lightning_sdk-0.1.49.dist-info → lightning_sdk-2025.11.5.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.3.0)
+Generator: setuptools (75.3.2)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

{lightning_sdk-0.1.49.dist-info → lightning_sdk-2025.11.5.dist-info}/entry_points.txt

@@ -1,2 +1,3 @@
 [console_scripts]
 lightning = lightning_sdk.cli.entrypoint:main_cli
+lightning-sdk = lightning_sdk.cli.entrypoint:main_cli

lightning_sdk/cli/ai_hub.py

@@ -1,49 +0,0 @@
-from typing import List, Optional
-
-from lightning_sdk.ai_hub import AIHub
-from lightning_sdk.cli.studios_menu import _StudiosMenu
-
-
-class _AIHub(_StudiosMenu):
-    """Interact with Lightning Studio - AI Hub."""
-
-    def __init__(self) -> None:
-        self._hub = AIHub()
-
-    def api_info(self, api_id: str) -> dict:
-        """Get full API template info such as input details.
-
-        Example:
-          lightning aihub api_info [API_ID]
-
-        Args:
-          api_id: The ID of the API for which information is requested.
-        """
-        return self._hub.api_info(api_id)
-
-    def list_apis(self, search: Optional[str] = None) -> List[dict]:
-        """List API templates available in the AI Hub.
-
-        Args:
-          search: Search for API templates by name.
-        """
-        return self._hub.list_apis(search=search)
-
-    def deploy(
-        self,
-        api_id: str,
-        cloud_account: Optional[str] = None,
-        name: Optional[str] = None,
-        teamspace: Optional[str] = None,
-        org: Optional[str] = None,
-    ) -> dict:
-        """Deploy an API template from the AI Hub.
-
-        Args:
-          api_id: API template ID.
-          cloud_account: Cloud Account to deploy the API to. Defaults to user's default cloud account.
-          name: Name of the deployed API. Defaults to the name of the API template.
-          teamspace: Teamspace to deploy the API to. Defaults to user's default teamspace.
-          org: Organization to deploy the API to. Defaults to user's default organization.
-        """
-        return self._hub.run(api_id, cloud_account=cloud_account, name=name, teamspace=teamspace, org=org)

lightning_sdk/cli/delete.py

@@ -1,58 +0,0 @@
-from typing import Optional
-
-from lightning_sdk.cli.exceptions import StudioCliError
-from lightning_sdk.cli.job_and_mmt_action import _JobAndMMTAction
-from lightning_sdk.cli.teamspace_menu import _TeamspacesMenu
-from lightning_sdk.lit_container import LitContainer
-
-
-class _Delete(_JobAndMMTAction, _TeamspacesMenu):
-    """Delete resources on the Lightning AI platform."""
-
-    def container(self, container: str, teamspace: Optional[str] = None) -> None:
-        """Delete a docker container.
-
-        Args:
-            container: The name of the container to delete.
-            teamspace: The teamspace to delete the container from. Should be specified as {owner}/{name}
-                If not provided, can be selected in an interactive menu.
-        """
-        api = LitContainer()
-        resolved_teamspace = self._resolve_teamspace(teamspace=teamspace)
-        try:
-            api.delete_container(container, resolved_teamspace.name, resolved_teamspace.owner.name)
-            print(f"Container {container} deleted successfully.")
-        except Exception as e:
-            raise StudioCliError(
-                f"Could not delete container {container} from project {resolved_teamspace.name}: {e}"
-            ) from None
-
-    def job(self, name: Optional[str] = None, teamspace: Optional[str] = None) -> None:
-        """Delete a job.
-
-        Args:
-            name: the name of the job. If not specified can be selected interactively.
-            teamspace: the name of the teamspace the job lives in.
-                Should be specified as {teamspace_owner}/{teamspace_name} (e.g my-org/my-teamspace).
-                If not specified can be selected interactively.
-
-        """
-        job = super().job(name=name, teamspace=teamspace)
-
-        job.delete()
-        print(f"Successfully deleted {job.name}!")
-
-    def mmt(self, name: Optional[str] = None, teamspace: Optional[str] = None) -> None:
-        """Delete a multi-machine job.
-
-        Args:
-            name: the name of the job. If not specified can be selected interactively.
-            teamspace: the name of the teamspace the job lives in.
-                Should be specified as {teamspace_owner}/{teamspace_name} (e.g my-org/my-teamspace).
-                If not specified can be selected interactively.
-
-        """
-        mmt = super().mmt(name=name, teamspace=teamspace)
-
-        mmt.delete()
-        print(f"Successfully deleted {mmt.name}!")

lightning_sdk/cli/download.py

@@ -1,132 +0,0 @@
-import os
-import re
-from pathlib import Path
-from typing import Optional
-
-from lightning_sdk.cli.exceptions import StudioCliError
-from lightning_sdk.cli.studios_menu import _StudiosMenu
-from lightning_sdk.models import download_model
-from lightning_sdk.studio import Studio
-from lightning_sdk.utils.resolve import _get_authed_user, skip_studio_init
-
-
-class _Downloads(_StudiosMenu):
-    """Download files and folders from Lightning AI."""
-
-    def model(self, name: str, download_dir: str = ".") -> None:
-        """Download a Model.
-
-        Args:
-          name: The name of the Model you want to download.
-            This should have the format <ORGANIZATION-NAME>/<TEAMSPACE-NAME>/<MODEL-NAME>.
-          download_dir: The directory where the Model should be downloaded.
-        """
-        download_model(
-            name=name,
-            download_dir=download_dir,
-            progress_bar=True,
-        )
-
-    def _resolve_studio(self, studio: Optional[str]) -> Studio:
-        user = _get_authed_user()
-        # if no studio specify suggest/filter only user's studios
-        possible_studios = self._get_possible_studios(user, is_owner=studio is None)
-
-        try:
-            if studio:
-                team_name, studio_name = studio.split("/")
-                options = [st for st in possible_studios if st["teamspace"] == team_name and st["name"] == studio_name]
-                if len(options) == 1:
-                    selected_studio = self._get_studio_from_name(studio, possible_studios)
-                # user can also use the partial studio name as secondary interactive selection
-                else:
-                    # filter matching simple reg expressions or start with the team and studio name
-                    possible_studios = filter(
-                        lambda st: (re.match(team_name, st["teamspace"]) or team_name in st["teamspace"])
-                        and (re.match(studio_name, st["name"]) or studio_name in st["name"]),
-                        possible_studios,
-                    )
-                    if not possible_studios:
-                        raise ValueError(
-                            f"Could not find Studio like '{studio}', please consider update your filtering pattern."
-                        )
-                    selected_studio = self._get_studio_from_interactive_menu(list(possible_studios))
-            else:
-                selected_studio = self._get_studio_from_interactive_menu(possible_studios)
-
-        except KeyboardInterrupt:
-            raise KeyboardInterrupt from None
-
-        # give user friendlier error message
-        except Exception as e:
-            raise StudioCliError(
-                f"Could not find the given Studio {studio} to upload files to. "
-                "Please contact Lightning AI directly to resolve this issue."
-            ) from e
-
-        with skip_studio_init():
-            return Studio(**selected_studio)
-
-    def folder(self, path: str = "", studio: Optional[str] = None, local_path: str = ".") -> None:
-        """Download a folder from a Studio.
-
-        Args:
-          path: The relative path within the Studio you want to download.
-            If you leave it empty it will download whole studio and locally creates a new folder
-            with the same name as the selected studio.
-          studio: The name of the studio to upload to. Will show a menu with user's owned studios for selection
-            if not specified. If provided, should be in the form of <TEAMSPACE-NAME>/<STUDIO-NAME> where the names
-            are case-sensitive. The teamspace and studio names can be regular expressions to match, then a menu
-            with filtered studios will be shown for final selection.
-          local_path: The path to the directory you want to download the folder to.
-        """
-        local_path = Path(local_path)
-        if not local_path.is_dir():
-            raise NotADirectoryError(f"'{local_path}' is not a directory")
-
-        resolved_studio = self._resolve_studio(studio)
-
-        if not path:
-            local_path /= resolved_studio.name
-            path = ""
-
-        try:
-            if not path:
-                raise FileNotFoundError()
-            resolved_studio.download_folder(remote_path=path, target_path=str(local_path))
-        except Exception as e:
-            raise StudioCliError(
-                f"Could not download the folder from the given Studio {studio}. "
-                "Please contact Lightning AI directly to resolve this issue."
-            ) from e
-
-    def file(self, path: str = "", studio: Optional[str] = None, local_path: str = ".") -> None:
-        """Download a file from a Studio.
-
-        Args:
-          path: The relative path within the Studio you want to download.
-          studio: The name of the studio to upload to. Will show a menu with user's owned studios for selection
-            if not specified. If provided, should be in the form of <TEAMSPACE-NAME>/<STUDIO-NAME> where the names
-            are case-sensitive. The teamspace and studio names can be regular expressions to match, then a menu
-            with filtered studios will be shown for final selection.
-          local_path: The path to the directory you want to download the file to.
-        """
-        local_path = Path(local_path)
-        if not local_path.is_dir():
-            raise NotADirectoryError(f"'{local_path}' is not a directory")
-
-        resolved_studio = self._resolve_studio(studio)
-
-        if not path:
-            local_path /= resolved_studio.name
-            path = ""
-
-        try:
-            if not path:
-                raise FileNotFoundError()
-            resolved_studio.download_file(remote_path=path, file_path=str(local_path / os.path.basename(path)))
-        except Exception as e:
-            raise StudioCliError(
-                f"Could not download the file from the given Studio {studio}. "
-                "Please contact Lightning AI directly to resolve this issue."
-            ) from e

lightning_sdk/cli/inspect.py

@@ -1,31 +0,0 @@
-from typing import Optional
-
-from lightning_sdk.cli.job_and_mmt_action import _JobAndMMTAction
-
-
-class _Inspect(_JobAndMMTAction):
-    """Inspect resources of the Lightning AI platform to get additional details as JSON."""
-
-    def job(self, name: Optional[str] = None, teamspace: Optional[str] = None) -> None:
-        """Inspect a job for further details as JSON.
-
-        Args:
-            name: the name of the job. If not specified can be selected interactively.
-            teamspace: the name of the teamspace the job lives in.
-                Should be specified as {teamspace_owner}/{teamspace_name} (e.g my-org/my-teamspace).
-                If not specified can be selected interactively.
-
-        """
-        print(super().job(name=name, teamspace=teamspace).json())
-
-    def mmt(self, name: Optional[str] = None, teamspace: Optional[str] = None) -> None:
-        """Inspect a multi-machine job for further details as JSON.
-
-        Args:
-            name: the name of the job. If not specified can be selected interactively.
-            teamspace: the name of the teamspace the job lives in.
-                Should be specified as {teamspace_owner}/{teamspace_name} (e.g my-org/my-teamspace).
-                If not specified can be selected interactively.
-
-        """
-        print(super().mmt(name=name, teamspace=teamspace).json())

lightning_sdk/cli/legacy.py

@@ -1,135 +0,0 @@
-import subprocess
-from typing import Any, Optional, Union
-
-
-class _LegacyLightningCLI:
-    """Legacy CLI for `fabric run model` and `lightning run app`."""
-
-    def model(
-        self,
-        script: str,
-        accelerator: Optional[str] = None,
-        strategy: Optional[str] = None,
-        devices: str = "1",
-        num_nodes: int = 1,
-        node_rank: int = 0,
-        main_address: str = "127.0.0.1",
-        main_port: int = 29400,
-        precision: Optional[Union[int, str]] = None,
-        *script_args: Any,
-    ) -> None:
-        """Legacy CLI for `fabric run model`.
-
-        Args:
-            script: The script containing the fabric definition to launch
-            accelerator: The hardware accelerator to run on.
-            strategy: Strategy for how to run across multiple devices.
-            devices: Number of devices to run on (``int``), which devices to run on (``list`` or ``str``),
-                or ``'auto'``. The value applies per node.
-            num_nodes: Number of machines (nodes) for distributed execution.
-            node_rank: The index of the machine (node) this command gets started on.
-                Must be a number in the range 0, ..., num_nodes - 1.
-            main_address: The hostname or IP address of the main machine (usually the one with node_rank = 0).
-            main_port: The main port to connect to the main machine.
-            precision: Double precision (``64-true`` or ``64``), full precision (``32-true`` or ``64``),
-                half precision (``16-mixed`` or ``16``) or bfloat16 precision (``bf16-mixed`` or ``bf16``)
-            script_args: Arguments passed to the script to execute
-
-        """
-        print(
-            "lightning run model is deprecated and will be removed in future versions."
-            " Please call `fabric run model` instead."
-        )
-
-        args = []
-        if accelerator is not None:
-            args.extend(["--accelerator", accelerator])
-
-        if strategy is not None:
-            args.extend(["--strategy", strategy])
-
-        args.extend(["--devices", devices])
-        args.extend(["--num_nodes", num_nodes])
-        args.extend(["--node_rank", node_rank])
-        args.extend(["--main_address", main_address])
-        args.extend(["--main_port", main_port])
-
-        if precision is not None:
-            args.extend(["--precision", precision])
-
-        args.extend(list(script_args))
-        subprocess.run(["fabric", "run", "model", script, *args])
-
-    def app(
-        self,
-        file: str,
-        cloud: bool = False,
-        name: str = "",
-        without_server: bool = False,
-        no_cache: bool = False,
-        blocking: bool = False,
-        open_ui: bool = False,
-        env: str = "",
-        secret: str = "",
-        app_args: str = "",
-        setup: str = "",
-        enable_basic_auth: str = "",
-    ) -> None:
-        """Legacy CLI for `lightning_app run app`.
-
-        Args:
-            file: The file containing your application
-            cloud: Run the app in the cloud
-            name: The current application name
-            without_server: Run without server
-            no_cache: Disable caching of packages installed from requirements.txt
-            blocking: Don't block
-            open_ui: Decide whether to launch the app UI in a web browser
-            env: Environment variables to be set for the app.
-            secret: Secret variables to be set for the app.
-            app_args: Collection of arguments for the app.
-            setup: run environment setup commands from the app comments
-            enable_basic_auth: Enable basic authentication for the app and use credentials provided in the format
-                username:password
-
-        """
-        print(
-            "lightning run app is deprecated and will be removed in future versions."
-            " Please call `lightning_app run app` instead."
-        )
-        args = []
-
-        if cloud:
-            args.append("--cloud")
-
-        if name:
-            args.extend(["--name", name])
-
-        if without_server:
-            args.append("--without-server")
-
-        if no_cache:
-            args.append("--no-cache")
-
-        if blocking:
-            args.append("--blocking")
-
-        if open_ui:
-            args.append("--open-ui")
-
-        if env:
-            args.extend(["--env", env])
-
-        if secret:
-            args.extend(["--secret", secret])
-
-        if app_args:
-            args.extend(["--app_args", app_args])
-
-        if setup:
-            args.extend(["--setup", setup])
-
-        if enable_basic_auth:
-            args.extend(["--enable-basic-auth", enable_basic_auth])
-
-        subprocess.run(["lightning_app", "run", "app", file, *args])

lightning_sdk/cli/list.py

@@ -1,112 +0,0 @@
-from typing import Optional
-
-from rich.console import Console
-from rich.table import Table
-
-from lightning_sdk.cli.teamspace_menu import _TeamspacesMenu
-from lightning_sdk.lit_container import LitContainer
-
-
-class _List(_TeamspacesMenu):
-    """List resources on the Lightning AI platform."""
-
-    def jobs(self, teamspace: Optional[str] = None) -> None:
-        """List jobs for a given teamspace.
-
-        Args:
-            teamspace: the teamspace to list jobs from. Should be specified as {owner}/{name}
-                If not provided, can be selected in an interactive menu.
-
-        """
-        resolved_teamspace = self._resolve_teamspace(teamspace=teamspace)
-
-        jobs = resolved_teamspace.jobs
-
-        table = Table(
-            pad_edge=True,
-        )
-        table.add_column("Name")
-        table.add_column("Teamspace")
-        table.add_column("Studio")
-        table.add_column("Image")
-        table.add_column("Status")
-        table.add_column("Machine")
-        table.add_column("Total Cost")
-        for j in jobs:
-            # we know we just fetched these, so no need to refetch
-            j._prevent_refetch_latest = True
-            j._internal_job._prevent_refetch_latest = True
-
-            studio = j.studio
-            table.add_row(
-                j.name,
-                f"{j.teamspace.owner.name}/{j.teamspace.name}",
-                studio.name if studio else None,
-                j.image,
-                str(j.status),
-                str(j.machine),
-                f"{j.total_cost:.3f}",
-            )
-
-        console = Console()
-        console.print(table)
-
-    def mmts(self, teamspace: Optional[str] = None) -> None:
-        """List multi-machine jobs for a given teamspace.
-
-        Args:
-            teamspace: the teamspace to list jobs from. Should be specified as {owner}/{name}
-                If not provided, can be selected in an interactive menu.
-
-        """
-        resolved_teamspace = self._resolve_teamspace(teamspace=teamspace)
-
-        jobs = resolved_teamspace.multi_machine_jobs
-
-        table = Table(pad_edge=True)
-        table.add_column("Name")
-        table.add_column("Teamspace")
-        table.add_column("Studio")
-        table.add_column("Image")
-        table.add_column("Status")
-        table.add_column("Machine")
-        table.add_column("Num Machines")
-        table.add_column("Total Cost")
-        for j in jobs:
-            # we know we just fetched these, so no need to refetch
-            j._prevent_refetch_latest = True
-            j._internal_job._prevent_refetch_latest = True
-
-            studio = j.studio
-            table.add_row(
-                j.name,
-                f"{j.teamspace.owner.name}/{j.teamspace.name}",
-                studio.name if studio else None,
-                j.image,
-                str(j.status),
-                str(j.machine),
-                str(j.num_machines),
-                str(j.total_cost),
-            )
-
-        console = Console()
-        console.print(table)
-
-    def containers(self, teamspace: Optional[str] = None) -> None:
-        """Display the list of available containers.
-
-        Args:
-            teamspace: The teamspace to list containers from. Should be specified as {owner}/{name}
-                If not provided, can be selected in an interactive menu.
-        """
-        api = LitContainer()
-        resolved_teamspace = self._resolve_teamspace(teamspace=teamspace)
-        result = api.list_containers(teamspace=resolved_teamspace.name, org=resolved_teamspace.owner.name)
-        table = Table(pad_edge=True, box=None)
-        table.add_column("REPOSITORY")
-        table.add_column("IMAGE ID")
-        table.add_column("CREATED")
-        for repo in result:
-            table.add_row(repo["REPOSITORY"], repo["IMAGE ID"], repo["CREATED"])
-        console = Console()
-        console.print(table)