lamin_cli 1.0.7__py2.py3-none-any.whl → 1.2.0__py2.py3-none-any.whl

lamin_cli/__init__.py

@@ -1,3 +1,3 @@
 """Lamin CLI."""
 
-__version__ = "1.0.7"
+__version__ = "1.2.0"

lamin_cli/__main__.py

@@ -1,12 +1,16 @@
 from __future__ import annotations
+
+import inspect
 import os
 import sys
+import warnings
 from collections import OrderedDict
-import inspect
-from importlib.metadata import PackageNotFoundError, version
-from typing import Optional, Mapping
 from functools import wraps
-import warnings
+from importlib.metadata import PackageNotFoundError, version
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from collections.abc import Mapping
 
 # https://github.com/ewels/rich-click/issues/19
 # Otherwise rich-click takes over the formatting.
@@ -18,11 +22,11 @@ if os.environ.get("NO_RICH"):
 
         def __init__(
             self,
-            name: Optional[str] = None,
-            commands: Optional[Mapping[str, click.Command]] = None,
+            name: str | None = None,
+            commands: Mapping[str, click.Command] | None = None,
             **kwargs,
         ):
-            super(OrderedGroup, self).__init__(name, commands, **kwargs)
+            super().__init__(name, commands, **kwargs)
             self.commands = commands or OrderedDict()
 
         def list_commands(self, ctx: click.Context) -> Mapping[str, click.Command]:
@@ -77,12 +81,14 @@ else:
         return wrapper
 
 
-from click import Command, Context
 from lamindb_setup._silence_loggers import silence_loggers
 
-from lamin_cli._settings import settings
 from lamin_cli._cache import cache
 from lamin_cli._migration import migrate
+from lamin_cli._settings import settings
+
+if TYPE_CHECKING:
+    from click import Command, Context
 
 try:
     lamindb_version = version("lamindb")
@@ -100,7 +106,7 @@ def main():
 @main.command()
 @click.argument("user", type=str, default=None, required=False)
 @click.option("--key", type=str, default=None, help="The legacy API key.")
-def login(user: str, key: Optional[str]):
+def login(user: str, key: str | None):
     """Log into LaminHub.
 
     `lamin login` prompts for your API key unless you set it via environment variable `LAMIN_API_KEY`.
@@ -142,24 +148,25 @@ def schema_to_modules_callback(ctx, param, value):
             "The --schema option is deprecated and will be removed in a future version."
             " Please use --modules instead.",
             DeprecationWarning,
+            stacklevel=2,
         )
     return value
 
 
 # fmt: off
 @main.command()
-@click.option("--storage", type=str, help="Local directory, 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("--modules", type=str, default=None, help="Comma-separated string of modules.")  # noqa: E501
+@click.option("--storage", type=str, help="Local directory, s3://bucket_name, gs://bucket_name.")
+@click.option("--db", type=str, default=None, help="Postgres database connection URL, do not pass for SQLite.")
+@click.option("--modules", type=str, default=None, help="Comma-separated string of schema modules.")
 @click.option("--name", type=str, default=None, help="The instance name.")
-@click.option("--schema", type=str, default=None, help="[DEPRECATED] Use --modules instead.", callback=schema_to_modules_callback)  # noqa: E501
+@click.option("--schema", type=str, default=None, help="[DEPRECATED] Use --modules instead.", callback=schema_to_modules_callback)
 # fmt: on
 def init(
     storage: str,
-    db: Optional[str],
-    modules: Optional[str],
-    name: Optional[str],
-    schema: Optional[str],
+    db: str | None,
+    modules: str | None,
+    name: str | None,
+    schema: str | None,
 ):
     """Init an instance."""
     from lamindb_setup._init_instance import init as init_
@@ -182,7 +189,8 @@ def connect(instance: str):
     {attr}`~lamindb.setup.core.SetupSettings.auto_connect` to `True` so that you
     auto-connect in a Python session upon importing `lamindb`.
     """
