lamin_cli 0.17.2__tar.gz → 0.17.3__tar.gz

{lamin_cli-0.17.2 → lamin_cli-0.17.3}/PKG-INFO

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

lamin_cli-0.17.3/lamin_cli/__init__.py

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

{lamin_cli-0.17.2 → lamin_cli-0.17.3}/lamin_cli/__main__.py

@@ -41,9 +41,7 @@ else:
                     "init",
                     "load",
                     "info",
-                    "close",
                     "delete",
-                    "logout",
                 ],
             },
             {
@@ -55,8 +53,8 @@ else:
                 "commands": ["cache", "set"],
             },
             {
-                "name": "Schema commands",
-                "commands": ["migrate", "schema"],
+                "name": "Schema migration",
+                "commands": ["migrate"],
             },
         ]
     }
@@ -98,7 +96,8 @@ def main():
 @main.command()
 @click.argument("user", type=str, default=None, required=False)
 @click.option("--key", type=str, default=None, help="The API key.")
-def login(user: str, key: Optional[str]):
+@click.option("--logout", is_flag=True, help="Logout instead of logging in.")
+def login(user: str, key: Optional[str], logout: bool = False):
     """Log into LaminHub.
 
     Upon logging in the first time, you need to pass your API key via:
@@ -119,17 +118,22 @@ def login(user: str, key: Optional[str]):
 
     You will be prompted for your Beta API key unless you set an environment variable `LAMIN_API_KEY`.
     """
-    from lamindb_setup._setup_user import login
+    if logout:
+        from lamindb_setup._setup_user import logout as logout_func
 
-    if user is None:
-        if "LAMIN_API_KEY" in os.environ:
-            api_key = os.environ["LAMIN_API_KEY"]
-        else:
-            api_key = input("Your API key: ")
+        return logout_func()
     else:
-        api_key = None
+        from lamindb_setup._setup_user import login
+
+        if user is None:
+            if "LAMIN_API_KEY" in os.environ:
+                api_key = os.environ["LAMIN_API_KEY"]
+            else:
+                api_key = input("Your API key: ")
+        else:
+            api_key = None
 
-    return login(user, key=key, api_key=api_key)
+        return login(user, key=key, api_key=api_key)
 
 
 # fmt: off
@@ -148,39 +152,45 @@ def init(storage: str, db: Optional[str], schema: Optional[str], name: Optional[
 
 # fmt: off
 @main.command()
-@click.argument("identifier", type=str, default=None)
+@click.argument("instance", type=str, default=None)
 @click.option("--db", type=str, default=None, help="Update database URL.")  # noqa: E501
 @click.option("--storage", type=str, default=None, help="Update storage while loading.")
+@click.option("--unload", is_flag=True, help="Unload the current instance.")
 # fmt: on
-def load(identifier: str, db: Optional[str], storage: Optional[str]):
+def load(
+    instance: Optional[str], db: Optional[str], storage: Optional[str], unload: bool
+):
     """Load an instance for auto-connection.
 
-    `IDENTIFIER` is either a slug (`account/instance`) or a `URL`
-    (`https://lamin.ai/account/instance`).
+    Pass a slug (`account/name`) or URL
+    (`https://lamin.ai/account/name`).
     """
-    from lamindb_setup import settings, connect
-
-    settings.auto_connect = True
-    return connect(slug=identifier, db=db, storage=storage)
-
+    if unload:
+        from lamindb_setup._close import close as close_
 
-@main.command()
-def info():
-    """Show user, settings & instance info."""
-    import lamindb_setup
+        return close_()
+    else:
+        if instance is None:
+            raise click.UsageError("INSTANCE is required when loading an instance.")
+        from lamindb_setup import settings, connect
 
-    print(lamindb_setup.settings)
+        settings.auto_connect = True
+        return connect(slug=instance, db=db, storage=storage)
 
 
 @main.command()
-def close():
-    """Close an existing instance.
+@click.option("--schema", is_flag=True, help="View schema.")
+def info(schema: bool):
+    """Show info about current instance."""
+    if schema:
+        from lamindb_setup._schema import view
 
-    Is the opposite of loading an instance.
-    """
-    from lamindb_setup._close import close as close_
+        print("Open in browser: http://127.0.0.1:8000/schema/")
+        return view()
+    else:
+        import lamindb_setup
 
-    return close_()
+        print(lamindb_setup.settings)
 
 
 # fmt: off
@@ -195,22 +205,17 @@ def delete(instance: str, force: bool = False):
     return delete(instance, force=force)
 
 
-@main.command()
-def logout():
-    """Logout."""
-    from lamindb_setup._setup_user import logout
-
-    return logout()
-
-
 @main.command()
 @click.argument("entity", type=str)
-@click.option("--uid", help="Filter by creator")
-@click.option("--key", help="The key for the entity")
-def get(entity: str, uid: str = None, key: str = None):
+@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):
     """Query an entity.
 
-    Pass a lamin.ai URL, 'artifact', or 'transform', for example:
+    Pass a URL, `artifact`, or `transform`. For example:
 
     ```
     lamin get https://lamin.ai/account/instance/artifact/e2G7k9EVul4JbfsEYAy5
@@ -218,11 +223,12 @@ def get(entity: str, uid: str = None, key: str = None):
     lamin get artifact --uid e2G7k9EVul4JbfsEYAy5
     lamin get transform --key analysis.ipynb
     lamin get transform --uid Vul4JbfsEYAy5
+    lamin get transform --uid Vul4JbfsEYAy5 --with-env
     ```
     """
     from lamin_cli._get import get
 
-    return get(entity, uid, key)
+    return get(entity, uid=uid, key=key, with_env=with_env)
 
 
 @main.command()
@@ -265,16 +271,6 @@ def set_(setting: str, value: bool):
 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.17.2 → lamin_cli-0.17.3}/lamin_cli/_get.py

