lamin_cli 1.8.0__tar.gz → 1.8.2__tar.gz

{lamin_cli-1.8.0 → lamin_cli-1.8.2}/PKG-INFO

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

{lamin_cli-1.8.0 → lamin_cli-1.8.2}/lamin_cli/__init__.py

@@ -5,7 +5,7 @@ This is the command line interface for interacting with LaminDB & LaminHub.
 The interface is defined in `__main__.py`. The root API here is used by LaminR to replicate the CLI functionality.
 """
 
-__version__ = "1.8.0"
+__version__ = "1.8.2"
 
 from lamindb_setup import disconnect, logout
 from lamindb_setup._connect_instance import _connect_cli as connect

{lamin_cli-1.8.0 → lamin_cli-1.8.2}/lamin_cli/__main__.py

@@ -180,8 +180,9 @@ def init(
 # fmt: off
 @main.command()
 @click.argument("instance", type=str)
+@click.option("--use_proxy_db", is_flag=True, help="Use proxy database connection.")
 # fmt: on
-def connect(instance: str):
+def connect(instance: str, use_proxy_db: bool):
     """Configure default instance for connections.
 
     Python/R sessions and CLI commands will then auto-connect to the configured instance.
@@ -190,7 +191,7 @@ def connect(instance: str):
 
     See also: Connect in a Python session via {func}`~lamindb.connect`.
     """
-    return connect_(instance)
+    return connect_(instance, use_proxy_db=use_proxy_db)
 
 
 @main.command()
@@ -424,13 +425,15 @@ def save(path: str, key: str, description: str, stem_uid: str, project: str, spa
 
 
 @main.command()
+@click.argument("entity", type=str, default=None, required=False)
 @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.
+def annotate(entity: str | None, key: str, uid: str, project: str, features: tuple):
+    """Annotate an artifact or transform.
+
+    Entity is either 'artifact' or 'transform'. If not passed, chooses based on key suffix.
 
     You can annotate with projects and valid features & values. For example,
 
@@ -445,11 +448,17 @@ def annotate(key: str, uid: str, project: str, registry: str, features: tuple):
     from lamin_cli._annotate import _parse_features_list
     from lamin_cli._save import infer_registry_from_path
 
-    if registry is None:
+    # once we enable passing the URL as entity, then we don't need to throw this error
+    if not ln.setup.settings._instance_exists:
+        raise click.ClickException("Not connected to an instance. Please run: lamin connect account/name")
+
+    if entity is None:
         if key is not None:
             registry = infer_registry_from_path(key)
         else:
             registry = "artifact"
+    else:
+        registry = entity
     if registry == "artifact":
         model = ln.Artifact
     else:
@@ -459,7 +468,7 @@ def annotate(key: str, uid: str, project: str, registry: str, features: tuple):
     if key is not None:
         artifact = model.get(key=key)
     elif uid is not None:
-        artifact = model.get(uid=uid)
+        artifact = model.get(uid)  # do not use uid=uid, because then no truncated uids would work
     else:
         raise ln.errors.InvalidArgument("Either --key or --uid must be provided")
 

{lamin_cli-1.8.0 → lamin_cli-1.8.2}/lamin_cli/_save.py

