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.10.tar.gz (17.4 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.10-py3-none-any.whl (15.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: simple_module_db-0.0.10.tar.gz
  • Upload date:
  • Size: 17.4 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.10.tar.gz
Algorithm Hash digest
SHA256 6b7adbf64b3a5e93823a1a571207801807f5a7a804b3166b6f6b2a1c54954038
MD5 62211335c0e45ce1300d6ce25e746e62
BLAKE2b-256 a8c95675bb24c7facc900f32d969ba5bca01a81b654de57cbe6933986fce2b27

See more details on using hashes here.

Provenance

The following attestation bundles were made for simple_module_db-0.0.10.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.10-py3-none-any.whl.

File metadata

File hashes

Hashes for simple_module_db-0.0.10-py3-none-any.whl
Algorithm Hash digest
SHA256 a00afcc64ca68626dbf6d871e065c0941123b7221f3a4de8072848b9c0d04392
MD5 6da31ac4584d4a435f96ea801b1c6340
BLAKE2b-256 c6ac011ea6fadbe7985b8ffabef4989eeac14fc31b5c26241510f95a51ae68d6

See more details on using hashes here.

Provenance

The following attestation bundles were made for simple_module_db-0.0.10-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