tigrbl-orm 0.1.0__py3-none-any.whl

tigrbl_orm/orm/tables/rbac.py

@@ -0,0 +1,76 @@
+from uuid import UUID
+
+
+from tigrbl.specs import IO, F, acol, S
+from tigrbl._spec.storage_spec import ForeignKeySpec
+from tigrbl.types import Integer, String, PgUUID, Mapped
+
+from . import TableBase
+from ..mixins import (
+    GUIDPk,
+    TenantBound,
+    RelationEdge,
+    Timestamped,
+    MaskableEdge,
+)
+
+
+# ───────── RBAC core ──────────────────────────────────────────────────
+class Role(TableBase, GUIDPk, Timestamped, TenantBound):
+    __tablename__ = "roles"
+    slug: Mapped[str] = acol(
+        storage=S(String, unique=True),
+        field=F(),
+        io=IO(),
+    )
+    global_mask: Mapped[int] = acol(
+        storage=S(Integer, default=0),
+        field=F(),
+        io=IO(),
+    )
+
+
+class RolePerm(TableBase, GUIDPk, Timestamped, TenantBound, RelationEdge, MaskableEdge):
+    __tablename__ = "role_perms"
+    role_id: Mapped[UUID] = acol(
+        storage=S(PgUUID, fk=ForeignKeySpec("roles.id")),
+        field=F(),
+        io=IO(),
+    )
+    target_table: Mapped[str] = acol(
+        storage=S(String),
+        field=F(),
+        io=IO(),
+    )
+    target_id: Mapped[str] = acol(
+        storage=S(String),
+        field=F(),
+        io=IO(),
+    )  # row or sentinel
+
+
+class RoleGrant(TableBase, GUIDPk, Timestamped, TenantBound, RelationEdge):
+    __tablename__ = "role_grants"
+    principal_id: Mapped[UUID] = acol(
+        storage=S(PgUUID),
+        field=F(),
+        io=IO(),
+    )  # FK to principal row
+    role_id: Mapped[UUID] = acol(
+        storage=S(PgUUID, fk=ForeignKeySpec("roles.id")),
+        field=F(),
+        io=IO(),
+    )
+
+
+__all__ = ["Role", "RolePerm", "RoleGrant"]
+
+for _name in list(globals()):
+    if _name not in __all__ and not _name.startswith("__"):
+        del globals()[_name]
+
+
+def __dir__():
+    """Tighten ``dir()`` output for interactive sessions."""
+
+    return sorted(__all__)

tigrbl_orm/orm/tables/status.py

@@ -0,0 +1,106 @@
+"""
+StatusEnum table
+----------------
+Canonical store of workflow / lifecycle states.
+
+• The `Status` enum below should always be the **only** source of truth for
+  allowed values.  Every place in the codebase ‒ mix-ins, business logic,
+  RPC schemas, etc. ‒ should import it instead of hard-coding strings.
+• Domain tables that need a status field should `ForeignKey` to
+  `status_enums.code` **or** just declare a `Column(SAEnum(Status, …))`
+  if the FK is unnecessary.
+
+If you add/remove a state later, just edit the `Status` enum – the rest
+keeps working.
+"""
+
+from __future__ import annotations
+
+from enum import StrEnum
+
+from tigrbl.specs import acol, F, IO, S
+from tigrbl.types import Integer, Mapped, SAEnum, String
+
+from ._base import TableBase
+from ..mixins import Timestamped  # created_at / updated_at
+
+
+# ────────────────────────────────────────────────────────────────────────
+# 1. In-memory application enum  (single source of truth)
+# ────────────────────────────────────────────────────────────────────────
+class Status(StrEnum):
+    # queued / dispatching
+    QUEUED = "queued"
+    WAITING = "waiting"
+    INPUT_REQUIRED = "input_required"
+    AUTH_REQUIRED = "auth_required"
+
+    # approvals
+    APPROVED = "approved"
+    REJECTED = "rejected"
+
+    # execution lifecycle
+    DISPATCHED = "dispatched"
+    RUNNING = "running"
+    PAUSED = "paused"
+
+    # final states
+    SUCCESS = "success"
+    FAILED = "failed"
+    CANCELLED = "cancelled"
+
+    # (legacy / generic)
+    PENDING = "pending"  # optional catch-all
+    ACTIVE = "active"
+    SUSPENDED = "suspended"
+    DISABLED = "disabled"
+    DELETED = "deleted"
+
+
+# ────────────────────────────────────────────────────────────────────────
+# 2. Persistent lookup table
+# ────────────────────────────────────────────────────────────────────────
+class StatusEnum(TableBase, Timestamped):
+    """
+    id       – surrogate PK (easy FK if needed elsewhere)
+    code     – canonical string value from the Status enum
+    label    – human-readable label (“Paused”, “Failed”, …)
+    """
+
+    __tablename__ = "status_enums"
+
+    id: Mapped[int] = acol(
+        storage=S(Integer, primary_key=True, autoincrement=True),
+        field=F(),
+        io=IO(out_verbs=("read", "list")),
+    )
+    code: Mapped[Status] = acol(
+        storage=S(
+            SAEnum(Status, name="status_code_enum"),
+            nullable=False,
+            unique=True,
+        ),
+        field=F(py_type=Status),
+        io=IO(out_verbs=("read", "list")),
+    )
+    label: Mapped[str] = acol(
+        storage=S(String, nullable=False),
+        field=F(),
+        io=IO(out_verbs=("read", "list")),
+    )
+
+    def __repr__(self) -> str:  # noqa: D401
+        return f"<StatusEnum {self.code}>"
+
+
+__all__ = ["Status", "StatusEnum"]
+
+for _name in list(globals()):
+    if _name not in __all__ and not _name.startswith("__"):
+        del globals()[_name]
+
+
+def __dir__():
+    """Tighten ``dir()`` output for interactive sessions."""
+
+    return sorted(__all__)

