lightning-sdk 0.1.57__py3-none-any.whl → 0.2.0__py3-none-any.whl

lightning_sdk/cli/download.py

@@ -15,74 +15,24 @@ from lightning_sdk.studio import Studio
 from lightning_sdk.utils.resolve import _get_authed_user, skip_studio_init
 
 
-class _Downloads(_StudiosMenu, _TeamspacesMenu):
-    """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.
-        """
-        model(name=name, download_dir=download_dir)
-
-    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.
-        """
-        folder(path=path, studio=studio, local_path=local_path)
-
-    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.
-        """
-        file(path=path, studio=studio, local_path=local_path)
-
-    def container(self, container: str, teamspace: Optional[str] = None, tag: str = "latest") -> None:
-        """Download a docker container from a teamspace.
-
-        Args:
-          container: The name of the container to download.
-          teamspace: The name of the teamspace to download the container from.
-          tag: The tag of the container to download.
-        """
-        download_container(container=container, teamspace=teamspace, tag=tag)
-
-
 @click.group(name="download")
 def download() -> None:
     """Download resources from Lightning AI."""
 
 
-# @download.command(name="model")
-# @click.option(
-#     "--name",
-#     help=(
-#         "The name of the Model you want to download. "
-#         "This should have the format <ORGANIZATION-NAME>/<TEAMSPACE-NAME>/<MODEL-NAME>."
-#     ),
-# )
-# @click.option("--download-dir", default=".", help="The directory where the Model should be downloaded.")
+@download.command(name="model")
+@click.argument("name")
+@click.option(
+    "--download-dir", "--download_dir", default=".", help="The directory where the Model should be downloaded."
+)
 def model(name: str, download_dir: str = ".") -> None:
-    """Download a Model."""
+    """Download a model from a teamspace.
+
+    Example:
+      lightning download model NAME
+
+    NAME: The name of the model to download in the format of <ORGANIZATION-NAME>/<TEAMSPACE-NAME>/<MODEL-NAME>.
+    """
     download_model(
         name=name,
         download_dir=download_dir,
@@ -90,28 +40,30 @@ def model(name: str, download_dir: str = ".") -> None:
     )
 
 
-# @download.command(name="folder")
-# @click.option(
-#     "--path",
-#     default="",
-#     help=(
-#         "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."
-#     ),
-# )
-# @click.option(
-#     "--studio",
-#     default=None,
-#     help=(
-#         "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, "
-#         "a menu filtered studios will be shown for final selection."
-#     ),
-# )
-# @click.option("--local-path", default=".", help="The path to the directory you want to download the folder to.")
+@download.command(name="folder")
+@click.option(
+    "--path",
+    default="",
+    help=(
+        "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."
+    ),
+)
+@click.option(
+    "--studio",
+    default=None,
+    help=(
+        "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, "
+        "a menu filtered studios will be shown for final selection."
+    ),
+)
+@click.option(
+    "--local-path", "--local_path", default=".", help="The path to the directory you want to download the folder to."
+)
 def folder(path: str = "", studio: Optional[str] = None, local_path: str = ".") -> None:
     """Download a folder from a Studio."""
     local_path = Path(local_path)
@@ -136,28 +88,30 @@ def folder(path: str = "", studio: Optional[str] = None, local_path: str = ".")
         ) from e
 
 
-# @download.command(name="file")
-# @click.option(
-#     "--path",
-#     default="",
-#     help=(
-#         "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."
-#     ),
-# )
-# @click.option(
-#     "--studio",
-#     default=None,
-#     help=(
-#         "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, "
-#         "a menu filtered studios will be shown for final selection."
-#     ),
-# )
-# @click.option("--local-path", default=".", help="The path to the directory you want to download the folder to.")
+@download.command(name="file")
+@click.option(
+    "--path",
+    default="",
+    help=(
+        "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."
+    ),
+)
+@click.option(
+    "--studio",
+    default=None,
+    help=(
+        "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, "
+        "a menu filtered studios will be shown for final selection."
+    ),
+)
+@click.option(
+    "--local-path", "--local_path", default=".", help="The path to the directory you want to download the folder to."
+)
 def file(path: str = "", studio: Optional[str] = None, local_path: str = ".") -> None:
     """Download a file from a Studio."""
     local_path = Path(local_path)
