tigrbl-orm 0.4.3.dev4

SQLAlchemy ORM tables, mixins, columns, model helpers, and persistence primitives for Tigrbl applications.

tigrbl-orm

SQLAlchemy ORM tables, mixins, columns, model helpers, and persistence primitives for Tigrbl applications.

What is tigrbl-orm?

SQLAlchemy ORM tables, mixins, columns, model helpers, and persistence primitives for Tigrbl applications.

Why use tigrbl-orm?

Use it when you need this foundational Tigrbl layer directly as a small, focused dependency.

When should I install tigrbl-orm?

Install it for extension packages, package-local tests, or internals that need this boundary without the whole facade.

Who is tigrbl-orm for?

Framework maintainers, extension authors, and advanced users composing Tigrbl from split packages.

Where does tigrbl-orm fit?

tigrbl-orm lives at pkgs/core/tigrbl_orm and serves a focused layer in the split Tigrbl framework.

How does tigrbl-orm work?

It owns a narrow layer in the split workspace and is consumed by higher-level packages through explicit dependencies.

Certification Status

• Package status: governed package in the tigrbl/tigrbl workspace.
• Governance source: SSOT registry.
• Release evidence: publish workflow validates package builds, tests, GitHub release assets, and PyPI publication for managed packages.
• Local certification guard: pkgs/core/tigrbl_tests/tests/unit/test_package_badges_and_notices.py verifies every package README keeps the Discord badge, Apache 2.0 badge, explicit Python-version badge, LICENSE, and NOTICE.
• Scope note: this README documents the package boundary. Runtime feature support remains governed by .ssot/ entities and the conformance docs linked below.

Install

uv add tigrbl-orm

pip install tigrbl-orm

Surface Coverage

Surface	Value
PyPI package	tigrbl-orm
Repository path	pkgs/core/tigrbl_orm
Python import root	tigrbl_orm
Console scripts	none declared
Entry points	none declared
Optional extras	none declared
Legal files	LICENSE, NOTICE
Supported Python	`3.10

What It Owns

tigrbl-orm owns the foundational framework package boundary. It should be installed when you need this package's focused responsibility without assuming every other Tigrbl workspace package is present.

Implementation orientation:

• tigrbl_orm: orm/

Public API and Import Surface

• Import roots: tigrbl_orm.
• Public symbols: public surface is module-oriented; import the package boundary and inspect submodules as needed.
• Workspace dependencies: none declared.
• External runtime dependencies: sqlalchemy>=2.0.

Usage Examples

Verify the installed package

python -m pip show tigrbl-orm
python - <<'PY'
from importlib.metadata import version
print(version("tigrbl-orm"))
PY

Import the package boundary

import importlib

module = importlib.import_module("tigrbl_orm.orm")
print(module.__name__)

Inspect available modules

import importlib
import pkgutil

module = importlib.import_module("tigrbl_orm.orm")
for info in pkgutil.iter_modules(getattr(module, "__path__", [])):
    print(info.name)

Use with the facade when building applications

uv add tigrbl tigrbl-orm
python - <<'PY'
import tigrbl
print(tigrbl.__name__)
PY

How To Choose This Package

Choose tigrbl-orm when the quick-answer table matches your use case. Choose tigrbl instead when you want the full public facade. Choose a lower-level package such as tigrbl-core, tigrbl-base, or tigrbl-runtime when you are building framework extensions or testing a specific internal boundary.

Authoring BCP

tigrbl-orm is the SQLAlchemy-facing implementation boundary for Tigrbl table and persistence helpers. Normal application documentation should still lead with the tigrbl facade, Tigrbl table/column helpers, and Tigrbl specs.

Do:

• Do use this package when implementing or testing ORM helpers, table mixins, persistence primitives, and SQLAlchemy-facing compatibility behavior.
• Do keep ORM behavior aligned with Tigrbl table, column, datatype, storage, IO, and operation specs.
• Do let Tigrbl specs describe reusable field and operation intent before ORM materialization.

Do not:

• Do not present raw SQLAlchemy mapped_column(...) or Column(...) as the preferred application authoring surface when Tigrbl column helpers or specs can express the behavior.
• Do not put application route authoring, FastAPI/Starlette route objects, ad-hoc engine construction in handlers, or direct transaction control in this package's public examples.
• Do not treat SQLAlchemy tables as the only source of truth for schema, docs, runtime, hooks, and diagnostics.

Avoid:

• Avoid duplicating field behavior across ORM declarations and Tigrbl specs. Keep the spec layer authoritative for behavior that must project into storage, validation, runtime, and docs.
• Avoid exposing implementation-only ORM helpers as facade-level guidance unless the package boundary is explicit.

Related Packages

• tigrbl
• tigrbl-core
• tigrbl-base
• tigrbl-runtime

Documentation Links

• Workspace docs
• Package catalog
• Package layout
• Current target
• Current state
• SSOT registry
• Release workflow

Support

• Community: Discord.
• Issues: GitHub Issues.
• Repository: pkgs/core/tigrbl_orm.

Package-local Boundary

This README is the package-local distribution entry point for tigrbl-orm. It answers install, usage, API, ownership, and certification-orientation questions for this package. Broader architectural decisions, release status, and cross-package proof chains remain in the repository-level docs and SSOT registry.

License

Licensed under the Apache License, Version 2.0. See LICENSE, NOTICE, and the official Apache 2.0 license text.