belgie-alchemy 0.1.0__py3-none-any.whl → 0.2.0__py3-none-any.whl

belgie_alchemy/__init__.py

@@ -1,33 +1,7 @@
-"""SQLAlchemy 2.0 building blocks for database models.
-
-This module provides opinionated defaults and utilities for SQLAlchemy:
-- Base: Declarative base with dataclass mapping and sensible defaults
-- Mixins: PrimaryKeyMixin (UUID), TimestampMixin (created/updated/deleted)
-- Types: DateTimeUTC (timezone-aware datetime storage)
-
-Usage:
-    from belgie_alchemy import Base, PrimaryKeyMixin, TimestampMixin, DateTimeUTC
-
-    class MyModel(Base, PrimaryKeyMixin, TimestampMixin):
-        __tablename__ = "my_models"
-
-        name: Mapped[str]
-        created_on: Mapped[datetime] = mapped_column(DateTimeUTC)
-
-For complete auth model examples, see examples/alchemy/auth_models.py
-"""
-
 from belgie_alchemy.adapter import AlchemyAdapter
-from belgie_alchemy.base import Base
-from belgie_alchemy.mixins import PrimaryKeyMixin, TimestampMixin
 from belgie_alchemy.settings import DatabaseSettings
-from belgie_alchemy.types import DateTimeUTC
 
 __all__ = [
     "AlchemyAdapter",
-    "Base",
     "DatabaseSettings",
-    "DateTimeUTC",
-    "PrimaryKeyMixin",
-    "TimestampMixin",
 ]

{belgie_alchemy-0.1.0.dist-info → belgie_alchemy-0.2.0.dist-info}/METADATA

@@ -1,38 +1,43 @@
 Metadata-Version: 2.3
 Name: belgie-alchemy
-Version: 0.1.0
+Version: 0.2.0
 Summary: SQLAlchemy building blocks for Belgie
 Author: Matt LeMay
 Author-email: Matt LeMay <mplemay@users.noreply.github.com>
+Requires-Dist: aiosqlite>=0.22.1
 Requires-Dist: belgie-proto
+Requires-Dist: brussels>=0.2.0
 Requires-Dist: pydantic>=2.0
 Requires-Dist: pydantic-settings>=2.0
 Requires-Dist: sqlalchemy[asyncio]>=2.0
-Requires-Python: >=3.12
+Requires-Python: >=3.12, <3.15
 Description-Content-Type: text/markdown
 
 # belgie-alchemy
 
-SQLAlchemy 2.0 building blocks for database models.
+SQLAlchemy 2.0 utilities for Belgie.
 
 ## Overview
 
-`belgie-alchemy` provides opinionated defaults and utilities for SQLAlchemy:
+`belgie-alchemy` provides the `AlchemyAdapter` and database settings for Belgie.
+For SQLAlchemy building blocks (Base, mixins, types), use `brussels`:
 
 - **Base**: Declarative base with dataclass mapping and sensible defaults
 - **Mixins**: `PrimaryKeyMixin` (UUID), `TimestampMixin` (created/updated/deleted timestamps)
-- **Types**: `DateTimeUTC` (timezone-aware datetimes), `Scopes` (dialect-specific array/JSON storage)
+- **Types**: `DateTimeUTC` (timezone-aware datetimes), `Json` (dialect-specific JSON storage)
 
-This module provides **building blocks only** - you define your own models.
+The examples below use `brussels` directly so you can own your models.
 
 ## Quick Start
 
 ```python
 from datetime import datetime
-from belgie_alchemy import Base, PrimaryKeyMixin, TimestampMixin, DateTimeUTC
+from brussels.base import DataclassBase
+from brussels.mixins import PrimaryKeyMixin, TimestampMixin
+from brussels.types import DateTimeUTC
 from sqlalchemy.orm import Mapped, mapped_column
 
-class Article(Base, PrimaryKeyMixin, TimestampMixin):
+class Article(DataclassBase, PrimaryKeyMixin, TimestampMixin):
     __tablename__ = "articles"
 
     title: Mapped[str]
@@ -53,10 +58,10 @@ This gives you:
 Declarative base with dataclass mapping enabled:
 
 ```python
-from belgie_alchemy import Base
+from brussels.base import DataclassBase
 from sqlalchemy.orm import Mapped, mapped_column
 
-class MyModel(Base):
+class MyModel(DataclassBase):
     __tablename__ = "my_models"
 
     id: Mapped[int] = mapped_column(primary_key=True)
@@ -70,7 +75,7 @@ Features:
 
 - Consistent naming conventions for constraints
 - Automatic type annotation mapping (`datetime` → `DateTimeUTC`)
-- Dataclass mapping with `kw_only=True`, `repr=True`, `eq=True`
+- Dataclass mapping for convenient instantiation
 
 ### Mixins
 
@@ -79,9 +84,10 @@ Features:
 Adds a UUID primary key with server-side generation:
 
 ```python
-from belgie_alchemy import Base, PrimaryKeyMixin
+from brussels.base import DataclassBase
+from brussels.mixins import PrimaryKeyMixin
 
-class MyModel(Base, PrimaryKeyMixin):
+class MyModel(DataclassBase, PrimaryKeyMixin):
     __tablename__ = "my_models"
     # Automatically includes: id: Mapped[UUID]
 ```
