Skip to main content

tigrbl-orm

Tigrbl logo

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

PyPI version for tigrbl-orm Downloads for tigrbl-orm Discord community for tigrbl-orm Repository hits for tigrbl-orm README Apache 2.0 license Python versions 3.10 | 3.11 | 3.12 | 3.13 | 3.14 for tigrbl-orm Workspace group for tigrbl-orm

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(...) or Column(...) 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 tigrbl facade 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.

Support

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/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/97_tests/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.

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.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for tigrbl-orm 0.4.5
File Size Uploaded Provenance Actions
tigrbl_orm-0.4.5.tar.gz 29.4 kB Without provenance Details for tigrbl_orm-0.4.5.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for tigrbl-orm 0.4.5
File Interpreter ABI Platform Actions
tigrbl_orm-0.4.5-py3-none-any.whl Python 3 none any Details for tigrbl_orm-0.4.5-py3-none-any.whl

Total release size: 68.8 kB

Release files / tigrbl_orm-0.4.5.tar.gz

Download URL tigrbl_orm-0.4.5.tar.gz
Size 29.4 kB
Tags Source
SHA-256 checksum
How to use checksums
d38981f74617384edfe1807fe92797021426426794478fced095d7f3d3a753b9
BLAKE2b-256 checksum
How to use checksums
419e2124d47fbe94e2e6bb7fb3bc1e82c8046a9c8b355a0e7546b93eb9b1e406
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.7 {"installer":{"name":"uv","version":"0.13.7","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.5-py3-none-any.whl

Download URL tigrbl_orm-0.4.5-py3-none-any.whl
Size 39.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
6ba24c5ec15509017f6215f296561e2f10de5d44b4bbf596dc426e2cffd65dbd
BLAKE2b-256 checksum
How to use checksums
6bc827f4d6a88d7b2049929593810f9537354b089c60ff9d60eb6f0f6c4c45fd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.7 {"installer":{"name":"uv","version":"0.13.7","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.5

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.

Release history Release notifications | RSS feed

This release

0.4.5 This release

2 release files No provenance

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