-    from lamindb_setup import settings as settings_, connect as connect_
+    from lamindb_setup import connect as connect_
+    from lamindb_setup import settings as settings_
 
     settings_.auto_connect = True
     return connect_(instance, _reload_lamindb=False)
@@ -217,7 +225,7 @@ def info(schema: bool):
 # 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
+@click.option("--force", is_flag=True, default=False, help="Do not ask for confirmation.")
 # fmt: on
 def delete(instance: str, force: bool = False):
     """Delete an entity.
@@ -236,7 +244,7 @@ def delete(instance: str, force: bool = False):
 @click.option(
     "--with-env", is_flag=True, help="Also return the environment for a tranform."
 )
-def load(entity: str, uid: str = None, key: str = None, with_env: bool = False):
+def load(entity: str, uid: str | None = None, key: str | None = None, with_env: bool = False):
     """Load a file or folder.
 
     Pass a URL, `artifact`, or `transform`. For example:
@@ -252,7 +260,8 @@ def load(entity: str, uid: str = None, key: str = None, with_env: bool = False):
     """
     is_slug = entity.count("/") == 1
     if is_slug:
-        from lamindb_setup import settings as settings_, connect
+        from lamindb_setup import connect
+        from lamindb_setup import settings as settings_
 
         # can decide whether we want to actually deprecate
         # click.echo(
@@ -270,18 +279,31 @@ def load(entity: str, uid: str = None, key: str = None, with_env: bool = False):
 @click.argument("entity", type=str)
 @click.option("--uid", help="The uid for the entity.")
 @click.option("--key", help="The key for the entity.")
-@click.option(
-    "--with-env", is_flag=True, help="Also return the environment for a tranform."
-)
-def get(entity: str, uid: str = None, key: str = None, with_env: bool = False):
+def get(entity: str, uid: str | None = None, key: str | None = None):
     """Query metadata about an entity.
 