@@ -98,9 +104,10 @@ The `id` field:
 Adds automatic timestamp tracking:
 
 ```python
-from belgie_alchemy import Base, TimestampMixin
+from brussels.base import DataclassBase
+from brussels.mixins import TimestampMixin
 
-class MyModel(Base, TimestampMixin):
+class MyModel(DataclassBase, TimestampMixin):
     __tablename__ = "my_models"
     # Automatically includes:
     # - created_at: Mapped[datetime]
@@ -123,10 +130,11 @@ Timezone-aware datetime storage:
 
 ```python
 from datetime import datetime
-from belgie_alchemy import Base, DateTimeUTC
+from brussels.base import DataclassBase
+from brussels.types import DateTimeUTC
 from sqlalchemy.orm import Mapped, mapped_column
 
-class Event(Base):
+class Event(DataclassBase):
     __tablename__ = "events"
 
     id: Mapped[int] = mapped_column(primary_key=True)
@@ -140,43 +148,43 @@ Features:
 - Always returns UTC-aware datetimes from database
 - Works with PostgreSQL, SQLite, MySQL
 
-#### Scopes
+#### Json
 
-Dialect-specific array storage for permission scopes:
+Dialect-specific JSON storage (JSONB on PostgreSQL):
 
 ```python
-from enum import StrEnum
-from belgie_alchemy import Base, Scopes
+from brussels.base import DataclassBase
+from brussels.types import Json
 from sqlalchemy.orm import Mapped, mapped_column
 
-class User(Base):
+class User(DataclassBase):
     __tablename__ = "users"
 
     id: Mapped[int] = mapped_column(primary_key=True)
-    # Option 1: Simple string array (works everywhere)
-    scopes: Mapped[list[str] | None] = mapped_column(Scopes, default=None)
+    # Store scopes as JSON (works everywhere)
+    scopes: Mapped[list[str] | None] = mapped_column(Json, default=None)
 ```
 
 Features:
 
-- PostgreSQL: Uses native `ARRAY(String)` type
-- SQLite/MySQL: Uses JSON storage
-- Automatically converts StrEnum values to strings
-- Handles `None` values correctly
+- PostgreSQL: Uses `JSONB`
+- SQLite/MySQL: Uses `JSON`
 
 For PostgreSQL with application-specific enum types, you can override:
 
 ```python
 from enum import StrEnum
+from brussels.base import DataclassBase
 from sqlalchemy import ARRAY
 from sqlalchemy.dialects.postgresql import ENUM
+from sqlalchemy.orm import Mapped, mapped_column
 
 class AppScope(StrEnum):
     READ = "resource:read"
     WRITE = "resource:write"
     ADMIN = "admin"
 
-class User(Base):
+class User(DataclassBase):
     __tablename__ = "users"
 
     id: Mapped[int] = mapped_column(primary_key=True)
@@ -203,16 +211,18 @@ Example structure:
 ```python
 from datetime import datetime
 from uuid import UUID
+from brussels.base import DataclassBase
+from brussels.mixins import PrimaryKeyMixin, TimestampMixin
+from brussels.types import DateTimeUTC, Json
 from sqlalchemy import ForeignKey
 from sqlalchemy.orm import Mapped, mapped_column, relationship
-from belgie_alchemy import Base, PrimaryKeyMixin, TimestampMixin, DateTimeUTC, Scopes
 
-class User(Base, PrimaryKeyMixin, TimestampMixin):
+class User(DataclassBase, PrimaryKeyMixin, TimestampMixin):
     __tablename__ = "users"
 
     email: Mapped[str] = mapped_column(unique=True, index=True)
     email_verified: Mapped[bool] = mapped_column(default=False)
-    scopes: Mapped[list[str] | None] = mapped_column(Scopes, default=None)
+    scopes: Mapped[list[str] | None] = mapped_column(Json, default=None)
 
     accounts: Mapped[list["Account"]] = relationship(
         back_populates="user",
@@ -220,7 +230,7 @@ class User(Base, PrimaryKeyMixin, TimestampMixin):
         init=False,
     )
 
-class Account(Base, PrimaryKeyMixin, TimestampMixin):
+class Account(DataclassBase, PrimaryKeyMixin, TimestampMixin):
     __tablename__ = "accounts"
 
     user_id: Mapped[UUID] = mapped_column(

belgie_alchemy-0.2.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+belgie_alchemy/__init__.py,sha256=Qkyc0eCsadaCn-AxJjAu4BI2x31xTNZ2QV0J9n0oVG4,164
+belgie_alchemy/adapter.py,sha256=30ePooceD1O40WpODfEycxc4KaOKx_71GiCJqqF1rRE,10305
+belgie_alchemy/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+belgie_alchemy/settings.py,sha256=0zK-GDEVzmI3efEceWGV7H3jieW63gqZHVJ4vgJVlMM,4991
+belgie_alchemy-0.2.0.dist-info/WHEEL,sha256=5DEXXimM34_d4Gx1AuF9ysMr1_maoEtGKjaILM3s4w4,80
+belgie_alchemy-0.2.0.dist-info/METADATA,sha256=g22uQIZflLHsp7qZX_SBmJlK6WjdRps9wrETPKp476Q,7387
+belgie_alchemy-0.2.0.dist-info/RECORD,,

{belgie_alchemy-0.1.0.dist-info → belgie_alchemy-0.2.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: uv 0.9.28
+Generator: uv 0.9.29
 Root-Is-Purelib: true
 Tag: py3-none-any