This release is a pre-release and may not be stable for production use.
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/30_orm/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.
Install
uv add tigrbl-orm
pip install tigrbl-orm
Surface Coverage
| Surface | Value |
|---|---|
| PyPI package | tigrbl-orm |
| Repository path | pkgs/30_orm/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.
Convenient Authoring Path and Best Current Practice (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.
Keep ORM usage boundary-owned
- Avoid: Exposing implementation-only ORM helpers as facade-level guidance unless the package boundary is explicit.
- Do: Use this package when implementing or testing ORM helpers, table mixins, persistence primitives, and SQLAlchemy-facing compatibility behavior.
- Why: SQLAlchemy is useful inside the storage boundary, while application users still get the more convenient Tigrbl facade contract.
Keep specs authoritative before ORM materialization
- Avoid: Duplicating field behavior across ORM declarations and Tigrbl specs.
- Do: Keep ORM behavior aligned with Tigrbl table, column, datatype, storage, IO, and operation specs.
- Why: The spec layer is the reusable source for behavior that must project into storage, validation, runtime, hooks, diagnostics, and docs.
Do not teach raw ORM declarations as application style
- Do not: Present raw SQLAlchemy
mapped_column(...)orColumn(...)as the preferred application authoring surface when Tigrbl column helpers or specs can express the behavior. - Do: Let Tigrbl specs describe reusable field and operation intent before ORM materialization.
- Why: Raw ORM declarations are only one lowering target and cannot carry the full Tigrbl storage, IO, validation, docs, hook, and runtime contract.
Do not move application behavior into this boundary
- 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: Keep application-facing examples on the
tigrblfacade and keep this README focused on the ORM implementation boundary. - Why: This keeps routes, engines, transactions, schemas, hooks, diagnostics, and runtime planning owned by the packages that govern those behaviors.
Related Packages
Documentation Links
Support
- Community: Discord.
- Issues: GitHub Issues.
- Repository: pkgs/30_orm/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.
Certification Status
- Package status: governed package in the
tigrbl/tigrblworkspace. - 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/97_tests/tigrbl_tests/tests/unit/test_package_badges_and_notices.pyverifies every package README keeps the Discord badge, Apache 2.0 badge, explicit Python-version badge,LICENSE, andNOTICE. - Scope note: this README documents the package boundary. Runtime feature support remains governed by
.ssot/entities and the conformance docs linked below.
License
Licensed under the Apache License, Version 2.0. See LICENSE, NOTICE, and the official Apache 2.0 license text.
Metadata
Release files for tigrbl-orm 0.4.6.dev1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| tigrbl_orm-0.4.6.dev1.tar.gz | 29.9 kB | Without provenance | Details for tigrbl_orm-0.4.6.dev1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| tigrbl_orm-0.4.6.dev1-py3-none-any.whl | Python 3 | none | any | Details for tigrbl_orm-0.4.6.dev1-py3-none-any.whl |
Total release size: 70.4 kB
Release files / tigrbl_orm-0.4.6.dev1.tar.gz
| Download URL | tigrbl_orm-0.4.6.dev1.tar.gz |
|---|---|
| Size | 29.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a4d0fa20ad8caad954ffa82e7c7d0d854be15baab2cd92e0fc06ea0b3603e0dc
|
|
BLAKE2b-256 checksum How to use checksums |
cdf4b81714a2b70d29946fbb32871fa3e592b041d19b8f20926cf0ac641025e3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.13.8 {"installer":{"name":"uv","version":"0.13.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / tigrbl_orm-0.4.6.dev1-py3-none-any.whl
| Download URL | tigrbl_orm-0.4.6.dev1-py3-none-any.whl |
|---|---|
| Size | 40.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f68978ba5b6c9865a75b5a89a33d069cb31da81609e16de83804a6c731e0dbbc
|
|
BLAKE2b-256 checksum How to use checksums |
9ade3fb6a3325397924f8cc9cf98bd20dc132e2566a2e4d6b8574aea3ec31cc0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.13.8 {"installer":{"name":"uv","version":"0.13.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Security for tigrbl-orm 0.4.6.dev1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.