tigrbl_orm/orm/tables/tenant.py

@@ -0,0 +1,22 @@
+"""Tenant model."""
+
+from ._base import TableBase
+from ..mixins import GUIDPk, Slugged, Timestamped
+
+
+class Tenant(TableBase, GUIDPk, Slugged, Timestamped):
+    __tablename__ = "tenants"
+    __abstract__ = True
+
+
+__all__ = ["Tenant"]
+
+
+for _name in list(globals()):
+    if _name not in __all__ and not _name.startswith("__"):
+        del globals()[_name]
+
+
+def __dir__():
+    """Tighten ``dir()`` output for interactive sessions."""
+    return sorted(__all__)

tigrbl_orm/orm/tables/user.py

@@ -0,0 +1,39 @@
+"""User model."""
+
+from ._base import TableBase
+from ..mixins import (
+    GUIDPk,
+    Timestamped,
+    TenantBound,
+    Principal,
+    AsyncCapable,
+    ActiveToggle,
+)
+from tigrbl.specs import IO, acol, F, S
+from tigrbl.types import Mapped, String
+
+
+class User(
+    TableBase, GUIDPk, Timestamped, TenantBound, Principal, AsyncCapable, ActiveToggle
+):
+    __tablename__ = "users"
+    __abstract__ = True
+    username: Mapped[str] = acol(
+        storage=S(String(32), nullable=False),
+        field=F(constraints={"max_length": 32}),
+        io=IO(),
+    )
+
+
+__all__ = ["User"]
+
+
+for _name in list(globals()):
+    if _name not in __all__ and not _name.startswith("__"):
+        del globals()[_name]
+
+
+def __dir__():
+    """Tighten ``dir()`` output for interactive sessions."""
+
+    return sorted(__all__)

tigrbl_orm-0.1.0.dist-info/METADATA

