lamindb_setup 1.13.1__tar.gz → 1.14.1__tar.gz

{lamindb_setup-1.13.1 → lamindb_setup-1.14.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: lamindb_setup
-Version: 1.13.1
+Version: 1.14.1
 Summary: Setup & configure LaminDB.
 Author-email: Lamin Labs <open-source@lamin.ai>
 Requires-Python: >=3.10

{lamindb_setup-1.13.1 → lamindb_setup-1.14.1}/lamindb_setup/__init__.py

@@ -4,25 +4,17 @@ Many functions in this "setup API" have a matching command in the :doc:`docs:cli
 
 Guide: :doc:`docs:setup`.
 
-Basic operations:
+Basic operations
+----------------
 
-.. autosummary::
-   :toctree:
+.. autofunction:: login
+.. autofunction:: logout
+.. autofunction:: init
+.. autofunction:: disconnect
+.. autofunction:: delete
 
-   login
-   logout
-   init
-   disconnect
-   delete
-
-Instance operations:
-
-.. autosummary::
-   :toctree:
-
-   migrate
-
-Modules & settings:
+Modules & settings
+------------------
 
 .. autosummary::
    :toctree:
@@ -33,9 +25,17 @@ Modules & settings:
    errors
    types
 
+Migration management
+--------------------
+
+.. autosummary::
+   :toctree:
+
+   migrate
+
 """
 
-__version__ = "1.13.1"  # denote a release candidate for 0.1.0 with 0.1rc1
+__version__ = "1.14.1"  # denote a release candidate for 0.1.0 with 0.1rc1
 
 import os
 import warnings

{lamindb_setup-1.13.1 → lamindb_setup-1.14.1}/lamindb_setup/_connect_instance.py

@@ -260,6 +260,10 @@ def _connect_cli(
         connect(_write_settings=False, _reload_lamindb=False)
     else:
         logger.important(f"connected lamindb: {isettings.slug}")
+    if settings_.dev_dir is None:
+        logger.important_hint(
+            "to map a local dev directory, call: lamin settings set dev-dir ."
+        )
     return None
 
 
@@ -427,6 +431,10 @@ def connect(instance: str | None = None, **kwargs: Any) -> str | tuple | None:
                 isettings._get_settings_file().unlink(missing_ok=True)  # type: ignore
             settings._instance_settings = None
         raise e
+    if settings.dev_dir is None:
+        logger.important_hint(
+            "to map a local dev directory, set: ln.setup.settings.dev_dir = '.'"
+        )
     return None
 
 

{lamindb_setup-1.13.1 → lamindb_setup-1.14.1}/lamindb_setup/core/__init__.py

@@ -1,21 +1,16 @@
 """Core setup library.
 
-Settings:
-
-.. autosummary::
-   :toctree:
-
-   SetupSettings
-   UserSettings
-   InstanceSettings
-   StorageSettings
+.. autoclass:: SetupSettings
+.. autoclass:: UserSettings
+.. autoclass:: InstanceSettings
+.. autoclass:: StorageSettings
 
 """
 
 from . import django, upath
 from ._clone import connect_local_sqlite, init_local_sqlite
-from ._deprecated import deprecated
-from ._docs import doc_args
+from ._deprecated import deprecated  # documented in lamindb.base
+from ._docs import doc_args  # documented in lamindb.base
 from ._settings import SetupSettings
 from ._settings_instance import InstanceSettings
 from ._settings_storage import StorageSettings

{lamindb_setup-1.13.1 → lamindb_setup-1.14.1}/lamindb_setup/core/_hub_core.py

@@ -551,6 +551,9 @@ def _connect_instance_hub(
                     db_user["password" if fine_grained_access else "db_user_password"],
                 )
 
+        db_user_name = "none" if db_user_name is None else db_user_name
+        db_user_password = "none" if db_user_password is None else db_user_password
+
         if use_proxy_db:
             host = instance.get("proxy_host", None)
             assert host is not None, (
@@ -560,14 +563,16 @@ def _connect_instance_hub(
             assert port is not None, (
                 "Database proxy port is not available, please do not pass 'use_proxy_db'."
             )
+            # remove supabase project id if present
+            db_user_name = db_user_name.rsplit(".", 1)[0]
         else:
             host = instance["db_host"]
             port = instance["db_port"]
 
         db_dsn = LaminDsn.build(
             scheme=instance["db_scheme"],
-            user=db_user_name if db_user_name is not None else "none",
-            password=db_user_password if db_user_password is not None else "none",
+            user=db_user_name,
+            password=db_user_password,
             host=host,
             port=port,
             database=instance["db_database"],

{lamindb_setup-1.13.1 → lamindb_setup-1.14.1}/lamindb_setup/core/_settings.py

@@ -5,6 +5,7 @@ import sys
 from pathlib import Path
 from typing import TYPE_CHECKING
 
+import jwt
 from lamin_utils import logger
 from platformdirs import user_cache_dir
 
@@ -58,7 +59,6 @@ class SetupSettings:
 
     _auto_connect_path: Path = settings_dir / "auto_connect"
     _private_django_api_path: Path = settings_dir / "private_django_api"
-    _work_dir: Path = settings_dir / "work_dir.txt"
 
     _cache_dir: Path | None = None
 
@@ -69,25 +69,6 @@ class SetupSettings:
     def _instance_settings_path(self) -> Path:
         return current_instance_settings_file()
 
-    @property
-    def work_dir(self) -> Path | None:
-        """Get or set the current working directory.
-
-        If setting it to `None`, the working directory is unset
-        """
-        if not self._work_dir.exists():
-            return None
-        return Path(self._work_dir.read_text())
-
-    @work_dir.setter
-    def work_dir(self, value: str | Path | None) -> None:
-        if value is None:
-            if self._work_dir.exists():
-                self._work_dir.unlink()
-        else:
-            value_str = Path(value).expanduser().resolve().as_posix()
-            self._work_dir.write_text(value_str)
-
     @property
     def settings_dir(self) -> Path:
         """The directory that holds locally persisted settings."""
@@ -111,6 +92,31 @@ class SetupSettings:
         else:
             self._auto_connect_path.unlink(missing_ok=True)
 
+    @property
+    def _dev_dir_path(self) -> Path:
+        return (
+            settings_dir / f"dev-dir--{self.instance.owner}--{self.instance.name}.txt"
+        )
+
+    @property
+    def dev_dir(self) -> Path | None:
+        """Get or set the local development directory for the current instance.
+
+        If setting it to `None`, the working development directory is unset.
+        """
+        if not self._dev_dir_path.exists():
+            return None
+        return Path(self._dev_dir_path.read_text())
+
+    @dev_dir.setter
+    def dev_dir(self, value: str | Path | None) -> None:
+        if value is None:
+            if self._dev_dir_path.exists():
+                self._dev_dir_path.unlink()
+        else:
+            value_str = Path(value).expanduser().resolve().as_posix()
+            self._dev_dir_path.write_text(value_str)
+
     @property
     def _branch_path(self) -> Path:
         return (
@@ -319,6 +325,35 @@ class SetupSettings:
         """
         return SetupPaths
 
+    def _debug_db_access(self):
+        """Debug database access problems."""
+        instance = self.instance
+        db_permissions = instance._db_permissions
+        print("db connection: ", instance.db)
+        print("db permissions: ", db_permissions)
+        if db_permissions != "jwt":
+            return
+        # sets the token if not present yet
+        print("available spaces: ", instance.available_spaces)
+
+        from lamindb_setup.core.django import db_token_manager
+
+        tokens = db_token_manager.tokens
+        if tokens:
+            for conn, token in tokens.items():
+                token_encoded = token._token
+                if token_encoded is None:
+                    token._refresh_token()
+                    token_encoded = token._token
+                token_decoded = jwt.decode(
+                    token_encoded, options={"verify_signature": False}
+                )
+                print(
+                    f"db token for the connection '{conn}' is '{token_encoded}': {token_decoded}"
+                )
+        else:
+            print("no db tokens are present")
+
     def __repr__(self) -> str:
         """Rich string representation."""
         from lamin_utils import colors
@@ -331,9 +366,9 @@ class SetupSettings:
         if self._instance_exists:
             instance_rep = self.instance.__repr__().split("\n")
             repr += f"{colors.cyan('Instance:')} {instance_rep[0].replace('Instance: ', '')}\n"
-            repr += f" - work-dir: {self.work_dir}\n"
             repr += f" - branch: {self._read_branch_idlike_name()[1]}\n"
-            repr += f" - space: {self._read_space_idlike_name()[1]}"
+            repr += f" - space: {self._read_space_idlike_name()[1]}\n"
+            repr += f" - dev-dir: {self.dev_dir}"
             repr += f"\n{colors.yellow('Details:')}\n"
             repr += "\n".join(instance_rep[1:])
         else:

{lamindb_setup-1.13.1 → lamindb_setup-1.14.1}/lamindb_setup/core/upath.py

@@ -737,25 +737,30 @@ UPath.exists.__doc__ = Path.exists.__doc__
 UPath.is_dir.__doc__ = Path.is_dir.__doc__
 UPath.is_file.__doc__ = Path.is_file.__doc__
 UPath.unlink.__doc__ = Path.unlink.__doc__
-UPath.rename.__doc__ = """Move file, see fsspec.AbstractFileSystem.mv.
+UPath.rename.__doc__ = """Move file, see `fsspec.AbstractFileSystem.mv`.
 
->>> upath = Upath("s3://my-bucket/my-file")
->>> upath.rename(UPath("s3://my-bucket/my-file-renamed"))
->>> upath.rename("my-file-renamed")
+For example::
 
->>> upath = Upath("local-folder/my-file")
->>> upath.rename("local-folder/my-file-renamed")
+    upath = UPath("s3://my-bucket/my-file")
+    upath.rename(UPath("s3://my-bucket/my-file-renamed"))
+    upath.rename("my-file-renamed")
 """
-UPath.__doc__ = """Paths: low-level key-value access to files/objects.
+UPath.__doc__ = """Paths: low-level key-value access to files.
 
-Paths are based on keys that offer the typical access patterns of file systems
- and object stores.
+Offers the typical access patterns of file systems and object stores, for instance::
 
->>> upath = UPath("s3://my-bucket/my-folder")
->>> upath.exists()
+    upath = UPath("s3://my-bucket/my-folder/my-file.txt")
+    upath.exists()  # file exists in storage
+
+LaminDB exposes `universal_pathlib.UPath` and adds functionality related to authentication and the following methods::
+
+    upath.view_tree()  # view a file tree
+    upath.upload_from("local-file.txt") # upload a local file
+    upath.download_to("local-file.txt") # download a file
+    upath.synchronize_to("local-folder/") # synchronize a folder
 
 Args:
-    pathlike: A string or Path to a local/cloud file/directory/folder.
+    pathlike: A string or `Path` to a local or cloud file/directory/folder.
 """
 
 logger.debug("upath.UPath has been patched")

{lamindb_setup-1.13.1 → lamindb_setup-1.14.1}/lamindb_setup/errors.py

@@ -1,16 +1,13 @@
 """Errors.
 
-.. autosummary::
-   :toctree: .
-
-   CurrentInstanceNotConfigured
-   InstanceNotSetupError
-   ModuleWasntConfigured
-   StorageAlreadyManaged
-   StorageNotEmpty
-   InstanceLockedException
-   SettingsEnvFileOutdated
-   CannotSwitchDefaultInstance
+.. autoexception:: CurrentInstanceNotConfigured
+.. autoexception:: InstanceNotSetupError
+.. autoexception:: ModuleWasntConfigured
+.. autoexception:: StorageAlreadyManaged
+.. autoexception:: StorageNotEmpty
+.. autoexception:: InstanceLockedException
+.. autoexception:: SettingsEnvFileOutdated
+.. autoexception:: CannotSwitchDefaultInstance
 
 """
 

{lamindb_setup-1.13.1 → lamindb_setup-1.14.1}/lamindb_setup/types.py

@@ -1,10 +1,7 @@
 """Types.
 
-.. autosummary::
-   :toctree: .
-
-   UPathStr
-   StorageType
+.. autoclass:: UPathStr
+.. autoclass:: StorageType
 """
 
 from __future__ import annotations

{lamindb_setup-1.13.1 → lamindb_setup-1.14.1}/tests/hub-local/scripts/script-connect-fine-grained-access.py

@@ -41,6 +41,9 @@ with connection.cursor() as cur:
 # check available spaces call
 assert ln_setup.settings.instance.available_spaces
 
+# run debug function for coverage
+ln_setup.settings._debug_db_access()
+
 # check reset
 db_token_manager.reset()
 assert not db_token_manager.tokens