jotabase

Python client for jotaBase: sync, query and update your jotaBase databases from servers, scripts, notebooks and desktop apps.

• Read and write a database with a secret key (servers and scripts) or a publishable key and a signed-in user (apps, where access rules apply).
• Keep a copy on disk that later syncs bring up to date, downloading only what changed.
• Query it with SQL through DuckDB, one table per collection, with results as pandas or Polars tables.
• React to changes as they happen.

pip install jotabase                      # read, write, local copy, live changes
pip install "jotabase[sql,pandas]"        # plus SQL with DuckDB, and pandas

Python 3.10 or newer.

Quick start

import jotabase

db = jotabase.connect("my-app", key="sk_live_...")   # your database's secret key

# Write
db.put("tasks", {"title": "Write the report", "points": 3}, id="t1")
results = db.put_many("measurements", batch)        # split under the 1 MB request limit
for r in results.failed:                            # refused by an access rule
    print(r.id, r.error)
db.delete("tasks", "t1")

# Read everything, or only what changed since last time
changes = db.fetch_changes()
docs = changes.latest()                             # newest version of each, no deleted ones
later = db.fetch_changes(since=changes.checkpoint)

# Keep a copy in ./.jotabase/my-app/ and read it with no server
db.pull()
tasks = db.local().documents("tasks")

# SQL over the copy (pip install "jotabase[sql]")
df = db.sql("SELECT status, count(*) AS n FROM tasks GROUP BY status").df()   # pandas
pl = db.sql("SELECT * FROM tasks WHERE points > ?", [3]).pl()                 # Polars

# React to changes as they happen (a background thread)
@db.on_change
def changed(change):
    for doc in change.docs:
        print(doc["id"], doc["data"])

Keys and users

Never ship a secret key inside an app that runs on someone else's machine. Keys are created in the dashboard at app.jotabase.com.

Errors

A refused request raises jotabase.JotabaseError with .status (401/403 means the key or the login, anything else is worth a retry) and .code. A document an access rule refuses does not raise: it comes back in results.failed with the reason, while the rest of the batch is written.

Links

• jotaBase and the dashboard
• Design notes for this package
• The JavaScript client: @jotabase/client