lamindb_setup 0.76.8__py2.py3-none-any.whl → 0.77.1__py2.py3-none-any.whl

lamindb_setup/__init__.py

@@ -34,10 +34,10 @@ Modules & settings:
 
 """
 
-__version__ = "0.76.8"  # denote a release candidate for 0.1.0 with 0.1rc1
+__version__ = "0.77.1"  # denote a release candidate for 0.1.0 with 0.1rc1
 
-import sys
-from os import name as _os_name
+import os as _os
+import sys as _sys
 
 from . import core
 from ._check_setup import _check_instance_setup
@@ -45,18 +45,18 @@ from ._close import close
 from ._connect_instance import connect, load
 from ._delete import delete
 from ._django import django
+from ._entry_points import call_registered_entry_points as _call_registered_entry_points
 from ._init_instance import init
 from ._migrate import migrate
 from ._register_instance import register
 from ._setup_user import login, logout
 from .core._settings import settings
 
-dev = core  # backward compat
-_TESTING = False  # used in lamindb tests
+_TESTING = _os.getenv("LAMIN_TESTING") is not None
 
 # hide the supabase error in a thread on windows
-if _os_name == "nt":
-    if sys.version_info.minor > 7:
+if _os.name == "nt":
+    if _sys.version_info.minor > 7:
         import threading
 
         _original_excepthook = threading.excepthook
@@ -69,4 +69,7 @@ if _os_name == "nt":
 
         threading.excepthook = _except_hook
 
+# provide a way for other packages to run custom code on import
+_call_registered_entry_points("lamindb_setup.on_import")
+
 settings.__doc__ = """Global :class:`~lamindb.setup.core.SetupSettings`."""

lamindb_setup/_connect_instance.py

@@ -124,7 +124,11 @@ def _connect_instance(
     if make_hub_request:
         # the following will return a string if the instance does not exist
         # on the hub
-        hub_result = load_instance_from_hub(owner=owner, name=name)
+        # do not call hub if the user is anonymous
+        if owner != "anonymous":
+            hub_result = load_instance_from_hub(owner=owner, name=name)
+        else:
+            hub_result = "anonymous-user"
         # if hub_result is not a string, it means it made a request
         # that successfully returned metadata
         if not isinstance(hub_result, str):
@@ -155,9 +159,12 @@ def _connect_instance(
             )
             check_whether_migrations_in_sync(instance_result["lamindb_version"])
         else:
-            message = INSTANCE_NOT_FOUND_MESSAGE.format(
-                owner=owner, name=name, hub_result=hub_result
-            )
+            if hub_result != "anonymous-user":
+                message = INSTANCE_NOT_FOUND_MESSAGE.format(
+                    owner=owner, name=name, hub_result=hub_result
+                )
+            else:
+                message = "It is not possible to load an anonymous-owned instance from the hub"
             if settings_file.exists():
                 isettings = load_instance_settings(settings_file)
                 if isettings.is_remote:

lamindb_setup/_entry_points.py

@@ -0,0 +1,22 @@
+import sys
+import warnings
+from importlib.metadata import entry_points
+
+
+def call_registered_entry_points(group, **kwargs):
+    """load and call entry points registered under group."""
+    if sys.version_info >= (3, 10):
+        eps = entry_points(group=group)
+    else:
+        eps = entry_points().get(group, [])
+
+    for ep in eps:
+        func = ep.load()
+        try:
+            func(**kwargs)
+        except BaseException as e:
+            warnings.warn(
+                f"Error loading entry point of group {group!r}: {ep} -> {e}",
+                RuntimeWarning,
+                stacklevel=2,
+            )

lamindb_setup/_setup_user.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
-from typing import Optional, Union
+import os
+from typing import TYPE_CHECKING, Optional, Union
 
 from lamin_utils import logger
 
@@ -15,8 +16,11 @@ from .core._settings_store import (
     user_settings_file_handle,
 )
 
+if TYPE_CHECKING:
+    from lamindb_setup.core._settings_save import UserSettings
 
-def load_user(email: str | None = None, handle: str | None = None) -> str | None:
+
+def load_user(email: str | None = None, handle: str | None = None) -> UserSettings:
     if email is not None:
         settings_file = user_settings_file_email(email)
     if handle is not None:
@@ -28,8 +32,8 @@ def load_user(email: str | None = None, handle: str | None = None) -> str | None
     else:
         user_settings = load_or_create_user_settings()
         if email is None:
-            raise RuntimeError(
-                "Use your email for your first login in a compute environment. "
+            raise SystemExit(
+                "✗ Use your email for your first login in a compute environment. "
                 "After that, you can use your handle."
             )
         user_settings.email = email
@@ -40,59 +44,68 @@ def load_user(email: str | None = None, handle: str | None = None) -> str | None
 
     settings._user_settings = None  # this is to refresh a settings instance
 
-    return None
+    return user_settings
 
 
 def login(
-    user: str,
-    *,
-    key: str | None = None,
-    password: str | None = None,  # for backward compat
+    user: str | None = None, *, key: str | None = None, api_key: str | None = None
 ) -> None:
     """Log in user.
 
     Args:
         user: handle or email
