lamin_cli 0.14.0__tar.gz → 0.15.0__tar.gz

lamin_cli-0.15.0/.github/workflows/doc-changes.yml

@@ -0,0 +1,23 @@
+name: doc-changes
+
+on:
+  pull_request_target:
+    branches:
+      - main
+    types:
+      - closed
+
+jobs:
+  latest-changes:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+      - run: pip install "laminci[doc-changes]@git+https://x-access-token:${{ secrets.LAMIN_BUILD_DOCS }}@github.com/laminlabs/laminci"
+      - run: laminci doc-changes
+        env:
+          repo_token: ${{ secrets.GITHUB_TOKEN }}
+          docs_token: ${{ secrets.LAMIN_BUILD_DOCS }}
+          changelog_file: lamin-docs/docs/changelog/soon/lamindb.md

{lamin_cli-0.14.0 → lamin_cli-0.15.0}/.pre-commit-config.yaml

@@ -23,7 +23,7 @@ repos:
           - flake8-typing-imports==1.10.0
         language_version: python3
         args:
-          - --max-line-length=88
+          - --max-line-length=120
           - --ignore=E203,W503,BLK100,TYP001
         exclude: |
           (?x)(

{lamin_cli-0.14.0 → lamin_cli-0.15.0}/PKG-INFO

@@ -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/lamin_cli/__init__.py

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

{lamin_cli-0.14.0 → lamin_cli-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 → lamin_cli-0.15.0}/tests/scripts/run-track-and-finish-sync-git.py

@@ -3,6 +3,8 @@ import lamindb as ln
 ln.settings.sync_git_repo = "https://github.com/laminlabs/lamin-cli"
 ln.settings.transform.stem_uid = "m5uCHTTpJnjQ"
 ln.settings.transform.version = "1"
+ln.settings.transform.name = "My good script"
+
 
 if __name__ == "__main__":
     # we're using new_run here to mock the notebook situation

{lamin_cli-0.14.0 → lamin_cli-0.15.0}/tests/scripts/run-track-and-finish.py

@@ -2,6 +2,7 @@ import lamindb as ln
 
 ln.settings.transform.stem_uid = "VFYCIuaw2GsX"
 ln.settings.transform.version = "1"
+ln.settings.transform.name = "My good script 2"
 
 if __name__ == "__main__":
     # we're using new_run here to mock the notebook situation

{lamin_cli-0.14.0 → lamin_cli-0.15.0}/tests/test_migrate.py

@@ -15,7 +15,7 @@ def test_migrate_deploy():
     import lamindb as ln
 
     instance_slug = ln.setup.settings.instance.slug
-    exit_status = os.system("lamin load laminlabs/static-test-instance-private-sqlite")
+    exit_status = os.system("lamin load testuser1/static-test-instance-private-sqlite")
     assert exit_status == 0
     exit_status = os.system("lamin migrate deploy")
     assert exit_status == 0

{lamin_cli-0.14.0 → lamin_cli-0.15.0}/tests/test_save_scripts.py

@@ -37,7 +37,7 @@ def test_run_save_cache():
     assert "saved: Run" in result.stdout.decode()
 
     transform = ln.Transform.get("m5uCHTTpJnjQ")
-    assert transform.source_code.hash == "-QN2dVdC8T3xWG8vBl-wew"
+    assert transform.source_code.hash == "T1zmmTJyeEpBxjaHcHcZdg"
     assert transform.latest_run.environment.path.exists()
     assert transform.source_code.path.exists()
 

lamin_cli-0.14.0/lamin_cli/__init__.py

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