@@ -181,12 +135,18 @@ def file(path: str = "", studio: Optional[str] = None, local_path: str = ".") ->
         ) from e
 
 
-# @download.command(name="container")
-# @click.argument("container")
-# @click.argument("teamspace", default=None, help="The name of the teamspace to download the container from")
-# @click.argument("tag", default="latest", show_default=True, help="The tag of the container to download.")
+@download.command(name="container")
+@click.argument("container")
+@click.option("--teamspace", default=None, help="The name of the teamspace to download the container from")
+@click.option("--tag", default="latest", show_default=True, help="The tag of the container to download.")
 def download_container(container: str, teamspace: Optional[str] = None, tag: str = "latest") -> None:
-    """Download the docker container CONTAINER from a teamspace."""
+    """Download a docker container from a teamspace.
+
+    Example:
+      lightning download container CONTAINER
+
+    CONTAINER: The name of the container to download.
+    """
     console = Console()
     menu = _TeamspacesMenu()
     resolved_teamspace = menu._resolve_teamspace(teamspace)

lightning_sdk/cli/entrypoint.py

@@ -3,62 +3,31 @@ from types import TracebackType
 from typing import Type
 
 import click
-from fire import Fire
-from lightning_utilities.core.imports import RequirementCache
 from rich.console import Console
 from rich.panel import Panel
 
+from lightning_sdk import __version__
 from lightning_sdk.api.studio_api import _cloud_url
-from lightning_sdk.cli.ai_hub import _AIHub, aihub
-from lightning_sdk.cli.configure import _Configure, configure
-from lightning_sdk.cli.connect import _Connect, connect
-from lightning_sdk.cli.delete import _Delete, delete
-from lightning_sdk.cli.download import _Downloads, download
-from lightning_sdk.cli.generate import _Generate, generate
-from lightning_sdk.cli.inspect import _Inspect, inspect
-from lightning_sdk.cli.legacy import _LegacyLightningCLI
-from lightning_sdk.cli.list import _List
-from lightning_sdk.cli.run import _Run
-from lightning_sdk.cli.serve import _Docker, _LitServe
-from lightning_sdk.cli.start import _Start
-from lightning_sdk.cli.stop import _Stop
-from lightning_sdk.cli.switch import _Switch
-from lightning_sdk.cli.upload import _Uploads
+from lightning_sdk.cli.ai_hub import aihub
+from lightning_sdk.cli.coloring import CustomHelpFormatter
+from lightning_sdk.cli.configure import configure
+from lightning_sdk.cli.connect import connect
+from lightning_sdk.cli.create import create
+from lightning_sdk.cli.delete import delete
+from lightning_sdk.cli.docker import dockerize
+from lightning_sdk.cli.download import download
+from lightning_sdk.cli.generate import generate
+from lightning_sdk.cli.inspect import inspect
+from lightning_sdk.cli.list import list_cli
+from lightning_sdk.cli.open import open
+from lightning_sdk.cli.run import run
+from lightning_sdk.cli.serve import serve
+from lightning_sdk.cli.start import start
+from lightning_sdk.cli.stop import stop
+from lightning_sdk.cli.switch import switch
+from lightning_sdk.cli.upload import upload
 from lightning_sdk.lightning_cloud.login import Auth
 
-_LIGHTNING_AVAILABLE = RequirementCache("lightning")
-
-
-class StudioCLI:
-    """Command line interface (CLI) to interact with/manage Lightning AI Studios."""
-
-    def __init__(self) -> None:
-        self.download = _Downloads()
-        self.upload = _Uploads()
-        self.aihub = _AIHub()
-        self.run = _Run(legacy_run=_LegacyLightningCLI() if _LIGHTNING_AVAILABLE else None)
-        self.serve = _LitServe()
-        self.dockerize = _Docker()
-        self.list = _List()
-        self.delete = _Delete()
-        self.inspect = _Inspect()
-        self.stop = _Stop()
-        self.start = _Start()
-        self.switch = _Switch()
-        self.generate = _Generate()
-        self.connect = _Connect()
-        self.configure = _Configure()
-
-        sys.excepthook = _notify_exception
-
-    def login(self) -> None:
-        """Login to Lightning AI Studios."""
-        return login()
-
-    def logout(self) -> None:
-        """Logout from Lightning AI Studios."""
-        return logout()
-
 
 def _notify_exception(exception_type: Type[BaseException], value: BaseException, tb: TracebackType) -> None:  # No
     """CLI won't show tracebacks, just print the exception message."""
