Skip to main content

Per-module SQLModel Base, async session, standard mixins (Audit, SoftDelete, MultiTenant, Versioned) for simple_module

Project description

simple_module_db

Database layer for the simple_module framework. Provides a per-module Base, an async SQLAlchemy/SQLModel session, standard mixins, and an auto-commit-on-flush listener that removes manual session.commit() calls from service code.

Install

pip install simple_module_db

What it provides

  • create_module_base("<module_name>") — a module-scoped declarative Base. PostgreSQL maps it to its own schema; SQLite namespaces via table-name prefix.
  • Per-request async session (get_db) with an auto-commit-on-flush hook — after_flush commits if there are pending writes, rolls back otherwise.
  • Mixins in simple_module_db.mixins: AuditMixin (created_at/updated_at), SoftDeleteMixin (auto-filtered unless stmt.execution_options(include_deleted=True)), MultiTenantMixin, VersionedMixin.
  • DatabaseState container used by the framework to avoid global mutable state.

Usage

# modules/orders/orders/models.py
from simple_module_db import AuditMixin, SoftDeleteMixin, create_module_base
from sqlmodel import Field

Base = create_module_base("orders")


class Order(Base, AuditMixin, SoftDeleteMixin, table=True):
    id: int | None = Field(default=None, primary_key=True)
    customer_id: int = Field(index=True, foreign_key="users_user.id")
    total_cents: int

In a service:

from simple_module_db import get_db

async def create_order(session = Depends(get_db), ...):
    order = Order(customer_id=..., total_cents=...)
    session.add(order)
    await session.flush()   # assigns order.id; auto-commit happens after the request
    return order

Never call session.commit() — the framework handles it.

Depends on

  • simple_module_core, sqlalchemy[asyncio], sqlmodel, alembic, asyncpg, aiosqlite

License

MIT — see LICENSE.

Project details


Download files

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

Source Distribution

simple_module_db-0.0.15.tar.gz (22.1 kB view details)

Uploaded Source

Built Distribution

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

simple_module_db-0.0.15-py3-none-any.whl (16.5 kB view details)

Uploaded Python 3

File details

Details for the file simple_module_db-0.0.15.tar.gz.

File metadata

  • Download URL: simple_module_db-0.0.15.tar.gz
  • Upload date:
  • Size: 22.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for simple_module_db-0.0.15.tar.gz
Algorithm Hash digest
SHA256 5c55e48e020c3a074f035d74852698baeb1c4818137d51e63d953a153071eed6
MD5 b43b48ead659f983b07bc8f591525511
BLAKE2b-256 6332bfcf892b36ea55cfd26eb225f0863a768241d3b3ddb066c3adabe004c3f6

See more details on using hashes here.

Provenance

The following attestation bundles were made for simple_module_db-0.0.15.tar.gz:

Publisher: release.yml on antosubash/simple_module_python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file simple_module_db-0.0.15-py3-none-any.whl.

File metadata

File hashes

Hashes for simple_module_db-0.0.15-py3-none-any.whl
Algorithm Hash digest
SHA256 36da44f68098d416038e8e57af539ffbad9414d90b01139ac209f1dd9348bbe6
MD5 1316d89c95aea478bc2458e8a15689d2
BLAKE2b-256 05f0a512f1f4d58590e9f21c396078700104a7f15afe780c0c553da8b6e02862

See more details on using hashes here.

Provenance

The following attestation bundles were made for simple_module_db-0.0.15-py3-none-any.whl:

Publisher: release.yml on antosubash/simple_module_python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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