@@ -0,0 +1,56 @@
+Metadata-Version: 2.4
+Name: tigrbl-orm
+Version: 0.1.0
+Summary: ORM tables and mixins for the Tigrbl framework.
+License-Expression: Apache-2.0
+Keywords: tigrbl,orm,sqlalchemy,sdk,standards
+Author: Jacob Stewart
+Author-email: jacob@swarmauri.com
+Requires-Python: >=3.10,<3.13
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Development Status :: 1 - Planning
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Requires-Dist: sqlalchemy (>=2.0)
+Description-Content-Type: text/markdown
+
+![Tigrbl branding](https://github.com/swarmauri/swarmauri-sdk/blob/a170683ecda8ca1c4f912c966d4499649ffb8224/assets/tigrbl.brand.theme.svg)
+
+# tigrbl-orm
+
+![PyPI - Downloads](https://img.shields.io/pypi/dm/tigrbl-orm.svg) ![Hits](https://hits.sh/github.com/swarmauri/swarmauri-sdk.svg) ![Python Versions](https://img.shields.io/pypi/pyversions/tigrbl-orm.svg) ![License](https://img.shields.io/pypi/l/tigrbl-orm.svg) ![Version](https://img.shields.io/pypi/v/tigrbl-orm.svg)
+
+## Features
+
+- Provides the `tigrbl_orm.orm` module as a standalone package.
+- Includes reusable ORM mixins and table models for Tigrbl services.
+- Supports Python 3.10 through 3.12.
+
+## Installation
+
+### uv
+
+```bash
+uv add tigrbl-orm
+```
+
+### pip
+
+```bash
+pip install tigrbl-orm
+```
+
+## Usage
+
+```python
+from tigrbl_orm.orm.tables.user import User
+
+print(User.__tablename__)
+```
+
+Install this package alongside other Tigrbl components when you need SQLAlchemy-backed models.
+

tigrbl_orm-0.1.0.dist-info/RECORD

@@ -0,0 +1,31 @@
+tigrbl_orm/orm/__init__.py,sha256=oQVk8swfAop9oNNC-WVf0_OdAmXRf7EjqIQfW7w_fLA,61
+tigrbl_orm/orm/mixins/_RowBound.py,sha256=ORIMeEzD5zPRuI3QY010cMlvkDUIyiEIkBcqpaa8aKU,3058
+tigrbl_orm/orm/mixins/__init__.py,sha256=X1qWzDcr_wSNNOo7JJ_hpHGR_tO1HsqDF7vHh6N-xNs,1914
+tigrbl_orm/orm/mixins/bootstrappable.py,sha256=4lWg5n1j4TV7u-J_aMQj3ZIFqILMS2eU-DpcgkFjOJI,3881
+tigrbl_orm/orm/mixins/bound.py,sha256=VcNM8r4Gr1MpK1SMdHnWKEoKpBX--HBZOv4wSIrhnDM,1348
+tigrbl_orm/orm/mixins/edges.py,sha256=7D0hK5slbvs6r4kLB5ZvBqWjDTBcDS7yYnM9gj4KBlc,862
+tigrbl_orm/orm/mixins/fields.py,sha256=SfYi5X_f5glpmFKwKQwVQfbeksOMsLp01KLNJp641CY,3665
+tigrbl_orm/orm/mixins/hierarchy.py,sha256=Rsxo1gNkz5jhnEdXv4a2rDoxFr3lLWIx5WT3a_5qNzw,1423
+tigrbl_orm/orm/mixins/key_digest.py,sha256=B-UXJSTJ63OS9fNTpUAicJAMtQudoNARuMqh-jYVAeE,1405
+tigrbl_orm/orm/mixins/lifecycle.py,sha256=zadPKAslUNwnUsKvB3Fw2RhQg4crvw9wDbm7XwJ3VVM,2623
+tigrbl_orm/orm/mixins/locks.py,sha256=Z4k5WuE-wiyV6CxPuczfOT84vqgZzYc0vieUUX7BxsI,1274
+tigrbl_orm/orm/mixins/markers.py,sha256=EVeAPXw6h6m9HtMrtrkCz_uxug5cdP7za_AFSmKOWnc,214
+tigrbl_orm/orm/mixins/operations.py,sha256=8pYhuiLtkrb81WREzp6VzXYq7KwEP4FXrtBKt4zNJtA,1843
+tigrbl_orm/orm/mixins/ownable.py,sha256=4enszRMvgpWwzEJSPVhDpQIfQ06kXY6CJG2mgQ9Iwfg,11328
+tigrbl_orm/orm/mixins/principals.py,sha256=JdX6s0HtVLoN87XBln4ML2qLjKc9T2a-637A4U6jrvk,2758
+tigrbl_orm/orm/mixins/tenant_bound.py,sha256=2i0Da-wD07-ELcaXl68pv-e4JLV-CvHik_tnrDbF-uk,10119
+tigrbl_orm/orm/mixins/upsertable.py,sha256=_fj006p2d5Qz6-8T88Yq3SQJiRYFSC0W_m0XN9FmMjc,4010
+tigrbl_orm/orm/mixins/utils.py,sha256=B8ZvAh55ng8B6fz72XyC3oBbBDkynyt8jnWyXzchiw4,1265
+tigrbl_orm/orm/tables/__init__.py,sha256=OtKDm6V5je8DJ6M-9Xq_rZUSBm0l5fpFo9JKO6a1Boo,1972
+tigrbl_orm/orm/tables/_base.py,sha256=tYNTG35sQ-4HQBJXfCm98ZSNL9BDTU-Cu8iYvSau5wM,163
+tigrbl_orm/orm/tables/audit.py,sha256=5hVeFUQQ7pw0NzZcf5Mz1yzZKNdAf5xYVfr0sq1CAQo,1434
+tigrbl_orm/orm/tables/client.py,sha256=AX32IzOXRr-geuJuZ2jnoGdUdqjOJMidUhGC5mPtytk,779
+tigrbl_orm/orm/tables/group.py,sha256=7EntqyXlTiJB9-OQeCikhltycDvD4BRcg1ZmoAxbeGA,642
+tigrbl_orm/orm/tables/org.py,sha256=WY9dg15Zs-UZL2R6XR0D9dpafc1IHY-nBYAXdSAWTfY,658
+tigrbl_orm/orm/tables/rbac.py,sha256=zv8XBC2vrQLqxjN3ilA7TyCNJnnBp6jlQs1yqylw0qs,1951
+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.1.0.dist-info/METADATA,sha256=EBEzHX_Xg9VEQDbJnU0cHtC3RGd6RCoFsvMHPb3bugk,1710
+tigrbl_orm-0.1.0.dist-info/WHEEL,sha256=kJCRJT_g0adfAJzTx2GUMmS80rTJIVHRCfG0DQgLq3o,88
+tigrbl_orm-0.1.0.dist-info/RECORD,,

tigrbl_orm-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 2.3.1
+Root-Is-Purelib: true
+Tag: py3-none-any