Skip to main content

Templated Abstract Polymorphic Database - A flexible object model library

Project description

daylily-tapdb

daylily-tapdb is the shared persistence layer used by Bloom, Atlas, Dewey, and Ursa.

It provides:

  • a template-driven polymorphic object model
  • TapDB-managed database/bootstrap workflows
  • lineage and audit primitives
  • Meridian EUID-backed public identifiers
  • a Typer-based operational CLI
  • an optional FastAPI admin UI package

Repository Role

Use this repo when you need to:

  • bootstrap or reset a TapDB-backed environment
  • work with core template and instance models
  • embed or run the TapDB admin UI
  • validate namespace config, schema, data seeding, or Aurora support

Primary Python package: daylily_tapdb

Main CLI Surface

Entry command: tapdb

Primary groups:

  • tapdb bootstrap: one-command local or Aurora bootstrap
  • tapdb ui: admin UI start, stop, status, logs, mkcert
  • tapdb config: namespace config initialization and migration helpers
  • tapdb db: database, schema, data, and config validation commands
  • tapdb pg: local PostgreSQL service commands
  • tapdb user: TapDB admin/auth user management
  • tapdb cognito: Cognito/daycog integration helpers
  • tapdb aurora: Aurora cluster management when installed with .[aurora]

Data Model

The core operational tables are:

  • generic_template
  • generic_instance
  • generic_instance_lineage
  • audit_log
  • outbox_event

TapDB uses uid for internal joins and EUIDs for public-facing identity.

tenant_id is the logical isolation key on templates, instances, lineage, audit, and outbox rows.

Installation

Default install:

pip install daylily-tapdb

Common dev install:

python -m venv .venv
source .venv/bin/activate
pip install -U pip
pip install -e ".[admin,dev,cli]"

Optional convenience wrapper:

source tapdb_activate.sh

Release Versioning

Package versions are derived from Git tags via setuptools_scm.

  • An exact tagged commit builds the exact release version.
  • Commits after the latest tag build the next inferred version with a .devN suffix, where N is the commit count since that tag.
  • Local version metadata is disabled, so builds do not append Git hashes to the published version string.

Examples:

  • git describe = 0.2.5 -> build version 0.2.5
  • git describe = 0.2.5-2-g1774465 -> build version 0.2.6.dev2

For release artifacts, run git describe --tags --dirty --always before python -m build and build from the exact release tag. If HEAD includes additional commits that should be released, create a new tag on that commit first.

Quick Start

Initialize a strict namespace and bootstrap a local stack:

export TAPDB_CLIENT_ID=tapdb
export TAPDB_DATABASE_NAME=tapdb
export TAPDB_ENV=dev

tapdb config init --client-id "$TAPDB_CLIENT_ID" --database-name "$TAPDB_DATABASE_NAME" --env dev --db-port dev=5533 --ui-port dev=8911
tapdb bootstrap local

For local PostgreSQL, TAPDB now uses a namespaced user-writable Unix socket directory under ~/.config/tapdb/<client>/<database>/<env>/postgres/run by default, so tapdb pg start-local <env> does not depend on system paths such as /var/run/postgresql. You can override that path with environments.<env>.unix_socket_dir or TAPDB_<ENV>_UNIX_SOCKET_DIR when you need a custom local runtime location.

Admin UI

The admin UI is optional and ships with the admin extra.

Key modes:

  • native TapDB auth
  • shared host-app auth
  • auth-disabled local development

See the embedding guide for the current supported patterns.

Timezone Policy

  • persisted timestamps are UTC
  • user display timezone preference lives in TapDB-backed system_user preferences
  • canonical preference key: display_timezone

Current Docs

Historical execution plans and breaking-change notes remain in docs/ for background only.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

daylily_tapdb-3.0.3.tar.gz (240.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

daylily_tapdb-3.0.3-py3-none-any.whl (192.2 kB view details)

Uploaded Python 3

File details

Details for the file daylily_tapdb-3.0.3.tar.gz.

File metadata

  • Download URL: daylily_tapdb-3.0.3.tar.gz
  • Upload date:
  • Size: 240.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.2

File hashes

Hashes for daylily_tapdb-3.0.3.tar.gz
Algorithm Hash digest
SHA256 17b37a7fa8adbb12fcd759ea8eb3dc838006344c54744c78853aa035145b9cbf
MD5 878824e04f7befea00e619140533fd9b
BLAKE2b-256 30c23aa210eaf7037ec0fbf35fe4bb002ebe61da5b66f4d4eb1d4721630a16c7

See more details on using hashes here.

File details

Details for the file daylily_tapdb-3.0.3-py3-none-any.whl.

File metadata

  • Download URL: daylily_tapdb-3.0.3-py3-none-any.whl
  • Upload date:
  • Size: 192.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.2

File hashes

Hashes for daylily_tapdb-3.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 02e31b093e463ec6ab8d1bfe8ea24222a46210a28cb7257c3b9f2ffd4a941086
MD5 f929b974b19eaf4a23bb97319787c589
BLAKE2b-256 a353e59ffd3ad3eb3a4f375b041eabca27b76289dedd245f17e432e6604b4a9a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page