instantdb 0.0.1

Python SDK for InstantDB, the Modern Firebase

instantdb

Get Started · Examples · Docs · Discord

The Python SDK for Instant. This is a server SDK (analogous to @instantdb/admin) for running scripts, agents, data pipelines, and backend services against Instant from Python.

Install

pip install instantdb
# or
uv add instantdb

Quick start

from instantdb import init, id

db = init(app_id="...", admin_token="...")

# Query data
result = db.query({"goals": {"todos": {}}})
print(result["goals"])

# Write data
goal_id = id()
db.transact([
    db.tx.goals[goal_id].update({"title": "Get fit"}),
    db.tx.todos[id()].update({"title": "Go on a run"}),
])

# Subscribe to live changes
for payload in db.subscribe_query({"goals": {}}):
    if payload["type"] == "error":
        print("error:", payload["error"])
        break
    print("data:", payload["data"])

See the backend docs for the full admin API reference. The Python SDK mirrors that surface 1:1, with naming Pythonized to snake_case.

Development

Clone the repo. From client/packages/python/:

make install   # pip install -e ".[dev]"
make check     # ruff + mypy + pytest (~40 unit tests)

Pure-logic only - covers tx builder, validators, header construction. For end-to-end testing against a real backend, use the sandbox at client/sandbox/admin-sdk-python/.

Questions?

If you have any questions, feel free to drop us a line on our Discord.