Registry / database / lamindb-setup

lamindb-setup

JSON →
library1.25.0pypypi✓ verified 86d ago

Setup & configure LaminDB, a data management framework for biological data. Version 1.25.0, monthly releases. Handles authentication, instance configuration, and environment setup for LaminDB.

pip install lamindb-setup
INSTALL
IMPORT
SIG · LAMINDB-SETUP
L
lamindb-setup
databasepythonv1.25.0
harness data pending
Install & Compatibility
Where this runs

No compatibility data collected yet for this library.

Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

connect
✓ from lamindb_setup import connect
✗ import lamindb.setup as ln_setup
login
✓ from lamindb_setup import login
✗ import lamindb.setup as ln_setup
init
✓ from lamindb_setup import init
✗ import lamindb.setup as ln_setup

Initialize a local LaminDB instance with storage directory and required modules (e.g., bionty).

import lamindb.setup as ln_setup import os ln_setup.init(storage="./test_storage", modules="bionty")
Debug
Known issues
breakingIn version 1.0+, `lamindb.setup.init()` requires the `modules` parameter; omitting it raises an error.
fix
Always pass a list of module names (e.g., `modules='bionty'`).
affects: >=1.0.0
breakingThe `init` function no longer accepts `db` or `password` parameters. Database configuration is now done via LaminDB settings or environment variables.
fix
Use `ln_setup.settings.instance.db` or set environment variables `LAMINDB_DB` and `LAMINDB_PASSWORD`.
affects: >=1.0.0
deprecated`lamindb.setup.login()` is deprecated; use `ln_setup.init(storage=..., modules=...)` instead.
fix
Replace `ln_setup.login()` with `ln_setup.init(...)`.
affects: >=1.10.0
gotchaThe environment variable `LAMINDB_INSTANCE` must be set before importing `lamindb.setup` if you want to use a remote instance. Otherwise, a local instance is created.
fix
Set `LAMINDB_INSTANCE` in your shell or use `os.environ['LAMINDB_INSTANCE']='...'` before import.
affects: all
gotchaCalling `ln_setup.init()` more than once in the same session raises a `RuntimeError`.
fix
Check `ln_setup.is_initialized()` before calling `init()`, or restart the Python session.
affects: all
Upgrade
Version history
1.25.0latest on PyPI · released May 26, 2026
Audit
Dependencies
lamindboptionalCore LaminDB API for data operations
Agent activity
6 hits · last 30 days
node
6
Resources

No resource links recorded.

lamindb-setup — pip install lamindb-setup · libregistry