lamin_cli 1.5.5__py2.py3-none-any.whl → 1.6.1__py2.py3-none-any.whl

lamin_cli/__init__.py

@@ -1,3 +1,3 @@
 """Lamin CLI."""
 
-__version__ = "1.5.5"
+__version__ = "1.6.1"

lamin_cli/__main__.py

@@ -22,6 +22,34 @@ from lamindb_setup._init_instance import (
 if TYPE_CHECKING:
     from collections.abc import Mapping
 
+COMMAND_GROUPS = {
+    "lamin": [
+        {
+            "name": "Manage connections",
+            "commands": ["connect", "info", "init", "disconnect"],
+        },
+        {
+            "name": "Load, save, create & delete data",
+            "commands": ["load", "save", "create", "delete"],
+        },
+        {
+            "name": "Describe, annotate & list data",
+            "commands": ["describe", "annotate", "list"],
+        },
+        {
+            "name": "Configure",
+            "commands": ["checkout", "switch", "cache", "settings", "migrate"],
+        },
+        {
+            "name": "Auth",
+            "commands": [
+                "login",
+                "logout",
+            ],
+        },
+    ]
+}
+
 # https://github.com/ewels/rich-click/issues/19
 # Otherwise rich-click takes over the formatting.
 if os.environ.get("NO_RICH"):
@@ -47,30 +75,6 @@ if os.environ.get("NO_RICH"):
 else:
     import rich_click as click
 
-    COMMAND_GROUPS = {
-        "lamin": [
-            {
-                "name": "Connect to an instance",
-                "commands": ["connect", "disconnect", "info", "init", "run"],
-            },
-            {
-                "name": "Read & write data",
-                "commands": ["load", "save", "get", "delete", "create", "list"],
-            },
-            {
-                "name": "Configure",
-                "commands": ["checkout", "switch", "cache", "settings", "migrate"],
-            },
-            {
-                "name": "Auth",
-                "commands": [
-                    "login",
-                    "logout",
-                ],
-            },
-        ]
-    }
-
     def lamin_group_decorator(f):
         @click.rich_config(
             help_config=click.RichHelpConfiguration(
@@ -104,7 +108,7 @@ except PackageNotFoundError:
 @lamin_group_decorator
 @click.version_option(version=lamindb_version, prog_name="lamindb")
 def main():
-    """Configure LaminDB and perform simple actions."""
+    """Manage data with LaminDB instances."""
     silence_loggers()
 
 
@@ -190,13 +194,10 @@ 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`.
 
-    For manually connecting in a Python session, use {func}`~lamindb.connect`.
+    Alternatively, you can connect in a Python session via {func}`~lamindb.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, _write_settings=True)
+    from lamindb_setup._connect_instance import _connect_cli
+    return _connect_cli(instance)
 
 
 @main.command()
@@ -263,7 +264,10 @@ def list_(entity: Literal["branch"], name: str | None = None):
 def switch(branch: str | None = None, space: str | None = None):
     """Switch between branches or spaces.
 
-    Currently only supports creating a branch.
+    ```
+    lamin switch --branch my_branch
+    lamin switch --space our_space
+    ```
     """
     from lamindb.setup import switch as switch_
 
@@ -273,7 +277,7 @@ def switch(branch: str | None = None, space: str | None = None):
 @main.command()
 @click.option("--schema", is_flag=True, help="View database schema.")
 def info(schema: bool):
-    """Show info about current instance."""
+    """Show info about the environment, instance, branch, space, and user."""
     if schema:
         from lamindb_setup._schema import view
 
@@ -329,7 +333,7 @@ def delete(entity: str, name: str | None = None, uid: str | None = None, slug: s
     "--with-env", is_flag=True, help="Also return the environment for a tranform."
 )
 def load(entity: str, uid: str | None = None, key: str | None = None, with_env: bool = False):
-    """Load a file or folder.
+    """Load a file or folder into the cache or working directory.
 
     Pass a URL, `artifact`, or `transform`. For example:
 
@@ -344,30 +348,16 @@ def load(entity: str, uid: str | None = None, key: str | None = None, with_env:
     """
     is_slug = entity.count("/") == 1
     if is_slug:
-        from lamindb_setup import connect
-        from lamindb_setup import settings as settings_
-
-        # can decide whether we want to actually deprecate
-        # click.echo(
-        #     f"! please use: lamin connect {entity}"
-        # )
-        settings_.auto_connect = True
-        return connect(entity, _reload_lamindb=False, _write_settings=True)
+        from lamindb_setup._connect_instance import _connect_cli
+        # for backward compat and convenience, connect to the instance
+        return _connect_cli(entity)
     else:
         from lamin_cli._load import load as load_
 
         return load_(entity, uid=uid, key=key, with_env=with_env)
 
 
-@main.command()
-@click.argument("entity", type=str)
-@click.option("--uid", help="The uid for the entity.")
-@click.option("--key", help="The key for the entity.")
-def get(entity: str, uid: str | None = None, key: str | None = None):
-    """Query metadata about an entity.
-
-    Currently only works for artifact.
-    """
+def _describe(entity: str = "artifact", uid: str | None = None, key: str | None = None):
     import lamindb_setup as ln_setup
 
     from ._load import decompose_url
@@ -390,6 +380,34 @@ def get(entity: str, uid: str | None = None, key: str | None = None):
     artifact.describe()
 
 
+@main.command()
+@click.argument("entity", type=str, default="artifact")
+@click.option("--uid", help="The uid for the entity.")
+@click.option("--key", help="The key for the entity.")
+def describe(entity: str = "artifact", uid: str | None = None, key: str | None = None):
+    """Describe an artifact.
+
+    ```
+    lamin describe --key example_datasets/mini_immuno/dataset1.h5ad
+    lamin describe https://lamin.ai/laminlabs/lamin-site-assets/artifact/6sofuDVvTANB0f48
+    ```
+    """
+    _describe(entity=entity, uid=uid, key=key)
+
+
+@main.command()
+@click.argument("entity", type=str, default="artifact")
+@click.option("--uid", help="The uid for the entity.")
+@click.option("--key", help="The key for the entity.")
+def get(entity: str = "artifact", uid: str | None = None, key: str | None = None):
+    """Query metadata about an entity.
+
+    Currently still equivalent to `lamin describe`.
+    """
+    logger.warning("please use `lamin describe` instead of `lamin get` to describe")
+    _describe(entity=entity, uid=uid, key=key)
+
+
 @main.command()
 @click.argument("path", type=str)
 @click.option("--key", type=str, default=None, help="The key of the artifact or transform.")
@@ -421,6 +439,66 @@ def save(path: str, key: str, description: str, stem_uid: str, project: str, spa
         sys.exit(1)
 
 
+@main.command()
+@click.option("--key", type=str, default=None, help="The key of an artifact or transform.")
+@click.option("--uid", type=str, default=None, help="The uid of an artifact or transform.")
+@click.option("--project", type=str, default=None, help="A valid project name or uid.")
+@click.option("--features", multiple=True, help="Feature annotations. Supports: feature=value, feature=val1,val2, or feature=\"val1\",\"val2\"")
+@click.option("--registry", type=str, default=None, help="Either 'artifact' or 'transform'. If not passed, chooses based on key suffix.")
+def annotate(key: str, uid: str, project: str, registry: str, features: tuple):
+    """Annotate an artifact or a transform.
+
+    You can annotate with projects and valid features & values.
+
+    ```
+    lamin annotate --key raw/sample.fastq --project "My Project"
+    lamin annotate --key raw/sample.fastq --features perturbation=IFNG,DMSO cell_line=HEK297
+    lamin annotate --key my-notebook.ipynb --project "My Project"
+    ```
+    """
+    import lamindb as ln
+
+    from lamin_cli._annotate import _parse_features_list
+    from lamin_cli._save import infer_registry_from_path
+
+    if registry is None:
+        if key is not None:
+            registry = infer_registry_from_path(key)
+        else:
+            registry = "artifact"
+    if registry == "artifact":
+        model = ln.Artifact
+    else:
+        model = ln.Transform
+
+    # Get the artifact
+    if key is not None:
+        artifact = model.get(key=key)
+    elif uid is not None:
+        artifact = model.get(uid=uid)
+    else:
+        raise ln.errors.InvalidArgument("Either --key or --uid must be provided")
+
+    # Handle project annotation
+    if project is not None:
+        project_record = ln.Project.filter(
+            ln.Q(name=project) | ln.Q(uid=project)
+        ).one_or_none()
+        if project_record is None:
+            raise ln.errors.InvalidArgument(
+                f"Project '{project}' not found, either create it with `ln.Project(name='...').save()` or fix typos."
+            )
+        artifact.projects.add(project_record)
+
+    # Handle feature annotations
+    if features:
+        feature_dict = _parse_features_list(features)
+        artifact.features.add_values(feature_dict)
+
+    artifact_rep = artifact.key if artifact.key else artifact.description if artifact.description else artifact.uid
+    logger.important(f"annotated {registry}: {artifact_rep}")
+
+
 @main.command()
 @click.argument("filepath", type=str)
 @click.option("--project", type=str, default=None, help="A valid project name or uid. When running on Modal, creates an app with the same name.", required=True)

lamin_cli/_annotate.py

@@ -0,0 +1,47 @@
+def _parse_features_list(features_list: tuple) -> dict:
+    """Parse feature list into a dictionary.
+
+    Supports multiple formats:
+    - Quoted values: 'perturbation="DMSO","IFNG"' → {"perturbation": ["DMSO", "IFNG"]}
+    - Unquoted values: 'perturbation=IFNG,DMSO' → {"perturbation": ["IFNG", "DMSO"]}
+    - Single values: 'cell_line=HEK297' → {"cell_line": "HEK297"}
+    - Mixed: ('perturbation="DMSO","IFNG"', 'cell_line=HEK297', 'genes=TP53,BRCA1')
+    """
+    import re
+
+    import lamindb as ln
+
+    feature_dict = {}
+
+    for feature_assignment in features_list:
+        if "=" not in feature_assignment:
+            raise ln.errors.InvalidArgument(
+                f"Invalid feature assignment: '{feature_assignment}'. Expected format: 'feature=value' or 'feature=\"value1\",\"value2\"'"
+            )
+
+        feature_name, values_str = feature_assignment.split("=", 1)
+        feature_name = feature_name.strip()
+
+        # Parse quoted values using regex
+        # This will match quoted strings like "DMSO","IFNG" or single values like HEK297
+        quoted_values = re.findall(r'"([^"]*)"', values_str)
+
+        if quoted_values:
+            # If we found quoted values, use them
+            if len(quoted_values) == 1:
+                feature_dict[feature_name] = quoted_values[0]
+            else:
+                feature_dict[feature_name] = quoted_values
+        else:
+            # If no quoted values, treat as single unquoted value
+            # Remove any surrounding whitespace
+            value = values_str.strip()
+
+            # Handle comma-separated unquoted values
+            if "," in value:
+                values = [v.strip() for v in value.split(",")]
+                feature_dict[feature_name] = values
+            else:
+                feature_dict[feature_name] = value
+
+    return feature_dict

lamin_cli/_migration.py

@@ -23,11 +23,13 @@ def create():
 
 
 @migrate.command("deploy")
-def deploy():
+@click.option("--package-name", type=str, default=None)
+@click.option("--number", type=str, default=None)
+def deploy(package_name: str | None = None, number: str | None = None):
     """Deploy migrations."""
     from lamindb_setup._migrate import migrate
 
-    return migrate.deploy()
+    return migrate.deploy(package_name=package_name, number=number)
 
 
 @migrate.command("squash")

lamin_cli/_save.py

@@ -1,15 +1,29 @@
 from __future__ import annotations
 
+import os
 import re
 import sys
+from pathlib import Path
 from typing import TYPE_CHECKING
 
 import click
 from lamin_utils import logger
 from lamindb_setup.core.hashing import hash_file
 
-if TYPE_CHECKING:
-    from pathlib import Path
+
+def infer_registry_from_path(path: Path | str) -> str:
+    suffixes_transform = {
+        "py": {".py", ".ipynb"},
+        "R": {".R", ".qmd", ".Rmd"},
+    }
+    if isinstance(path, str):
+        path = Path(path)
+    registry = (
+        "transform"
+        if path.suffix in suffixes_transform["py"].union(suffixes_transform["R"])
+        else "artifact"
+    )
+    return registry
 
 
 def parse_uid_from_code(content: str, suffix: str) -> str | None:
@@ -82,15 +96,7 @@ def save_from_path_cli(
         raise click.BadParameter(f"Path {path} does not exist", param_hint="path")
 
     if registry is None:
-        suffixes_transform = {
-            "py": {".py", ".ipynb"},
-            "R": {".R", ".qmd", ".Rmd"},
-        }
-        registry = (
-            "transform"
-            if path.suffix in suffixes_transform["py"].union(suffixes_transform["R"])
-            else "artifact"
-        )
+        registry = infer_registry_from_path(path)
 
     if project is not None:
         project_record = ln.Project.filter(
@@ -256,11 +262,14 @@ def save_from_path_cli(
         # latest run of this transform by user
         run = ln.Run.filter(transform=transform).order_by("-started_at").first()
         if run is not None and run.created_by.id != ln_setup.settings.user.id:
-            response = input(
-                "You are trying to save a transform created by another user: Source"
-                " and report files will be tagged with *your* user id. Proceed?"
-                " (y/n)"
-            )
+            if os.environ.get("LAMIN_TESTING") == "true":
+                response = "y"
+            else:
+                response = input(
+                    "You are trying to save a transform created by another user: Source"
+                    " and report files will be tagged with *your* user id. Proceed?"
+                    " (y/n)"
+                )
             if response != "y":
                 return "aborted-save-notebook-created-by-different-user"
         if run is None and transform.key.endswith(".ipynb"):

lamin_cli/_settings.py

@@ -40,3 +40,23 @@ def set(setting: str, value: bool):
         settings_.auto_connect = value
     if setting == "private-django-api":
         settings_.private_django_api = value
+
+
+@settings.command("get")
+@click.argument(
+    "setting",
+    type=click.Choice(
+        ["auto-connect", "private-django-api", "space", "branch"], case_sensitive=False
+    ),
+)
+def get(setting: str):
+    """Get a setting."""
+    from lamindb_setup import settings as settings_
+
+    if setting == "branch":
+        _, value = settings_._read_branch_idlike_name()
+    elif setting == "space":
+        _, value = settings_._read_space_idlike_name()
+    else:
+        value = getattr(settings_, setting.replace("-", "_"))
+    click.echo(value)

{lamin_cli-1.5.5.dist-info → lamin_cli-1.6.1.dist-info}/METADATA

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

lamin_cli-1.6.1.dist-info/RECORD

@@ -0,0 +1,15 @@
+lamin_cli/__init__.py,sha256=RUL0qRXG8XBSPIPZY1AIyya7w5c1AW0rkTuhF3tIyjc,40
+lamin_cli/__main__.py,sha256=CeFFK696hYVY19dNHbUeZ8-OVByVFsNiVybkDnD_Ras,18936
+lamin_cli/_annotate.py,sha256=ZD76__K-mQt7UpYqyM1I2lKCs-DraTmnkjsByIHmD-g,1839
+lamin_cli/_cache.py,sha256=oplwE8AcS_9PYptQUZxff2qTIdNFS81clGPkJNWk098,800
+lamin_cli/_load.py,sha256=QqiFxGYmvFz2RjhvwKO5r1fmPWMZ5Ai4y1pJytdYKak,8301
+lamin_cli/_migration.py,sha256=XUl_L9_3pTTk5jJoBiqbzf0Bd2LdKKtHa1zPZ4Rla5c,1267
+lamin_cli/_save.py,sha256=fC_tD65x3wufXjPyN36Xhl5gSuBj8FsD3G1JRNHmJrw,11021
+lamin_cli/_settings.py,sha256=xG5e_zWk9N8glcodeyE0Kap79tl6T7yp4MWW1pBLOmk,1684
+lamin_cli/compute/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+lamin_cli/compute/modal.py,sha256=QnR7GyyvWWWkLnou95HxS9xxSQfw1k-SiefM_qRVnU0,6010
+lamin_cli-1.6.1.dist-info/entry_points.txt,sha256=Qms85i9cZPlu-U7RnVZhFsF7vJ9gaLZUFkCjcGcXTpg,49
+lamin_cli-1.6.1.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+lamin_cli-1.6.1.dist-info/WHEEL,sha256=ssQ84EZ5gH1pCOujd3iW7HClo_O_aDaClUbX4B8bjKY,100
+lamin_cli-1.6.1.dist-info/METADATA,sha256=qNkmoblvQu45v9GYL5bwqT5LuThScCy3poesxi3AWFU,337
+lamin_cli-1.6.1.dist-info/RECORD,,

lamin_cli-1.5.5.dist-info/RECORD

@@ -1,14 +0,0 @@
-lamin_cli/__init__.py,sha256=TjqhH_7HYqV7eEmqmrHxIzQ-nXehrr75pFeHCnGQCxY,40
-lamin_cli/__main__.py,sha256=BO_vUmKhOF3WHBXze70rmHt-obCsgRhNYtT_-rGuH4Y,15886
-lamin_cli/_cache.py,sha256=oplwE8AcS_9PYptQUZxff2qTIdNFS81clGPkJNWk098,800
-lamin_cli/_load.py,sha256=QqiFxGYmvFz2RjhvwKO5r1fmPWMZ5Ai4y1pJytdYKak,8301
-lamin_cli/_migration.py,sha256=xQi6mwnpBzY5wcv1-TJhveD7a3XJIlpiYx6Z3AJ1NF0,1063
-lamin_cli/_save.py,sha256=AdghV9arOEANqkT-5hrhBEanoVrOlQKhejlzPJLoUes,10760
-lamin_cli/_settings.py,sha256=O2tecCf5EIZu98ima4DTJujo4KuywckOLgw8c-Ke3dY,1142
-lamin_cli/compute/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-lamin_cli/compute/modal.py,sha256=QnR7GyyvWWWkLnou95HxS9xxSQfw1k-SiefM_qRVnU0,6010
-lamin_cli-1.5.5.dist-info/entry_points.txt,sha256=Qms85i9cZPlu-U7RnVZhFsF7vJ9gaLZUFkCjcGcXTpg,49
-lamin_cli-1.5.5.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-lamin_cli-1.5.5.dist-info/WHEEL,sha256=ssQ84EZ5gH1pCOujd3iW7HClo_O_aDaClUbX4B8bjKY,100
-lamin_cli-1.5.5.dist-info/METADATA,sha256=3CxozXOIRc1FFUzD1letgB9-nXa92fbLN5qmnpEg0n4,337
-lamin_cli-1.5.5.dist-info/RECORD,,