@@ -66,17 +35,17 @@ def _notify_exception(exception_type: Type[BaseException], value: BaseException,
     console.print(Panel(value))
 
 
+@click.group(name="lightning", help="Command line interface (CLI) to interact with/manage Lightning AI Studios.")
+@click.version_option(__version__, message="Lightning CLI version %(version)s")
 def main_cli() -> None:
-    """CLI entrypoint."""
-    Fire(StudioCLI(), name="lightning")
+    sys.excepthook = _notify_exception
 
 
-@click.group(name="lightning", help="Command line interface (CLI) to interact with/manage Lightning AI Studios.")
-def main_cli_click() -> None:
-    pass
+# colorful help messages
+main_cli.context_class.formatter_class = CustomHelpFormatter
 
 
-# @main_cli_click.command
+@main_cli.command
 def login() -> None:
     """Login to Lightning AI Studios."""
     auth = Auth()
@@ -88,21 +57,31 @@ def login() -> None:
         raise RuntimeError(f"Unable to connect to {_cloud_url()}. Please check your internet connection.") from None
 
 
-# @main_cli_click.command
+@main_cli.command
 def logout() -> None:
     """Logout from Lightning AI Studios."""
     auth = Auth()
     auth.clear()
 
 
-# TODO: handle exception hook registration
-main_cli_click.add_command(aihub)
-main_cli_click.add_command(configure)
-main_cli_click.add_command(connect)
-main_cli_click.add_command(delete)
-main_cli_click.add_command(download)
-main_cli_click.add_command(generate)
-main_cli_click.add_command(inspect)
+# additional commands
+main_cli.add_command(aihub)
+main_cli.add_command(configure)
+main_cli.add_command(connect)
+main_cli.add_command(create)
+main_cli.add_command(delete)
+main_cli.add_command(dockerize)
+main_cli.add_command(download)
+main_cli.add_command(generate)
+main_cli.add_command(inspect)
+main_cli.add_command(list_cli)
+main_cli.add_command(run)
+main_cli.add_command(serve)
+main_cli.add_command(start)
+main_cli.add_command(stop)
+main_cli.add_command(switch)
+main_cli.add_command(upload)
+main_cli.add_command(open)
 
 
 if __name__ == "__main__":

lightning_sdk/cli/generate.py

@@ -6,19 +6,37 @@ from rich.console import Console
 from lightning_sdk.cli.studios_menu import _StudiosMenu
 
 
-class _Generate:
+@click.group(name="generate")
+def generate() -> None:
     """Generate configs (such as ssh for studio) and print them to commandline."""
 
-    def ssh(self, name: Optional[str] = None, teamspace: Optional[str] = None) -> None:
-        """Get SSH config entry for a studio.
 
-        Args:
-            name: The name of the studio to obtain SSH config.
-                If not specified, tries to infer from the environment (e.g. when run from within a Studio.)
-            teamspace: The teamspace the studio is part of. Should be of format <OWNER>/<TEAMSPACE_NAME>.
-                If not specified, tries to infer from the environment (e.g. when run from within a Studio.)
-        """
-        ssh(name=name, teamspace=teamspace)
+@generate.command(name="ssh")
+@click.option(
+    "--name",
+    default=None,
+    help=(
+        "The name of the studio to obtain SSH config. "
+        "If not specified, tries to infer from the environment (e.g. when run from within a Studio.)"
+    ),
+)
+@click.option(
+    "--teamspace",
+    default=None,
+    help=(
+        "The teamspace the studio is part of. "
+        "Should be of format <OWNER>/<TEAMSPACE_NAME>. "
+        "If not specified, tries to infer from the environment (e.g. when run from within a Studio.)"
+    ),
+)
+def ssh(name: Optional[str] = None, teamspace: Optional[str] = None) -> None:
+    """Get SSH config entry for a studio."""
+    menu = _StudiosMenu()
+    studio = menu._get_studio(name=name, teamspace=teamspace)
+
+    conf = _generate_ssh_config(key_path="~/.ssh/lightning_rsa", user=f"s_{studio._studio.id}", host=studio.name)
+    # Print the SSH config
+    Console().print(f"# ssh s_{studio._studio.id}@ssh.lightning.ai\n\n" + conf)
 
 
 def _generate_ssh_config(key_path: str, host: str, user: str) -> str:
@@ -32,36 +50,3 @@ def _generate_ssh_config(key_path: str, host: str, user: str) -> str:
       StrictHostKeyChecking no
       UserKnownHostsFile=/dev/null
     """
-
-
-@click.group(name="generate")
-def generate() -> None:
-    """Generate configs (such as ssh for studio) and print them to commandline."""
-
-
-# @generate.command(name="ssh")
-# @click.option(
-#     "--name",
-#     default=None,
-#     help=(
-#         "The name of the studio to obtain SSH config. "
-#         "If not specified, tries to infer from the environment (e.g. when run from within a Studio.)"
-#     ),
-# )
-# @click.option(
-#     "--teamspace",
-#     default=None,
-#     help=(
-#         "The teamspace the studio is part of. "
-#         "Should be of format <OWNER>/<TEAMSPACE_NAME>. "
-#         "If not specified, tries to infer from the environment (e.g. when run from within a Studio.)"
-#     ),
-# )
-def ssh(name: Optional[str] = None, teamspace: Optional[str] = None) -> None:
-    """Get SSH config entry for a studio."""
-    menu = _StudiosMenu()
-    studio = menu._get_studio(name=name, teamspace=teamspace)
-
-    conf = _generate_ssh_config(key_path="~/.ssh/lightning_rsa", user=f"s_{studio._studio.id}", host=studio.name)
-    # Print the SSH config
-    Console().print(f"# ssh s_{studio._studio.id}@ssh.lightning.ai\n\n" + conf)

lightning_sdk/cli/inspect.py

@@ -6,67 +6,39 @@ from rich.console import Console
 from lightning_sdk.cli.job_and_mmt_action import _JobAndMMTAction
 
 
-class _Inspect:
-    """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.
-
-        """
-        job(name=name, teamspace=teamspace)
-
-    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.
-
-        """
-        mmt(name=name, teamspace=teamspace)
-
-
 @click.group(name="inspect")
 def inspect() -> None:
     """Inspect resources of the Lightning AI platform to get additional details as JSON."""
 
 
-# @inspect.command(name="job")
-# @click.option("--name", default=None, help="the name of the job. If not specified can be selected interactively.")
-# @click.option(
-#     "--teamspace",
-#     default=None,
-#     help=(
-#         "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."
-#     ),
-# )
+@inspect.command(name="job")
+@click.option("--name", default=None, help="the name of the job. If not specified can be selected interactively.")
+@click.option(
+    "--teamspace",
+    default=None,
+    help=(
+        "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."
+    ),
+)
 def job(name: Optional[str] = None, teamspace: Optional[str] = None) -> None:
     """Inspect a job for further details as JSON."""
     menu = _JobAndMMTAction()
     Console().print(menu.job(name=name, teamspace=teamspace).json())
 
 
-# @inspect.command(name="mmt")
-# @click.option("--name", default=None, help="the name of the job. If not specified can be selected interactively.")
-# @click.option(
-#     "--teamspace",
-#     default=None,
-#     help=(
-#         "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."
-#     ),
-# )
+@inspect.command(name="mmt")
+@click.option("--name", default=None, help="the name of the job. If not specified can be selected interactively.")
+@click.option(
+    "--teamspace",
+    default=None,
+    help=(
+        "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."
+    ),
+)
 def mmt(name: Optional[str] = None, teamspace: Optional[str] = None) -> None:
     """Inspect a multi-machine job for further details as JSON."""
     menu = _JobAndMMTAction()