@@ -104,12 +104,14 @@ def save(
             raise ln.errors.InvalidArgument(
                 f"Project '{project}' not found, either create it with `ln.Project(name='...').save()` or fix typos."
             )
+    space_record = None
     if space is not None:
         space_record = ln.Space.filter(ln.Q(name=space) | ln.Q(uid=space)).one_or_none()
         if space_record is None:
             raise ln.errors.InvalidArgument(
                 f"Space '{space}' not found, either create it on LaminHub or fix typos."
             )
+    branch_record = None
     if branch is not None:
         branch_record = ln.Branch.filter(
             ln.Q(name=branch) | ln.Q(uid=branch)
@@ -141,12 +143,14 @@ def save(
             logger.error("Please pass a key or description via --key or --description")
             return "missing-key-or-description"
 
-        artifact = ln.Artifact(path, key=key, description=description, revises=revises)
-        if space is not None:
-            artifact.space = space_record
-        if branch is not None:
-            artifact.branch = branch_record
-        artifact.save()
+        artifact = ln.Artifact(
+            path,
+            key=key,
+            description=description,
+            revises=revises,
+            branch=branch_record,
+            space=space_record,
+        ).save()
         logger.important(f"saved: {artifact}")
         logger.important(f"storage path: {artifact.path}")
         if artifact.storage.type == "s3":
@@ -156,7 +160,8 @@ def save(
             logger.important(f"labeled with project: {project_record.name}")
         if ln.setup.settings.instance.is_remote:
             slug = ln.setup.settings.instance.slug
-            logger.important(f"go to: https://lamin.ai/{slug}/artifact/{artifact.uid}")
+            ui_url = ln.setup.settings.instance.ui_url
+            logger.important(f"go to: {ui_url}/{slug}/artifact/{artifact.uid}")
         return None
 
     if registry == "transform":

{lamin_cli-1.8.0 → lamin_cli-1.8.2}/tests/core/test_save_annotate_files.py

@@ -45,7 +45,8 @@ def test_save_and_annotate_local_file():
     assert artifact.branch == branch
     assert project in artifact.projects.all()
 
-    # test passing the registry and saving the same file
+    # test passing the registry and saving the same file on the main branch
+    # it should recognize the file on the contrib1 branch
     result = subprocess.run(
         f"lamin save {filepath} --key mytest --registry artifact",
         shell=True,
@@ -53,7 +54,7 @@ def test_save_and_annotate_local_file():
     )
     print(result.stdout.decode())
     print(result.stderr.decode())
-    assert "returning existing artifact with same hash" in result.stdout.decode()
+    assert "returning artifact with same hash" in result.stdout.decode()
     assert "key='mytest'" in result.stdout.decode()
     assert "storage path:" in result.stdout.decode()
     assert result.returncode == 0
@@ -79,7 +80,7 @@ def test_save_and_annotate_local_file():
     )
     print(result.stdout.decode())
     print(result.stderr.decode())
-    assert "returning existing artifact with same hash" in result.stdout.decode()
+    assert "returning artifact with same hash" in result.stdout.decode()
     assert "key='mytest'" in result.stdout.decode()
     assert "storage path:" in result.stdout.decode()
     assert result.returncode == 0

{lamin_cli-1.8.0 → lamin_cli-1.8.2}/tests/core/test_save_notebooks.py

@@ -94,10 +94,8 @@ def test_save_consecutive_user_passes_uid():
         env=env,
     )
     assert result.returncode == 0
-    assert (
-        "loaded Transform('hlsFXswrJjtt0000'), started new Run"
-        in notebook_path.read_text()
-    )
+    assert "loaded Transform('hlsFXswrJjtt0000'" in notebook_path.read_text()
+    assert "started new Run" in notebook_path.read_text()
 
     # now let's simulate the interactive use case and use nbproject_test again
     # use the stem uid instead and it will bump the version
@@ -107,10 +105,8 @@ def test_save_consecutive_user_passes_uid():
     assert r"ln.track(\"hlsFXswrJjtt\")" in notebook_path.read_text()
 
     nbproject_test.execute_notebooks(notebook_path, print_outputs=True)
-    assert (
-        "created Transform('hlsFXswrJjtt0001'), started new"
-        in notebook_path.read_text()
-    )
+    assert "created Transform('hlsFXswrJjtt0001'" in notebook_path.read_text()
+    assert "started new Run" in notebook_path.read_text()
 
     # now, there is a transform record, but we're missing all artifacts because ln.finish() wasn't called
     transform = ln.Transform.filter(uid="hlsFXswrJjtt0001").one_or_none()