lamin_cli 0.14.0__py2.py3-none-any.whl → 0.15.0__py2.py3-none-any.whl

lamin_cli/__init__.py

@@ -1,3 +1,3 @@
 """Lamin CLI."""
 
-__version__ = "0.14.0"
+__version__ = "0.15.0"

lamin_cli/__main__.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 import os
 import sys
+import inspect
 from importlib.metadata import PackageNotFoundError, version
 from typing import Optional
 
@@ -32,7 +33,7 @@ def main():
 
 @main.command()
 def info():
-    """Show user & instance info."""
+    """Show user, settings & instance info."""
     import lamindb_setup
 
     print(lamindb_setup.settings)
@@ -57,7 +58,10 @@ def init(storage: str, db: Optional[str], schema: Optional[str], name: Optional[
 @click.option("--key", type=str, default=None, help="API key")
 @click.option("--password", type=str, default=None, help="legacy password")
 def login(user: str, key: Optional[str], password: Optional[str]):
-    """Login using an email or user handle."""
+    """Login using a user email address or handle.
+
+    Examples: `lamin login marge` or `lamin login marge@acme.com`
+    """
     from lamindb_setup._setup_user import login
 
     return login(user, key=key, password=password)
@@ -78,12 +82,10 @@ def logout():
 @click.option("--storage", type=str, default=None, help="Update storage while loading.")
 # fmt: on
 def load(identifier: str, db: Optional[str], storage: Optional[str]):
-    """Auto-connect to a lamindb instance.
-
-    Identifier can be slug (account_handle/instance_name) or url
-    (https://lamin.ai/account_handle/instance_name).
+    """Load an instance for auto-connection.
 
-    If the owner is the current user the instance_name suffices.
+    `IDENTIFIER` is either a slug (`account/instance`) or a `URL`
+    (`https://lamin.ai/account/instance`).
     """
     from lamindb_setup import settings, connect
 
@@ -97,26 +99,38 @@ def load(identifier: str, db: Optional[str], storage: Optional[str]):
 @click.option("--force", is_flag=True, default=False, help="Do not ask for confirmation.")  # noqa: E501
 # fmt: on
 def delete(instance: str, force: bool = False):
-    """Delete instance."""
+    """Delete an instance."""
     from lamindb_setup._delete import delete
 
     return delete(instance, force=force)
 
 
 @main.command(name="set")
-@click.argument("setting", type=click.Choice(["auto-connect"], case_sensitive=False))
+@click.argument(
+    "setting",
+    type=click.Choice(["auto-connect", "private-django-api"], case_sensitive=False),
+)
 @click.argument("value", type=click.BOOL)
 def set_(setting: str, value: bool):
-    """Update settings."""
+    """Update settings.
+
+    - `auto-connect` → {attr}`~lamindb.setup.core.SetupSettings.auto_connect`
+    - `private-django-api` → {attr}`~lamindb.setup.core.SetupSettings.private_django_api`
+    """
     from lamindb_setup import settings
 
     if setting == "auto-connect":
         settings.auto_connect = value
+    if setting == "private-django-api":
+        settings.private_django_api = value
 
 
 @main.command()
 def close():
-    """Close existing instance."""
+    """Close an existing instance.
+
+    Is the opposite of loading an instance.
+    """
     from lamindb_setup._close import close as close_
 
     return close_()
@@ -168,8 +182,9 @@ main.add_command(migrate)
 
 
 # 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():
-    out: dict[str, str] = {}
+    out: dict[str, dict[str, str | None]] = {}
 
     def recursive_help(
         cmd: Command, parent: Optional[Context] = None, name: tuple[str, ...] = ()
@@ -177,7 +192,16 @@ def _generate_help():
         ctx = click.Context(cmd, info_name=cmd.name, parent=parent)
         assert cmd.name
         name = (*name, cmd.name)
-        out[" ".join(name)] = cmd.get_help(ctx)
+        command_name = " ".join(name)
+
+        docstring = inspect.getdoc(cmd.callback)
+        usage = cmd.get_help(ctx).split("\n")[0]
+        options = cmd.get_help(ctx).split("Options:")[1]
+        out[command_name] = {
+            "help": usage + "\n\nOptions:" + options,
+            "docstring": docstring,
+        }
+
         for sub in getattr(cmd, "commands", {}).values():
             recursive_help(sub, ctx, name=name)
 

{lamin_cli-0.14.0.dist-info → lamin_cli-0.15.0.dist-info}/METADATA

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

lamin_cli-0.15.0.dist-info/RECORD

@@ -0,0 +1,10 @@
+lamin_cli/__init__.py,sha256=rCah4PWSwkQ8EKMAnlmgxM63T5nRmMKn3IY2w7jL7_Y,41
+lamin_cli/__main__.py,sha256=uRqKMavTidci8Ld-Xbd1PyiRWPulNvNxJAWxy-8rFvU,6150
+lamin_cli/_cache.py,sha256=WMDUkJyATVdN8pMqgqw1DZLVym-CaBjCHEoRimI69LQ,813
+lamin_cli/_get.py,sha256=6a4KzHWlCgL_LW2XFCbOmH9julzTkSuUcsTKTHczqTA,1586
+lamin_cli/_migration.py,sha256=dULOvbpJ4VBiXuxPAM8jFGnBkh7pQGqE5eP-UC6uxWc,1055
+lamin_cli/_save.py,sha256=6mu6sAVcXsq4-XW-tzcVxUVh-Gv7e9EFkTyMmdrCGNw,4291
+lamin_cli-0.15.0.dist-info/entry_points.txt,sha256=Qms85i9cZPlu-U7RnVZhFsF7vJ9gaLZUFkCjcGcXTpg,49
+lamin_cli-0.15.0.dist-info/WHEEL,sha256=Sgu64hAMa6g5FdzHxXv9Xdse9yxpGGMeagVtPMWpJQY,99
+lamin_cli-0.15.0.dist-info/METADATA,sha256=lEDqqkixCPI_KMn2kwMgDv_kGKaqXsCgljSvAhOcKns,336
+lamin_cli-0.15.0.dist-info/RECORD,,

lamin_cli-0.14.0.dist-info/RECORD

@@ -1,10 +0,0 @@
-lamin_cli/__init__.py,sha256=AWDIw2GP7pFnmHRm-ClnRl2PYc9j3sJfzYTQ9DLndHY,41
-lamin_cli/__main__.py,sha256=6HsLIqCQzsqG7UKTx3_5IlTYG9pkDpMjeeKLtA8Z57g,5411
-lamin_cli/_cache.py,sha256=WMDUkJyATVdN8pMqgqw1DZLVym-CaBjCHEoRimI69LQ,813
-lamin_cli/_get.py,sha256=6a4KzHWlCgL_LW2XFCbOmH9julzTkSuUcsTKTHczqTA,1586
-lamin_cli/_migration.py,sha256=dULOvbpJ4VBiXuxPAM8jFGnBkh7pQGqE5eP-UC6uxWc,1055
-lamin_cli/_save.py,sha256=6mu6sAVcXsq4-XW-tzcVxUVh-Gv7e9EFkTyMmdrCGNw,4291
-lamin_cli-0.14.0.dist-info/entry_points.txt,sha256=Qms85i9cZPlu-U7RnVZhFsF7vJ9gaLZUFkCjcGcXTpg,49
-lamin_cli-0.14.0.dist-info/WHEEL,sha256=Sgu64hAMa6g5FdzHxXv9Xdse9yxpGGMeagVtPMWpJQY,99
-lamin_cli-0.14.0.dist-info/METADATA,sha256=4kklJ3bV8Kq3d5C7xlYOXMFAh7vnkj8Y3lJ9gFD-Pb4,336
-lamin_cli-0.14.0.dist-info/RECORD,,