tigrbl-orm 0.4.2.dev4__py3-none-any.whl → 0.4.3__py3-none-any.whl

{tigrbl_orm-0.4.2.dev4.dist-info → tigrbl_orm-0.4.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tigrbl-orm
-Version: 0.4.2.dev4
+Version: 0.4.3
 Summary: SQLAlchemy ORM tables, mixins, columns, model helpers, and persistence primitives for Tigrbl applications.
 License: Apache License
                                     Version 2.0, January 2004
@@ -361,6 +361,24 @@ PY
 
 Choose `tigrbl-orm` when the quick-answer table matches your use case. Choose [`tigrbl`](https://pypi.org/project/tigrbl/) instead when you want the full public facade. Choose a lower-level package such as [`tigrbl-core`](https://pypi.org/project/tigrbl-core/), [`tigrbl-base`](https://pypi.org/project/tigrbl-base/), or [`tigrbl-runtime`](https://pypi.org/project/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`](https://pypi.org/project/tigrbl/)

{tigrbl_orm-0.4.2.dev4.dist-info → tigrbl_orm-0.4.3.dist-info}/RECORD

@@ -26,8 +26,8 @@ tigrbl_orm/orm/tables/rbac.py,sha256=zv8XBC2vrQLqxjN3ilA7TyCNJnnBp6jlQs1yqylw0qs
 tigrbl_orm/orm/tables/status.py,sha256=eYY_13BJScrZN2VK6s_QG0Jlk0vrysKbINVR28GfklE,3596
 tigrbl_orm/orm/tables/tenant.py,sha256=yTDrGktHqp7EE3dtE959SAqKOY6guNUbt-H__FQvmIM,460
 tigrbl_orm/orm/tables/user.py,sha256=ROdfbnF4Nta96pY__sir-2CpSoGJp_YappmyDYJ_Nso,807
-tigrbl_orm-0.4.2.dev4.dist-info/METADATA,sha256=VYLtDGhHXg4ErYfaqij7Uu4cJUqT4ldJm5KqsHCEmMw,21849
-tigrbl_orm-0.4.2.dev4.dist-info/WHEEL,sha256=eY7nduwzv-ldUxpzbRlxwvC693Hg6PX8bWDjEHjZ_dk,88
-tigrbl_orm-0.4.2.dev4.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-tigrbl_orm-0.4.2.dev4.dist-info/licenses/NOTICE,sha256=EvJMTshzsWz43LiK-DeN2ZuLtrP49cxvlrFlJ8F_buc,221
-tigrbl_orm-0.4.2.dev4.dist-info/RECORD,,
+tigrbl_orm-0.4.3.dist-info/METADATA,sha256=H96HRkKCTawdRi4-BfaJxubcuE8FTxZJ-TMtwepd6Cs,23231
+tigrbl_orm-0.4.3.dist-info/WHEEL,sha256=eY7nduwzv-ldUxpzbRlxwvC693Hg6PX8bWDjEHjZ_dk,88
+tigrbl_orm-0.4.3.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+tigrbl_orm-0.4.3.dist-info/licenses/NOTICE,sha256=EvJMTshzsWz43LiK-DeN2ZuLtrP49cxvlrFlJ8F_buc,221
+tigrbl_orm-0.4.3.dist-info/RECORD,,