pgcraft 0.13.1

Configuration-driven PostgreSQL framework

pgcraft

Pre-alpha — pgcraft is under active development. APIs may change between releases. Feedback and contributions are welcome.

Configuration-driven PostgreSQL data schemas, migrations, and APIs.

pgcraft generates SQLAlchemy models and Alembic migrations from declarative dimension configurations. Define your schema once; pgcraft handles the rest. An optional PostgREST extension adds API views, roles, and grants.

---

Features

• Factories — Simple, Append-Only (SCD Type 2), Entity-Attribute-Value, and Ledger, each with generated backing tables, views, and triggers.
• Plugin architecture — Composable plugins with @requires / @produces decorators, executed in topological order.
• Automatic migrations — Alembic integration with SQL-formatted migration scripts via sqlglot.
• Extension system — Opt-in extensions for PostgREST API views, roles, and grants. Third-party extensions via entry points.
• Postgres is king — Logic lives in the database (views, triggers, check constraints). Python orchestrates; Postgres enforces.

Quick start

Install

pip install pgcraft            # or: uv add pgcraft

Define a dimension

from sqlalchemy import Column, MetaData, String
from pgcraft import PGCraftBase, construct_pgcraft_naming_conventions_dict

metadata = MetaData(naming_convention=construct_pgcraft_naming_conventions_dict())


class Base(PGCraftBase):
    metadata = metadata


class Users(Base):
    __tablename__ = "users"
    __table_args__ = {"schema": "public"}

    name = Column(String, nullable=False)
    email = Column(String)

This creates a public.users table with id, name, and email columns, with Alembic migration support out of the box.

Generate migrations

pgcraft migrate revision --autogenerate -m "add users"
pgcraft migrate upgrade head

Factories

pgcraft ships four built-in factories:

Factory	Use case	History?
Simple	Static reference data	No
Append-Only (SCD Type 2)	Track changes over time	Yes
EAV	Flexible / sparse attributes with full audit trail	Yes
Ledger	Append-only event streams, running balances, charts	Yes

See the factories documentation for ERD diagrams, schema details, and worked examples.

Documentation

Full documentation is available at roddarjohn.github.io/pgcraft.

• Setup & installation
• Factories
• Plugin system
• Extensions
• API reference
• Development guide
• Playground

Development

# Clone and install
git clone https://github.com/<username>/pgcraft.git
cd pgcraft
uv sync --all-groups

# Run checks
just lint          # ruff check + format
just type-check    # zuban check src/
just dev-test      # pytest (fast, needs DATABASE_URL)
just test          # tox (full isolation)
just docs          # build Sphinx HTML docs

Tests require a running PostgreSQL instance:

DATABASE_URL=postgresql+psycopg:///pgcraft just dev-test

Design philosophy

See PLAN.md for the full design philosophy. The short version:

• Explicit over implicit. No magic — if behavior is not obvious from reading the code, it needs a docstring explaining why.
• Simple over clever. Three similar lines are better than a premature abstraction.

License

See LICENSE for details.