lamin_cli 1.5.0__tar.gz → 1.5.2__tar.gz

{lamin_cli-1.5.0 → lamin_cli-1.5.2}/PKG-INFO

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

lamin_cli-1.5.2/lamin_cli/__init__.py

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

{lamin_cli-1.5.0 → lamin_cli-1.5.2}/lamin_cli/__main__.py

@@ -9,8 +9,9 @@ from collections import OrderedDict
 from functools import wraps
 from importlib.metadata import PackageNotFoundError, version
 from pathlib import Path
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Literal
 
+from lamin_utils import logger
 from lamindb_setup._init_instance import (
     DOC_DB,
     DOC_INSTANCE_NAME,
@@ -54,11 +55,11 @@ else:
             },
             {
                 "name": "Read & write data",
-                "commands": ["load", "save", "get", "delete"],
+                "commands": ["load", "save", "get", "delete", "create", "list"],
             },
             {
                 "name": "Configure",
-                "commands": ["cache", "settings", "migrate"],
+                "commands": ["checkout", "switch", "cache", "settings", "migrate"],
             },
             {
                 "name": "Auth",
@@ -209,6 +210,66 @@ def disconnect():
     return close_()
 
 
+# fmt: off
+@main.command()
+@click.argument("entity", type=str)
+@click.option("--name", type=str, default=None, help="A name.")
+# fmt: on
+def create(entity: Literal["branch"], name: str | None = None):
+    """Create a record for an entity.
+
+    Currently only supports creating a branch.
+
+    ```
+    lamin create branch --name my_branch
+    ```
+    """
+    assert entity == "branch", "Currently only supports creating a branch."
+
+    from lamindb.models import Branch
+
+    branch = Branch(name=name).save()
+    logger.important(f"created branch: {branch.name}")
+
+
+# fmt: off
+@main.command(name="list")
+@click.argument("entity", type=str)
+@click.option("--name", type=str, default=None, help="A name.")
+# fmt: on
+def list_(entity: Literal["branch"], name: str | None = None):
+    """List records for an entity.
+
+    ```
+    lamin list branch
+    lamin list space
+    ```
+    """
+    assert entity in {"branch", "space"}, "Currently only supports listing branches and spaces."
+
+    from lamindb.models import Branch, Space
+
+    if entity == "branch":
+        print(Branch.df())
+    else:
+        print(Space.df())
+
+
+# fmt: off
+@main.command()
+@click.option("--branch", type=str, default=None, help="A valid branch name or uid.")
+@click.option("--space", type=str, default=None, help="A valid branch name or uid.")
+# fmt: on
+def switch(branch: str | None = None, space: str | None = None):
+    """Switch between branches or spaces.
+
+    Currently only supports creating a branch.
+    """
+    from lamindb.setup import switch as switch_
+
+    switch_(branch=branch, space=space)
+
+
 @main.command()
 @click.option("--schema", is_flag=True, help="View database schema.")
 def info(schema: bool):
@@ -226,17 +287,30 @@ 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.")
+@click.argument("entity", type=str)
+@click.option("--name", type=str, default=None)
+@click.option("--slug", type=str, default=None)
+@click.option("--force", is_flag=True, default=False, help="Do not ask for confirmation (only relevant for instance).")
 # fmt: on
-def delete(instance: str, force: bool = False):
+def delete(entity: str, name: str | None = None, slug: str | None = None, force: bool = False):
     """Delete an entity.
 
-    Currently only supports instance deletion.
+    Currently supported: `branch` and `instance`.
+
+    ```
+    lamin delete instance --slug account/name
+    lamin delete branch --name my_branch
+    ```
     """
+    from lamindb import Branch
     from lamindb_setup._delete import delete
 
-    return delete(instance, force=force)
+    if entity == "branch":
+        Branch.get(name=name).delete()
+    elif entity == "instance":
+        return delete(slug, force=force)
+    else:  # backwars compatibility
+        return delete(entity, force=force)
 
 
 @main.command()

{lamin_cli-1.5.0 → lamin_cli-1.5.2}/lamin_cli/_load.py

@@ -163,10 +163,11 @@ def load(
 
             # we don't use .get here because DoesNotExist is hard to catch
             # due to private django API
+            # we use `.objects` here because we don't want to exclude kind = __lamindb_run__ artifacts
             if query_by_uid:
-                entities = EntityClass.filter(uid__startswith=uid)
+                entities = EntityClass.objects.filter(uid__startswith=uid)
             else:
-                entities = EntityClass.filter(key=key)
+                entities = EntityClass.objects.filter(key=key)
 
             if (n_entities := len(entities)) == 0:
                 err_msg = f"uid={uid}" if query_by_uid else f"key={key}"

lamin_cli-1.5.2/tests/core/test_create_switch_delete_list.py

@@ -0,0 +1,29 @@
+import os
+
+import lamindb as ln
+import lamindb_setup as ln_setup
+
+
+def test_branch():
+    exit_status = os.system("lamin switch --branch archive")
+    assert exit_status == 0
+    assert ln_setup.settings.branch.uid == 12 * "a"
+    exit_status = os.system("lamin switch --branch main")
+    assert exit_status == 0
+    assert ln_setup.settings.branch.uid == 12 * "m"
+    exit_status = os.system("lamin create branch --name testbranch")
+    exit_status = os.system("lamin switch --branch testbranch")
+    assert exit_status == 0
+    exit_status = os.system("lamin list branch")
+    assert exit_status == 0
+    exit_status = os.system("lamin delete branch --name testbranch")
+    assert exit_status == 0
+    exit_status = os.system("lamin switch --branch main")
+
+
+def test_space():
+    exit_status = os.system("lamin switch --space non_existent")
+    assert exit_status == 256
+    exit_status = os.system("lamin switch --space all")
+    assert exit_status == 0
+    assert ln_setup.settings.space.uid == 12 * "a"

{lamin_cli-1.5.0 → lamin_cli-1.5.2}/tests/core/test_save_scripts.py

@@ -51,8 +51,8 @@ def test_run_save_cache_with_git_and_uid():
         shell=True,
         capture_output=True,
     )
-    print(result.stdout.decode())
-    print(result.stderr.decode())
+    # print(result.stdout.decode())
+    # print(result.stderr.decode())
     assert result.returncode == 0
     assert "loaded Transform" in result.stdout.decode()
     assert "m5uCHTTp" in result.stdout.decode()
@@ -172,7 +172,7 @@ if __name__ == "__main__":
         capture_output=True,
         env=env,
     )
-    # re-run the script through the second user
+    # re-run the script through a second user
     result = subprocess.run(
         f"python {filepath}",
         shell=True,
@@ -181,8 +181,7 @@ if __name__ == "__main__":
     )
     # print(result.stdout.decode())
     # print(result.stderr.decode())
-    assert result.returncode == 1
-    assert "already works on this draft" in result.stderr.decode()
+    assert result.returncode == 0
 
     # try to get the source code via command line
     result = subprocess.run(

lamin_cli-1.5.0/lamin_cli/__init__.py

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