-        key: API key or legacy passward
-        password: Backward compat, will be removed
+        key: API key
+        api_key: Beta API key
     """
-    if "@" in user:
-        email, handle = user, None
+    if user is None and api_key is None:
+        if "LAMIN_API_KEY" in os.environ:
+            api_key = os.environ["LAMIN_API_KEY"]
+        else:
+            raise ValueError("Both `user` and `api_key` should not be `None`.")
+
+    if api_key is None:
+        if "@" in user:  # type: ignore
+            email, handle = user, None
+        else:
+            email, handle = None, user
+        user_settings = load_user(email, handle)
+
+        if key is not None:
+            # within UserSettings, we still call it "password" for a while
+            user_settings.password = key
+
+        if user_settings.email is None:
+            raise SystemExit(f"✗ No stored user email, please call: lamin login {user}")
+
+        if user_settings.password is None:
+            raise SystemExit(
+                "✗ No stored API key, please call: lamin login <your-email> --key <API-key>"
+            )
     else:
-        email, handle = None, user
-    load_user(email, handle)
-
-    user_settings = load_or_create_user_settings()
-
-    if password is not None:
-        logger.warning(
-            "please use --key instead of --password, "
-            "passwords are deprecated and replaced with API keys"
-        )
-        key = password
-
-    if key is not None:
-        # within UserSettings, we still call it "password" for a while
-        user_settings.password = key
+        user_settings = load_or_create_user_settings()
 
-    if user_settings.email is None:
-        raise RuntimeError("No stored user email, please call: lamin login {user}")
+    from .core._hub_core import sign_in_hub, sign_in_hub_api_key
 
-    if user_settings.password is None:
-        raise RuntimeError(
-            "No stored API key, please call: lamin login <your-email> --key <API-key>"
+    if api_key is None:
+        response = sign_in_hub(
+            user_settings.email,  # type: ignore
+            user_settings.password,  # type: ignore
+            user_settings.handle,
         )
+    else:
+        response = sign_in_hub_api_key(api_key)
 
-    from .core._hub_core import sign_in_hub
-
-    response = sign_in_hub(
-        user_settings.email, user_settings.password, user_settings.handle
-    )
     if isinstance(response, Exception):
         raise response
+    elif isinstance(response, str):
+        raise SystemExit(f"✗ Unsuccessful login: {response}.")
     else:
         user_uuid, user_id, user_handle, user_name, access_token = response
-    if handle is None:
+    if api_key is not None:
+        logger.success(
+            f"logged in with API key (handle: {user_handle}, uid: {user_id})"
+        )
+    elif handle is None:
         logger.success(f"logged in with handle {user_handle} (uid: {user_id})")
     else:
         logger.success(f"logged in with email {user_settings.email} (uid: {user_id})")
@@ -101,6 +114,7 @@ def login(
     user_settings.name = user_name
     user_settings._uuid = user_uuid
     user_settings.access_token = access_token
+    user_settings.api_key = api_key
     save_user_settings(user_settings)
 
     if settings._instance_exists and _check_instance_setup():
@@ -113,6 +127,8 @@ def login(
 def logout():
     if current_user_settings_file().exists():
         current_user_settings_file().unlink()
+        # update user info
+        settings._user_settings = None
         logger.success("logged out")
     else:
         logger.important("already logged out")

lamindb_setup/core/_hub_client.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import json
 import os
 from urllib.request import urlretrieve
 
@@ -78,7 +79,7 @@ def connect_hub_with_auth(
 
         if renew_token:
             settings.user.access_token = get_access_token(
-                settings.user.email, settings.user.password
+                settings.user.email, settings.user.password, settings.user.api_key
             )
         access_token = settings.user.access_token
     hub.postgrest.auth(access_token)
@@ -87,9 +88,17 @@ def connect_hub_with_auth(
 
 
 # runs ~0.5s
-def get_access_token(email: str | None = None, password: str | None = None):
+def get_access_token(
+    email: str | None = None, password: str | None = None, api_key: str | None = None
+):
     hub = connect_hub()
     try:
+        if api_key is not None:
+            auth_response = hub.functions.invoke(
+                "create-jwt",
+                invoke_options={"body": {"api_key": api_key}},
+            )
+            return json.loads(auth_response)["accessToken"]
         auth_response = hub.auth.sign_in_with_password(
             {
                 "email": email,

lamindb_setup/core/_hub_core.py

@@ -436,10 +436,11 @@ def _sign_in_hub(email: str, password: str, handle: str | None, client: Client):
     )
     data = client.table("account").select("*").eq("id", auth.user.id).execute().data
     if data:  # sync data from hub to local cache in case it was updated on the hub
-        user_uuid = UUID(data[0]["id"])
-        user_id = data[0]["lnid"]
-        user_handle = data[0]["handle"]
-        user_name = data[0]["name"]
+        user = data[0]
+        user_uuid = UUID(user["id"])
+        user_id = user["lnid"]
+        user_handle = user["handle"]
+        user_name = user["name"]
         if handle is not None and handle != user_handle:
             logger.warning(
                 f"using account handle {user_handle} (cached handle was {handle})"
@@ -458,7 +459,7 @@ def _sign_in_hub(email: str, password: str, handle: str | None, client: Client):
 
 def sign_in_hub(
     email: str, password: str, handle: str | None = None
-) -> Exception | tuple[UUID, str, str, str, str]:
+) -> Exception | str | tuple[UUID, str, str, str, str]:
     try:
         result = call_with_fallback(
             _sign_in_hub, email=email, password=password, handle=handle
@@ -471,3 +472,53 @@ def sign_in_hub(
         )
         return exception
     return result
+
+
+def _sign_in_hub_api_key(api_key: str, client: Client):
+    response = client.functions.invoke(
+        "create-jwt",
+        invoke_options={"body": {"api_key": api_key}},
+    )
+    access_token = json.loads(response)["accessToken"]
+    # probably need more info here to avoid additional queries
+    # like handle, uid etc
+    account_id = client.auth._decode_jwt(access_token)["sub"]
+    client.postgrest.auth(access_token)
+    # normally public.account.id is equal to auth.user.id
+    data = client.table("account").select("*").eq("id", account_id).execute().data
+    if data:
+        user = data[0]
+        user_uuid = UUID(user["id"])
+        user_id = user["lnid"]
+        user_handle = user["handle"]
+        user_name = user["name"]
+    else:
+        logger.error("Invalid API key.")
+        return "invalid-api-key"
+    return (user_uuid, user_id, user_handle, user_name, access_token)
+
+
+def sign_in_hub_api_key(
+    api_key: str,
+) -> Exception | str | tuple[UUID, str, str, str, str]:
+    try:
+        result = call_with_fallback(_sign_in_hub_api_key, api_key=api_key)
+    except Exception as exception:
+        logger.error(exception)
+        logger.error("Could not login. Probably your API key is wrong.")
+        return exception
+    return result
+
+
+def _create_api_key(body: dict, client: Client) -> str:
+    response = client.functions.invoke(
+        "create-api-key",
+        invoke_options={"body": body},
+    )
+    api_key = json.loads(response)["apiKey"]
+    return api_key
+
+
+def create_api_key(body: dict) -> str:
+    api_key = call_with_fallback_auth(_create_api_key, body=body)
+    return api_key

lamindb_setup/core/_settings_load.py

@@ -71,30 +71,35 @@ def load_user_settings(user_settings_file: Path):
     return settings
 
 
+def _null_to_value(field, value=None):
+    return field if field != "null" else value
+
+
 def setup_instance_from_store(store: InstanceSettingsStore) -> InstanceSettings:
     ssettings = StorageSettings(
         root=store.storage_root,
-        region=store.storage_region if store.storage_region != "null" else None,
+        region=_null_to_value(store.storage_region),
     )
     return InstanceSettings(
         id=UUID(store.id),
         owner=store.owner,
         name=store.name,
         storage=ssettings,
-        db=store.db if store.db != "null" else None,  # type: ignore
-        schema=store.schema_str if store.schema_str != "null" else None,
-        git_repo=store.git_repo if store.git_repo != "null" else None,
+        db=_null_to_value(store.db),
+        schema=_null_to_value(store.schema_str),
+        git_repo=_null_to_value(store.git_repo),
         keep_artifacts_local=store.keep_artifacts_local,  # type: ignore
     )
 
 
 def setup_user_from_store(store: UserSettingsStore) -> UserSettings:
     settings = UserSettings()
-    settings.email = store.email
-    settings.password = store.password if store.password != "null" else None
+    settings.email = _null_to_value(store.email)
+    settings.password = _null_to_value(store.password)
     settings.access_token = store.access_token
+    settings.api_key = _null_to_value(store.api_key)
     settings.uid = store.uid
-    settings.handle = store.handle if store.handle != "null" else "anonymous"
-    settings.name = store.name if store.name != "null" else None
+    settings.handle = _null_to_value(store.handle, value="anonymous")
+    settings.name = _null_to_value(store.name)
     settings._uuid = UUID(store.uuid) if store.uuid != "null" else None
     return settings

lamindb_setup/core/_settings_store.py

@@ -65,6 +65,7 @@ class UserSettingsStore(BaseSettings):
     email: str
     password: str
     access_token: str
+    api_key: Optional[str] = None
     uid: str
     uuid: str
     handle: str

lamindb_setup/core/_settings_user.py

@@ -21,8 +21,10 @@ class UserSettings:
 
     handle: str = "anonymous"
     """Unique handle."""
-    email: str = None  # type: ignore
+    email: str | None = None
     """User email."""
+    api_key: str | None = None
+    """Beta API key."""
     password: str | None = None
     """API key or legacy password."""
     access_token: str | None = None

{lamindb_setup-0.76.8.dist-info → lamindb_setup-0.77.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: lamindb_setup
-Version: 0.76.8
+Version: 0.77.1
 Summary: Setup & configure LaminDB.
 Author-email: Lamin Labs <open-source@lamin.ai>
 Description-Content-Type: text/markdown

{lamindb_setup-0.76.8.dist-info → lamindb_setup-0.77.1.dist-info}/RECORD

@@ -1,11 +1,12 @@
-lamindb_setup/__init__.py,sha256=kQrdnR18O5ztr_aI5pTm9X9hB1RD6aJXYT29cB7kiIM,1542
+lamindb_setup/__init__.py,sha256=S8zggJwTndSC_MojZpmVuvD4i8hp6CwnyjLNH8wU6d4,1726
 lamindb_setup/_cache.py,sha256=wA7mbysANwe8hPNbjDo9bOmXJ0xIyaS5iyxIpxSWji4,846
 lamindb_setup/_check.py,sha256=28PcG8Kp6OpjSLSi1r2boL2Ryeh6xkaCL87HFbjs6GA,129
 lamindb_setup/_check_setup.py,sha256=cNEL9Q4yPpmEkGKHH8JgullWl1VUZwALJ4RHn9wZypY,2613
 lamindb_setup/_close.py,sha256=cXNwK7QTTyNFt2XTpLnO3KHljJ7ShOcISk95np_dltE,1239
-lamindb_setup/_connect_instance.py,sha256=kAZMTP3w5Vgw-pgZDX9RhYl3TKHaxBuTczTVIsy8Xms,16069
+lamindb_setup/_connect_instance.py,sha256=TaY317ufYYAVWoEAfeGI_P8IJDP4AYTcHxA4w0-CIqU,16386
 lamindb_setup/_delete.py,sha256=Y8KSFYgY0UHAvjd7cCL6hZ_XiLeJwx50BguVATcj_Xo,5524
 lamindb_setup/_django.py,sha256=EoyWvFzH0i9wxjy4JZhcoXCTckztP_Mrl6FbYQnMmLE,1534
+lamindb_setup/_entry_points.py,sha256=Hs2oJQOCTaGUdWn-1mufM6qUZr9W_EJ_Oc3f0_Vc0Yw,616
 lamindb_setup/_exportdb.py,sha256=43g77-tH-vAlTn8ig1mMD9-KXLKvxUeDLaq0gVu3l-c,2114
 lamindb_setup/_importdb.py,sha256=yYYShzUajTsR-cTW4CZ-UNDWZY2uE5PAgNbp-wn8Ogc,1874
 lamindb_setup/_init_instance.py,sha256=VxHgD2i0hrFm2f_WCX76YmS_Lsx2iufrMtfab82r8X0,12391
@@ -14,25 +15,25 @@ lamindb_setup/_register_instance.py,sha256=alQuYp2f8Ct8xvRC1gt8p_HZ0tqCd3gZD3kiP
 lamindb_setup/_schema.py,sha256=b3uzhhWpV5mQtDwhMINc2MabGCnGLESy51ito3yl6Wc,679
 lamindb_setup/_schema_metadata.py,sha256=XfKCcpQXoatx4Dm2pflp-mPhZ9tpqjn2Cq4ip3MOFSY,13715
 lamindb_setup/_set_managed_storage.py,sha256=4tDxXQMt8Gw028uY3vIQxZQ7qBNXhQMc8saarNK_Z-s,2043
-lamindb_setup/_setup_user.py,sha256=6Oc7Rke-yRQSZbuntdUAz8QbJ6UuPzYHI9FnYlf_q-A,3670
+lamindb_setup/_setup_user.py,sha256=vvmzotU_6C-fFLIZ85mevdkKMV9qXHsQFIXoXV3GUEk,4395
 lamindb_setup/_silence_loggers.py,sha256=AKF_YcHvX32eGXdsYK8MJlxEaZ-Uo2f6QDRzjKFCtws,1568
 lamindb_setup/core/__init__.py,sha256=BxIVMX5HQq8oZ1OuY_saUEJz5Tdd7gaCPngxVu5iou4,417
 lamindb_setup/core/_aws_credentials.py,sha256=uKMQO9q42Hnepz8aj3RxwLKDWUJx8pNOYrFnnNh5X40,5325
 lamindb_setup/core/_aws_storage.py,sha256=nEjeUv4xUVpoV0Lx-zjjmyb9w804bDyaeiM-OqbfwM0,1799
 lamindb_setup/core/_deprecated.py,sha256=3qxUI1dnDlSeR0BYrv7ucjqRBEojbqotPgpShXs4KF8,2520
 lamindb_setup/core/_docs.py,sha256=3k-YY-oVaJd_9UIY-LfBg_u8raKOCNfkZQPA73KsUhs,276
-lamindb_setup/core/_hub_client.py,sha256=4FcZBIuKhIWT0hggi3fm3bObOz7j7uhMU6bC0-98kgE,5785
-lamindb_setup/core/_hub_core.py,sha256=2Ni7vIkUcZw9ryBLgjercvLsdAL8-3xZNmrxyzNCU98,17049
+lamindb_setup/core/_hub_client.py,sha256=nhdF9qYABRzVkDQMFI-Ft4KVZPDJXrZiyHIvAE5e2j4,6103
+lamindb_setup/core/_hub_core.py,sha256=IOH8yI60xYel42aXTk2yYlF5Z2jJPsHFhvn9cguA-FY,18690
 lamindb_setup/core/_hub_crud.py,sha256=eZErpq9t1Cp2ULBSi457ekrcqfesw4Y6IJgaqyrINMY,5276
 lamindb_setup/core/_hub_utils.py,sha256=w5IRtrxZcvxmGSJslzuZF89ewkzXV4cCUmZUVrqmAfo,3026
 lamindb_setup/core/_private_django_api.py,sha256=KIn43HOhiRjkbTbddyJqv-WNTTa1bAizbM1tWXoXPBg,2869
 lamindb_setup/core/_settings.py,sha256=46axQ5HPvI0X9YuotgdpuSOfSo7qYU1DudIx3vxpFk0,4471
 lamindb_setup/core/_settings_instance.py,sha256=QkhBeDrnM86WDq_FL6KwBIkQxW9mqLjwNW7FSBoKXxs,17608
-lamindb_setup/core/_settings_load.py,sha256=bRkGgaEnLZmnOlU5ptDoSM-YXzC2l0Cb7RBoBY6VH9k,3717
+lamindb_setup/core/_settings_load.py,sha256=n7-_vg7YfuoMo4wdwwL2hdBjorywTq0GiprsfILWCko,3720
 lamindb_setup/core/_settings_save.py,sha256=n_tYfb9EBSxwm4LHyPRHJptE5uB8lmHhcRkz1JkAmhg,2781
 lamindb_setup/core/_settings_storage.py,sha256=jFdoIkSn1gPDDZKjAlgKyrlsHBqZDOvv-UnuUI7aD_4,14249
-lamindb_setup/core/_settings_store.py,sha256=VEE8Ff2A7y4j8ksOaa7g48jNaOqe1PBnBjb1PKKGUKU,2115
-lamindb_setup/core/_settings_user.py,sha256=P2lC4WDRAFfT-Xq3MlXJ-wMKIHCoGNhMTQfRGIAyUNQ,1344
+lamindb_setup/core/_settings_store.py,sha256=tEpHPEqg58ZMyCZUKRkekQ3VzTByqsRTnWh_esTWUVY,2149
+lamindb_setup/core/_settings_user.py,sha256=N3a3CjZSCs0TW5Q0A_HVUaKBCpb0_82wZMoa5C_YsbA,1390
 lamindb_setup/core/_setup_bionty_sources.py,sha256=o2L5Ww8TKgSqJtL4cGUcpJwLNYxA9BZgddhCMCu_E2g,3428
 lamindb_setup/core/cloud_sqlite_locker.py,sha256=reu02M4aE2BT_A5AFqwhv48l91mOMyQ4zTd-hh-wtuU,6922
 lamindb_setup/core/django.py,sha256=QUQm3zt5QIiD8uv6o9vbSm_bshqiSWzKSkgD3z2eJCg,3542
@@ -40,7 +41,7 @@ lamindb_setup/core/exceptions.py,sha256=eoI7AXgATgDVzgArtN7CUvpaMUC067vsBg5LHCsW
 lamindb_setup/core/hashing.py,sha256=Y2cvEaqtm3KwpHqj5ZG2f_sLaXhsQT4oDrmJdHbOQeo,3116
 lamindb_setup/core/types.py,sha256=bcYnZ0uM_2NXKJCl94Mmc-uYrQlRUUVKG3sK2N-F-N4,532
 lamindb_setup/core/upath.py,sha256=EPLLm62q-Y3hZzd-286cynFMttXKDNXNOKL3_QGkeug,27215
-lamindb_setup-0.76.8.dist-info/LICENSE,sha256=UOZ1F5fFDe3XXvG4oNnkL1-Ecun7zpHzRxjp-XsMeAo,11324
-lamindb_setup-0.76.8.dist-info/WHEEL,sha256=Sgu64hAMa6g5FdzHxXv9Xdse9yxpGGMeagVtPMWpJQY,99
-lamindb_setup-0.76.8.dist-info/METADATA,sha256=oqDAk3PGTipph7_JezoeXlST0hucIKVreA9VRWUzcBA,1667
-lamindb_setup-0.76.8.dist-info/RECORD,,
+lamindb_setup-0.77.1.dist-info/LICENSE,sha256=UOZ1F5fFDe3XXvG4oNnkL1-Ecun7zpHzRxjp-XsMeAo,11324
+lamindb_setup-0.77.1.dist-info/WHEEL,sha256=Sgu64hAMa6g5FdzHxXv9Xdse9yxpGGMeagVtPMWpJQY,99
+lamindb_setup-0.77.1.dist-info/METADATA,sha256=--qjx1aWeTkC0N4u10UC2JtnTvp_UMLPuXv2MO2icDQ,1667
+lamindb_setup-0.77.1.dist-info/RECORD,,