Skip to main content

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 with its own MetaData. All modules share the host's single schema, so __tablename__ should be prefixed with the module name (e.g. users_user) to avoid collisions.
  • 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.

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.27.tar.gz (25.7 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.27-py3-none-any.whl (19.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: simple_module_db-0.0.27.tar.gz
  • Upload date:
  • Size: 25.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for simple_module_db-0.0.27.tar.gz
Algorithm Hash digest
SHA256 2756927281c34116615d9e01a8c184196e1d5f7eb0ee11a956d77681d5db369a
MD5 0d635bb44617eaf0000a1be1cc49e99c
BLAKE2b-256 bc880efc32ded61712295622ef41205822280fad903d7b791f3ddb8ad887f04b

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for simple_module_db-0.0.27-py3-none-any.whl
Algorithm Hash digest
SHA256 ef89e901e38804bf4a2a87ea166e7121ca0c336e743b583a43568749a0f5547f
MD5 10ac74c284d8925e6fd87e4aa35be89a
BLAKE2b-256 2bcdc04bfde99838e402c7f4a164e42fa369e322074836212222c6d14c03f386

See more details on using hashes here.

Provenance

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

Release history Release notifications | RSS feed

0.0.33

2 files

0.0.32

2 files

0.0.31

2 files

0.0.30

2 files

0.0.29

2 files

0.0.28

2 files

This release

0.0.27 This release

2 files

0.0.26

2 files

0.0.25

2 files

0.0.24

2 files

0.0.23

2 files

0.0.22

2 files

0.0.21

2 files

0.0.20

2 files

0.0.19

2 files

0.0.18

2 files

0.0.17

2 files

0.0.16

2 files

0.0.15

2 files

0.0.14

2 files

0.0.13

2 files

0.0.12

2 files

0.0.11

2 files

0.0.10

2 files

0.0.9

2 files

0.0.8

2 files

0.0.7

2 files

0.0.6

2 files

0.0.5

2 files

0.0.4

2 files

0.0.3

2 files

0.0.2

2 files

0.0.1

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page