lamin_cli 0.15.0__tar.gz → 0.16.0__tar.gz

{lamin_cli-0.15.0 → lamin_cli-0.16.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: lamin_cli
-Version: 0.15.0
+Version: 0.16.0
 Summary: Lamin CLI.
 Author-email: Lamin Labs <open-source@lamin.ai>
 Description-Content-Type: text/markdown

lamin_cli-0.16.0/lamin_cli/__init__.py

@@ -0,0 +1,3 @@
+"""Lamin CLI."""
+
+__version__ = "0.16.0"

{lamin_cli-0.15.0 → lamin_cli-0.16.0}/lamin_cli/__main__.py

@@ -1,17 +1,73 @@
 from __future__ import annotations
 import os
 import sys
+from collections import OrderedDict
 import inspect
 from importlib.metadata import PackageNotFoundError, version
-from typing import Optional
+from typing import Optional, Mapping
 
 # https://github.com/ewels/rich-click/issues/19
 # Otherwise rich-click takes over the formatting.
 if os.environ.get("NO_RICH"):
     import click as click
+
+    class OrderedGroup(click.Group):
+        """Overwrites list_commands to return commands in order of definition."""
+
+        def __init__(
+            self,
+            name: Optional[str] = None,
+            commands: Optional[Mapping[str, click.Command]] = None,
+            **kwargs,
+        ):
+            super(OrderedGroup, self).__init__(name, commands, **kwargs)
+            self.commands = commands or OrderedDict()
+
+        def list_commands(self, ctx: click.Context) -> Mapping[str, click.Command]:
+            return self.commands
+
+    lamin_group_decorator = click.group(cls=OrderedGroup)
+
 else:
     import rich_click as click
 
+    COMMAND_GROUPS = {
+        "lamin": [
+            {
+                "name": "Main commands",
+                "commands": [
+                    "login",
+                    "init",
+                    "load",
+                    "info",
+                    "close",
+                    "delete",
+                    "logout",
+                ],
+            },
+            {
+                "name": "Data commands",
+                "commands": ["get", "save"],
+            },
+            {
+                "name": "Configuration commands",
+                "commands": ["register", "cache", "set"],
+            },
+            {
+                "name": "Schema commands",
+                "commands": ["migrate", "schema"],
+            },
+        ]
+    }
+
+    lamin_group_decorator = click.rich_config(
+        help_config=click.RichHelpConfiguration(
+            command_groups=COMMAND_GROUPS,
+            style_commands_table_column_width_ratio=(1, 13),
+        )
+    )(click.group())
+
+
 from click import Command, Context
 from lamindb_setup._silence_loggers import silence_loggers
 
@@ -24,35 +80,13 @@ except PackageNotFoundError:
     lamindb_version = "lamindb installation not found"
 
 
-@click.group()
+@lamin_group_decorator
 @click.version_option(version=lamindb_version, prog_name="lamindb")
 def main():
     """Configure LaminDB and perform simple actions."""
     silence_loggers()
 
 
-@main.command()
-def info():
-    """Show user, settings & instance info."""
-    import lamindb_setup
-
-    print(lamindb_setup.settings)
-
-
-# fmt: off
-@main.command()
-@click.option("--storage", type=str, help="local dir, s3://bucket_name, gs://bucket_name")  # noqa: E501
-@click.option("--db", type=str, default=None, help="postgres database connection URL, do not pass for SQLite")  # noqa: E501
-@click.option("--schema", type=str, default=None, help="comma-separated string of schema modules")  # noqa: E501
-@click.option("--name", type=str, default=None, help="instance name")
-# fmt: on
-def init(storage: str, db: Optional[str], schema: Optional[str], name: Optional[str]):
-    """Init a lamindb instance."""
-    from lamindb_setup._init_instance import init as init_
-
-    return init_(storage=storage, db=db, schema=schema, name=name)
-
-
 @main.command()
 @click.argument("user", type=str)
 @click.option("--key", type=str, default=None, help="API key")
@@ -67,12 +101,18 @@ def login(user: str, key: Optional[str], password: Optional[str]):
     return login(user, key=key, password=password)
 
 
+# fmt: off
 @main.command()
-def logout():
-    """Logout."""
-    from lamindb_setup._setup_user import logout
+@click.option("--storage", type=str, help="local dir, s3://bucket_name, gs://bucket_name")  # noqa: E501
+@click.option("--db", type=str, default=None, help="postgres database connection URL, do not pass for SQLite")  # noqa: E501
+@click.option("--schema", type=str, default=None, help="comma-separated string of schema modules")  # noqa: E501
+@click.option("--name", type=str, default=None, help="instance name")
+# fmt: on
+def init(storage: str, db: Optional[str], schema: Optional[str], name: Optional[str]):
+    """Init a lamindb instance."""
+    from lamindb_setup._init_instance import init as init_
 
-    return logout()
+    return init_(storage=storage, db=db, schema=schema, name=name)
 
 
 # fmt: off
@@ -93,36 +133,12 @@ def load(identifier: str, db: Optional[str], storage: Optional[str]):
     return connect(slug=identifier, db=db, storage=storage)
 
 
-# fmt: off
 @main.command()
-@click.argument("instance", type=str, default=None)
-@click.option("--force", is_flag=True, default=False, help="Do not ask for confirmation.")  # noqa: E501
-# fmt: on
-def delete(instance: str, force: bool = False):
-    """Delete an instance."""
-    from lamindb_setup._delete import delete
-
-    return delete(instance, force=force)
-
-
-@main.command(name="set")
-@click.argument(
-    "setting",
-    type=click.Choice(["auto-connect", "private-django-api"], case_sensitive=False),
-)
-@click.argument("value", type=click.BOOL)
-def set_(setting: str, value: bool):
-    """Update settings.
-
-    - `auto-connect` → {attr}`~lamindb.setup.core.SetupSettings.auto_connect`
-    - `private-django-api` → {attr}`~lamindb.setup.core.SetupSettings.private_django_api`
-    """
-    from lamindb_setup import settings
+def info():
+    """Show user, settings & instance info."""
+    import lamindb_setup
 
-    if setting == "auto-connect":
-        settings.auto_connect = value
-    if setting == "private-django-api":
-        settings.private_django_api = value
+    print(lamindb_setup.settings)
 
 
 @main.command()
@@ -136,22 +152,33 @@ def close():
     return close_()
 
 
+# fmt: off
 @main.command()
-def register():
-    """Register an instance on the hub."""
-    from lamindb_setup._register_instance import register as register_
+@click.argument("instance", type=str, default=None)
+@click.option("--force", is_flag=True, default=False, help="Do not ask for confirmation.")  # noqa: E501
+# fmt: on
+def delete(instance: str, force: bool = False):
+    """Delete an instance."""
+    from lamindb_setup._delete import delete
 
-    return register_()
+    return delete(instance, force=force)
 
 
 @main.command()
-@click.argument("action", type=click.Choice(["view"]))
-def schema(action: str):
-    """View schema."""
-    from lamindb_setup._schema import view
+def logout():
+    """Logout."""
+    from lamindb_setup._setup_user import logout
 
-    if action == "view":
-        return view()
+    return logout()
+
+
+@main.command()
+@click.argument("url", type=str)
+def get(url: str):
+    """Get an object from a lamin.ai URL."""
+    from lamin_cli._get import get
+
+    return get(url)
 
 
 @main.command()
@@ -169,18 +196,49 @@ def save(filepath: str, key: str, description: str):
 
 
 @main.command()
-@click.argument("url", type=str)
-def get(url: str):
-    """Get an object from a lamin.ai URL."""
-    from lamin_cli._get import get
+def register():
+    """Register an instance on the hub."""
+    from lamindb_setup._register_instance import register as register_
 
-    return get(url)
+    return register_()
 
 
 main.add_command(cache)
+
+
+@main.command(name="set")
+@click.argument(
+    "setting",
+    type=click.Choice(["auto-connect", "private-django-api"], case_sensitive=False),
+)
+@click.argument("value", type=click.BOOL)
+def set_(setting: str, value: bool):
+    """Update settings.
+
+    - `auto-connect` → {attr}`~lamindb.setup.core.SetupSettings.auto_connect`
+    - `private-django-api` → {attr}`~lamindb.setup.core.SetupSettings.private_django_api`
+    """
+    from lamindb_setup import settings
+
+    if setting == "auto-connect":
+        settings.auto_connect = value
+    if setting == "private-django-api":
+        settings.private_django_api = value
+
+
 main.add_command(migrate)
 
 
+@main.command()
+@click.argument("action", type=click.Choice(["view"]))
+def schema(action: str):
+    """View schema."""
+    from lamindb_setup._schema import view
+
+    if action == "view":
+        return view()
+
+
 # https://stackoverflow.com/questions/57810659/automatically-generate-all-help-documentation-for-click-commands
 # https://claude.ai/chat/73c28487-bec3-4073-8110-50d1a2dd6b84
 def _generate_help():

{lamin_cli-0.15.0 → lamin_cli-0.16.0}/lamin_cli/_get.py

@@ -32,10 +32,10 @@ def get(url: str):
 
     if entity == "transform":
         transform = ln.Transform.get(uid)
-        filepath_cache = transform.source_code.cache()
+        filepath_cache = transform._source_code_artifact.cache()
         target_filename = transform.key
-        if not target_filename.endswith(transform.source_code.suffix):
-            target_filename += transform.source_code.suffix
+        if not target_filename.endswith(transform._source_code_artifact.suffix):
+            target_filename += transform._source_code_artifact.suffix
         filepath_cache.rename(target_filename)
         logger.success(f"cached source code of transform {uid} as {target_filename}")
     elif entity == "artifact":

{lamin_cli-0.15.0 → lamin_cli-0.16.0}/tests/test_save_notebooks.py

@@ -81,8 +81,8 @@ def test_save_consecutive():
     # now, there is a transform record, but we're missing all artifacts
     transform = ln.Transform.filter(uid="hlsFXswrJjtt5zKv").one_or_none()
     assert transform is not None
-    assert transform.latest_report is None
-    assert transform.source_code is None
+    assert transform.latest_run.report is None
+    assert transform._source_code_artifact is None
     assert transform.latest_run.environment is None
 
     # and save again
@@ -97,11 +97,11 @@ def test_save_consecutive():
     # now, we have the associated artifacts
     transform = ln.Transform.filter(uid="hlsFXswrJjtt5zKv").one_or_none()
     assert transform is not None
-    assert transform.latest_report.path.exists()
-    assert transform.latest_run.report.path == transform.latest_report.path
-    assert transform.source_code.hash == "5nc_HMjPvT9n26OWrjq6uQ"
+    assert transform.latest_run.report.path.exists()
+    assert transform.latest_run.report.path == transform.latest_run.report.path
+    assert transform._source_code_artifact.hash == "5nc_HMjPvT9n26OWrjq6uQ"
     assert transform.latest_run.environment.path.exists()
-    assert transform.source_code.path.exists()
+    assert transform._source_code_artifact.path.exists()
 
     # now, assume the user modifies the notebook
     nb = read_notebook(notebook_path)
@@ -128,11 +128,11 @@ def test_save_consecutive():
     assert result.returncode == 0
     # the source code is overwritten with the edits, reflected in a new hash
     transform = ln.Transform.get("hlsFXswrJjtt5zKv")
-    assert transform.latest_report.path.exists()
-    assert transform.latest_run.report.path == transform.latest_report.path
-    assert transform.source_code.hash == "ocLybD0Hv_L3NhhXgTyQcw"
+    assert transform.latest_run.report.path.exists()
+    assert transform.latest_run.report.path == transform.latest_run.report.path
+    assert transform._source_code_artifact.hash == "ocLybD0Hv_L3NhhXgTyQcw"
     assert transform.latest_run.environment.path.exists()
-    assert transform.source_code.path.exists()
+    assert transform._source_code_artifact.path.exists()
 
     # get the the source code via command line
     result = subprocess.run(

{lamin_cli-0.15.0 → lamin_cli-0.16.0}/tests/test_save_scripts.py

@@ -37,9 +37,9 @@ def test_run_save_cache():
     assert "saved: Run" in result.stdout.decode()
 
     transform = ln.Transform.get("m5uCHTTpJnjQ")
-    assert transform.source_code.hash == "T1zmmTJyeEpBxjaHcHcZdg"
+    assert transform._source_code_artifact.hash == "T1zmmTJyeEpBxjaHcHcZdg"
     assert transform.latest_run.environment.path.exists()
-    assert transform.source_code.path.exists()
+    assert transform._source_code_artifact.path.exists()
 
     # you can rerun the same script
     result = subprocess.run(

lamin_cli-0.15.0/lamin_cli/__init__.py

@@ -1,3 +0,0 @@
-"""Lamin CLI."""
-
-__version__ = "0.15.0"