-    Currently only works for artifact & transform and behaves like `lamin load`.
+    Currently only works for artifact.
     """
-    from lamin_cli._load import load as load_
+    import lamindb_setup as ln_setup
 
-    click.echo(f"! to load a file or folder, please use: lamin load {entity}")
-    return load_(entity, uid=uid, key=key, with_env=with_env)
+    from ._load import decompose_url
+
+    if entity.startswith("https://") and "lamin" in entity:
+        url = entity
+        instance, entity, uid = decompose_url(url)
+    elif entity not in {"artifact"}:
+        raise SystemExit("Entity has to be a laminhub URL or 'artifact'")
+    else:
+        instance = ln_setup.settings.instance.slug
+
+    ln_setup.connect(instance)
+    import lamindb as ln
+
+    if uid is not None:
+        artifact = ln.Artifact.get(uid)
+    else:
+        artifact = ln.Artifact.get(key=key)
+    artifact.describe()
 
 
 @main.command()
@@ -315,7 +337,7 @@ def _generate_help():
     out: dict[str, dict[str, str | None]] = {}
 
     def recursive_help(
-        cmd: Command, parent: Optional[Context] = None, name: tuple[str, ...] = ()
+        cmd: Command, parent: Context | None = None, name: tuple[str, ...] = ()
     ):
         ctx = click.Context(cmd, info_name=cmd.name, parent=parent)
         assert cmd.name

lamin_cli/_cache.py

@@ -1,4 +1,5 @@
 from __future__ import annotations
+
 import os
 
 if os.environ.get("NO_RICH"):

lamin_cli/_load.py

@@ -1,14 +1,15 @@
 from __future__ import annotations
-from typing import Tuple
-from lamin_utils import logger
-import shutil
+
 import re
+import shutil
 from pathlib import Path
 
+from lamin_utils import logger
+
 
-def decompose_url(url: str) -> Tuple[str, str, str]:
-    assert "transform" in url or "artifact" in url
-    for entity in ["transform", "artifact"]:
+def decompose_url(url: str) -> tuple[str, str, str]:
+    assert any(keyword in url for keyword in ["transform", "artifact", "collection"])
+    for entity in ["transform", "artifact", "collection"]:
         if entity in url:
             break
     uid = url.split(f"{entity}/")[1]
@@ -16,14 +17,18 @@ def decompose_url(url: str) -> Tuple[str, str, str]:
     return instance_slug, entity, uid
 
 
-def load(entity: str, uid: str = None, key: str = None, with_env: bool = False):
+def load(
+    entity: str, uid: str | None = None, key: str | None = None, with_env: bool = False
+):
     import lamindb_setup as ln_setup
 
     if entity.startswith("https://") and "lamin" in entity:
         url = entity
         instance, entity, uid = decompose_url(url)
-    elif entity not in {"artifact", "transform"}:
-        raise SystemExit("Entity has to be a laminhub URL or 'artifact' or 'transform'")
+    elif entity not in {"artifact", "transform", "collection"}:
+        raise SystemExit(
+            "Entity has to be a laminhub URL or 'artifact', 'collection', or 'transform'"
+        )
     else:
         instance = ln_setup.settings.instance.slug
 
@@ -42,11 +47,13 @@ def load(entity: str, uid: str = None, key: str = None, with_env: bool = False):
                 new_content = transform.source_code.replace(
                     "# # transform.name", f"# # {transform.description}"
                 )
-            elif transform.source_code.startswith("# %% [markdown]\n#\n"):
-                new_content = transform.source_code.replace(
-                    "# %% [markdown]\n#\n",
-                    f"# %% [markdown]\n# # {transform.description}\n",
-                )
+            elif transform.source_code.startswith("# %% [markdown]"):
+                source_code_split = transform.source_code.split("\n")
+                if source_code_split[1] == "#":
+                    source_code_split[1] = f"# # {transform.description}"
+                new_content = "\n".join(source_code_split)
+            else:
+                new_content = transform.source_code
         else:  # R notebook
             # Pattern to match title only within YAML header section
             title_pattern = r'^---\n.*?title:\s*"([^"]*)".*?---'
@@ -83,82 +90,103 @@ def load(entity: str, uid: str = None, key: str = None, with_env: bool = False):
 
     query_by_uid = uid is not None
 
-    if entity == "transform":
-        if query_by_uid:
-            # we don't use .get here because DoesNotExist is hard to catch
-            # due to private django API
-            # here full uid is not expected anymore as before
-            # via ln.Transform.objects.get(uid=uid)
-            transforms = ln.Transform.objects.filter(uid__startswith=uid)
-        else:
-            # if below, we take is_latest=True as the criterion, we might get draft notebooks
-            # hence, we use source_code__isnull=False and order by created_at instead
-            transforms = ln.Transform.objects.filter(key=key, source_code__isnull=False)
-
-        if (n_transforms := len(transforms)) == 0:
-            err_msg = f"uid {uid}" if query_by_uid else f"key={key} and source_code"
-            raise SystemExit(f"Transform with {err_msg} does not exist.")
-
-        if n_transforms > 1:
-            transforms = transforms.order_by("-created_at")
-        transform = transforms.first()
-
-        target_relpath = Path(transform.key)
-        if len(target_relpath.parents) > 1:
-            logger.important(
-                "preserve the folder structure for versioning:"
-                f" {target_relpath.parent}/"
-            )
-            target_relpath.parent.mkdir(parents=True, exist_ok=True)
-        if target_relpath.exists():
-            response = input(f"! {target_relpath} exists: replace? (y/n)")
-            if response != "y":
-                raise SystemExit("Aborted.")
-
-        if transform.source_code is not None:
-            if target_relpath.suffix in (".ipynb", ".Rmd", ".qmd"):
-                script_to_notebook(transform, target_relpath, bump_revision=True)
+    match entity:
+        case "transform":
+            if query_by_uid:
+                # we don't use .get here because DoesNotExist is hard to catch
+                # due to private django API
+                # here full uid is not expected anymore as before
+                # via ln.Transform.objects.get(uid=uid)
+                transforms = ln.Transform.objects.filter(uid__startswith=uid)
             else:
-                target_relpath.write_text(transform.source_code)
-        else:
-            raise SystemExit("No source code available for this transform.")
+                # if below, we take is_latest=True as the criterion, we might get draft notebooks
+                # hence, we use source_code__isnull=False and order by created_at instead
+                transforms = ln.Transform.objects.filter(
+                    key=key, source_code__isnull=False
+                )
 
-        logger.important(f"{transform.type} is here: {target_relpath}")
+            if (n_transforms := len(transforms)) == 0:
+                err_msg = f"uid {uid}" if query_by_uid else f"key={key} and source_code"
+                raise SystemExit(f"Transform with {err_msg} does not exist.")
 
-        if with_env:
-            ln.settings.track_run_inputs = False
-            if (
-                transform.latest_run is not None
-                and transform.latest_run.environment is not None
-            ):
-                filepath_env_cache = transform.latest_run.environment.cache()
-                target_env_filename = (
-                    target_relpath.parent / f"{target_relpath.stem}__requirements.txt"
+            if n_transforms > 1:
+                transforms = transforms.order_by("-created_at")
+            transform = transforms.first()
+
+            target_relpath = Path(transform.key)
+            if len(target_relpath.parents) > 1:
+                logger.important(
+                    "preserve the folder structure for versioning:"
+                    f" {target_relpath.parent}/"
                 )
-                shutil.move(filepath_env_cache, target_env_filename)
-                logger.important(f"environment is here: {target_env_filename}")
+                target_relpath.parent.mkdir(parents=True, exist_ok=True)
+            if target_relpath.exists():
+                response = input(f"! {target_relpath} exists: replace? (y/n)")
+                if response != "y":
+                    raise SystemExit("Aborted.")
+
+            if transform.source_code is not None:
+                if target_relpath.suffix in (".ipynb", ".Rmd", ".qmd"):
+                    script_to_notebook(transform, target_relpath, bump_revision=True)
+                else:
+                    target_relpath.write_text(transform.source_code)
             else:
-                logger.warning("latest transform run with environment doesn't exist")
+                raise SystemExit("No source code available for this transform.")
+
+            logger.important(f"{transform.type} is here: {target_relpath}")
+
+            if with_env:
+                ln.settings.track_run_inputs = False
+                if (
+                    transform.latest_run is not None
+                    and transform.latest_run.environment is not None
+                ):
+                    filepath_env_cache = transform.latest_run.environment.cache()
+                    target_env_filename = (
+                        target_relpath.parent
+                        / f"{target_relpath.stem}__requirements.txt"
+                    )
+                    shutil.move(filepath_env_cache, target_env_filename)
+                    logger.important(f"environment is here: {target_env_filename}")
+                else:
+                    logger.warning(
+                        "latest transform run with environment doesn't exist"
+                    )
 
-        return target_relpath
-    elif entity == "artifact":
-        ln.settings.track_run_inputs = False
+            return target_relpath
+        case "artifact" | "collection":
+            ln.settings.track_run_inputs = False
+
+            EntityClass = ln.Artifact if entity == "artifact" else ln.Collection
 
-        if query_by_uid:
             # we don't use .get here because DoesNotExist is hard to catch
             # due to private django API
-            artifacts = ln.Artifact.filter(uid__startswith=uid)
-        else:
-            artifacts = ln.Artifact.filter(key=key)
+            if query_by_uid:
+                entities = EntityClass.filter(uid__startswith=uid)
+            else:
+                entities = EntityClass.filter(key=key)
 
-        if (n_artifacts := len(artifacts)) == 0:
-            err_msg = f"uid={uid}" if query_by_uid else f"key={key}"
-            raise SystemExit(f"Artifact with {err_msg} does not exist.")
+            if (n_entities := len(entities)) == 0:
+                err_msg = f"uid={uid}" if query_by_uid else f"key={key}"
+                raise SystemExit(
+                    f"{entity.capitalize()} with {err_msg} does not exist."
+                )
+
+            if n_entities > 1:
+                entities = entities.order_by("-created_at")
 
-        if n_artifacts > 1:
-            artifacts = artifacts.order_by("-created_at")
-        artifact = artifacts.first()
+            entity_obj = entities.first()
+            cache_path = entity_obj.cache()
 
-        cache_path = artifact.cache()
-        logger.important(f"artifact is here: {cache_path}")
-        return cache_path
+            # collection gives us a list of paths
+            if isinstance(cache_path, list):
+                logger.important(f"{entity} paths ({len(cache_path)} files):")
+                for i, path in enumerate(cache_path):
+                    if i < 5 or i >= len(cache_path) - 5:
+                        logger.important(f"  [{i + 1}/{len(cache_path)}] {path}")
+                    elif i == 5:
+                        logger.important(f"  ... {len(cache_path) - 10} more files ...")
+            else:
+                logger.important(f"{entity} is here: {cache_path}")
+        case _:
+            raise AssertionError(f"unknown entity {entity}")

lamin_cli/_migration.py

@@ -1,4 +1,5 @@
 from __future__ import annotations
+
 import os
 from typing import Optional
 
@@ -34,9 +35,9 @@ def deploy():
 @click.option("--end-number", type=str, default=None)
 @click.option("--start-number", type=str, default=None)
 def squash(
-    package_name: Optional[str],
-    end_number: Optional[str],
-    start_number: Optional[str],
+    package_name: str | None,
+    end_number: str | None,
+    start_number: str | None,
 ):
     """Squash migrations."""
     from lamindb_setup._migrate import migrate

lamin_cli/_save.py

@@ -1,8 +1,10 @@
 from __future__ import annotations
+
+import re
+import sys
 from pathlib import Path
-from typing import Union
+
 from lamin_utils import logger
-import re
 
 
 def parse_uid_from_code(content: str, suffix: str) -> str | None:
@@ -41,7 +43,7 @@ def parse_uid_from_code(content: str, suffix: str) -> str | None:
 
 
 def save_from_filepath_cli(
-    filepath: Union[str, Path],
+    filepath: str | Path,
     key: str | None,
     description: str | None,
     registry: str | None,
@@ -57,13 +59,16 @@ def save_from_filepath_cli(
     ln_setup.settings.auto_connect = True
 
     import lamindb as ln
+
+    if not ln.setup.core.django.IS_SETUP:
+        sys.exit(-1)
     from lamindb._finish import save_context_core
 
     ln_setup.settings.auto_connect = auto_connect_state
 
     suffixes_transform = {
-        "py": set([".py", ".ipynb"]),
-        "R": set([".R", ".qmd", ".Rmd"]),
+        "py": {".py", ".ipynb"},
+        "R": {".R", ".qmd", ".Rmd"},
     }
 
     if filepath.suffix in {".qmd", ".Rmd"}:
@@ -80,8 +85,8 @@ def save_from_filepath_cli(
             and filepath.with_suffix(".nb.html").exists()
         ):
             raise SystemExit(
-                f'Please delete one of\n - {filepath.with_suffix(".html")}\n -'
-                f' {filepath.with_suffix(".nb.html")}'
+                f"Please delete one of\n - {filepath.with_suffix('.html')}\n -"
+                f" {filepath.with_suffix('.nb.html')}"
             )
 
     if registry is None:

lamin_cli/_settings.py

@@ -1,4 +1,5 @@
 from __future__ import annotations
+
 import os
 
 if os.environ.get("NO_RICH"):

{lamin_cli-1.0.7.dist-info → lamin_cli-1.2.0.dist-info}/METADATA

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

lamin_cli-1.2.0.dist-info/RECORD

@@ -0,0 +1,12 @@
+lamin_cli/__init__.py,sha256=2kLtbQt2_3KEeiaePHI1brXcTblfz2N7yIGKsKcAtb4,40
+lamin_cli/__main__.py,sha256=a14UZj5xS66nZXdL_dUkU9M5AAWvs5unQ9lHJx1S5fI,10839
+lamin_cli/_cache.py,sha256=oplwE8AcS_9PYptQUZxff2qTIdNFS81clGPkJNWk098,800
+lamin_cli/_load.py,sha256=lMhV9AMkybjvj4VChJE_v7IMy6qGqisFlo40BJUibsA,8087
+lamin_cli/_migration.py,sha256=xQi6mwnpBzY5wcv1-TJhveD7a3XJIlpiYx6Z3AJ1NF0,1063
+lamin_cli/_save.py,sha256=bt873beNgog5naWITjPb61cjy00aeEtIv9lwqQttRGI,5908
+lamin_cli/_settings.py,sha256=O2tecCf5EIZu98ima4DTJujo4KuywckOLgw8c-Ke3dY,1142
+lamin_cli-1.2.0.dist-info/entry_points.txt,sha256=Qms85i9cZPlu-U7RnVZhFsF7vJ9gaLZUFkCjcGcXTpg,49
+lamin_cli-1.2.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+lamin_cli-1.2.0.dist-info/WHEEL,sha256=ssQ84EZ5gH1pCOujd3iW7HClo_O_aDaClUbX4B8bjKY,100
+lamin_cli-1.2.0.dist-info/METADATA,sha256=22dRlSUzNnNcaapFD-faPqMrNG5Fi9KZLjuHVe06hEc,337
+lamin_cli-1.2.0.dist-info/RECORD,,

lamin_cli-1.0.7.dist-info/RECORD

@@ -1,12 +0,0 @@
-lamin_cli/__init__.py,sha256=At34nwmlcGUb1vGmsRLVLk2f_sJhCINkEHKoIbl8lHc,40
-lamin_cli/__main__.py,sha256=nmGl8kj9iC1ohjy6JTJc00ZAAkzAWAHVLk5AMFrJDXU,10523
-lamin_cli/_cache.py,sha256=kW8rqlMwQeOngm9uq2gjzPVl3EBrwh6W2F2AvyBFABY,799
-lamin_cli/_load.py,sha256=fOA2lxEWp2l4oOwr_Y7XXDLqbIs9ivF6kBXU7I1eNww,6792
-lamin_cli/_migration.py,sha256=KH0aVRs72ej6ieyM49JaQw1SbT8z24H2heTFnWFcgy4,1071
-lamin_cli/_save.py,sha256=gig2BNgE0RfWXTVzv8Y1QJ5UA5fRS1xE5en6Dx0EwX8,5872
-lamin_cli/_settings.py,sha256=iS37mcQUHKRWxi2sHnAojEI6sWk3w232qwG-GeY2_Qc,1141
-lamin_cli-1.0.7.dist-info/entry_points.txt,sha256=Qms85i9cZPlu-U7RnVZhFsF7vJ9gaLZUFkCjcGcXTpg,49
-lamin_cli-1.0.7.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-lamin_cli-1.0.7.dist-info/WHEEL,sha256=ssQ84EZ5gH1pCOujd3iW7HClo_O_aDaClUbX4B8bjKY,100
-lamin_cli-1.0.7.dist-info/METADATA,sha256=h1HDG-taHw9WZ9fR-g2KcqioTwkKIPwxhm2JxclLOD0,337
-lamin_cli-1.0.7.dist-info/RECORD,,