@@ -15,7 +15,7 @@ def decompose_url(url: str) -> Tuple[str, str, str]:
     return instance_slug, entity, uid
 
 
-def get(entity: str, uid: str = None, key: str = None):
+def get(entity: str, uid: str = None, key: str = None, with_env: bool = False):
     if entity.startswith("https://lamin.ai"):
         url = entity
         instance_slug, entity, uid = decompose_url(url)
@@ -41,6 +41,9 @@ def get(entity: str, uid: str = None, key: str = None):
         import lamindb as ln
         from lamindb._finish import script_to_notebook
 
+    # below is to silence warnings about missing run inputs
+    ln.settings.track_run_inputs = False
+
     if entity == "transform":
         transform = (
             ln.Transform.get(uid) if uid is not None else ln.Transform.get(key=key)
@@ -60,6 +63,19 @@ def get(entity: str, uid: str = None, key: str = None):
         else:
             raise ValueError("No source code available for this transform.")
         logger.important(target_filename)
+        if with_env:
+            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 = (
+                    ".".join(target_filename.split(".")[:-1]) + "__requirements.txt"
+                )
+                filepath_env_cache.rename(target_env_filename)
+                logger.important(target_env_filename)
+            else:
+                logger.warning("latest transform run with environment doesn't exist")
     elif entity == "artifact":
         artifact = ln.Artifact.get(uid) if uid is not None else ln.Artifact.get(key=key)
         cache_path = artifact.cache()

{lamin_cli-0.17.2 → lamin_cli-0.17.3}/tests/test_cli.py

@@ -1,5 +1,6 @@
 import os
 from datetime import datetime, timedelta, timezone
+from lamindb_setup import settings
 from lamindb_setup.core._hub_client import connect_hub_with_auth
 from lamindb_setup.core._hub_core import create_api_key
 
@@ -13,13 +14,20 @@ def test_cli_login():
     exit_status = os.system("lamin login testuser1")
     assert exit_status == 0
 
-    exit_status = os.system(
-        "lamin login testuser1 --key cEvcwMJFX4OwbsYVaMt2Os6GxxGgDUlBGILs2RyS"
-    )
+    assert settings.user.handle == "testuser1"
+    password = settings.user.password
+    assert password is not None
+
+    exit_status = os.system(f"lamin login testuser1 --key {password}")
     assert exit_status == 0
 
 
 def test_cli_login_api_key():
+    settings._user_settings = None  # this is to refresh a settings instance
+    assert settings.user.handle == "testuser1"
+    password = settings.user.password
+    assert password is not None
+
     expires_at = datetime.now(tz=timezone.utc) + timedelta(days=1)
     api_key = create_api_key(
         {
@@ -35,8 +43,18 @@ def test_cli_login_api_key():
     exit_status = os.system("lamin login")
     assert exit_status == 0
 
+    settings._user_settings = None
+    assert settings.user.handle == "testuser1"
+    assert settings.user.api_key == api_key
+
     hub = connect_hub_with_auth()
     hub.table("api_key").delete().eq("description", "test_cli_login_api_key").execute()
     hub.auth.sign_out({"scope": "local"})
 
-    os.system("lamin login testuser1@lamin.ai")
+    exit_status = os.system(f"lamin login testuser1@lamin.ai --key {password}")
+    assert exit_status == 0
+
+    settings._user_settings = None
+    assert settings.user.handle == "testuser1"
+    assert settings.user.api_key is None
+    assert settings.user.password == password

{lamin_cli-0.17.2 → lamin_cli-0.17.3}/tests/test_get.py

@@ -14,7 +14,8 @@ def test_decompose_url():
 def test_get_transform():
     result = subprocess.run(
         "lamin get"
-        " 'https://lamin.ai/laminlabs/arrayloader-benchmarks/transform/1GCKs8zLtkc85zKv'",  # noqa
+        " 'https://lamin.ai/laminlabs/arrayloader-benchmarks/transform/1GCKs8zLtkc85zKv'"
+        " --with-env",  # noqa
         shell=True,
         capture_output=True,
     )

lamin_cli-0.17.2/lamin_cli/__init__.py

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