sqlcrucible 0.2.1__tar.gz → 0.2.2__tar.gz

{sqlcrucible-0.2.1 → sqlcrucible-0.2.2}/.github/workflows/docs.yml

@@ -5,13 +5,20 @@ on:
     tags: ["*"]
   workflow_dispatch:
     inputs:
+      action:
+        description: "Action to perform"
+        type: choice
+        options:
+          - deploy
+          - delete
+        default: deploy
       version:
-        description: "Version to deploy (e.g., 0.1.0)"
+        description: "Version to deploy or delete (e.g., 0.1.0, pr-123)"
         required: true
       latest:
-        description: "Update 'latest' alias"
+        description: "Update 'latest' alias (deploy only)"
         type: boolean
-        default: true
+        default: false
 
 permissions:
   contents: write
@@ -21,7 +28,7 @@ concurrency:
   cancel-in-progress: false
 
 jobs:
-  deploy:
+  docs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
@@ -36,16 +43,20 @@ jobs:
           git config user.name "github-actions[bot]"
           git config user.email "github-actions[bot]@users.noreply.github.com"
 
-      - name: Deploy docs
+      - name: Deploy or delete docs
         run: |
           if [ "${{ github.event_name }}" = "workflow_dispatch" ]; then
             VERSION="${{ github.event.inputs.version }}"
-            if [ "${{ github.event.inputs.latest }}" = "true" ]; then
+            if [ "${{ github.event.inputs.action }}" = "delete" ]; then
+              uv run --group docs mike delete --push "$VERSION"
+            elif [ "${{ github.event.inputs.latest }}" = "true" ]; then
               uv run --group docs mike deploy --push --update-aliases "$VERSION" latest
+              uv run --group docs mike set-default --push latest
             else
               uv run --group docs mike deploy --push "$VERSION"
             fi
           else
             VERSION="${GITHUB_REF#refs/tags/}"
             uv run --group docs mike deploy --push --update-aliases "$VERSION" latest
+            uv run --group docs mike set-default --push latest
           fi

sqlcrucible-0.2.2/PKG-INFO

@@ -0,0 +1,81 @@
+Metadata-Version: 2.4
+Name: sqlcrucible
+Version: 0.2.2
+Summary: Add your description here
+Author-email: Richard Rae-Jones <sqlcrucible@richard.rdrj.uk>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.11
+Requires-Dist: pydantic~=2.10
+Requires-Dist: sqlalchemy~=2.0
+Requires-Dist: typing-extensions~=4.15
+Description-Content-Type: text/markdown
+
+# SQLCrucible
+
+Get the full power of Pydantic for your API and the full power of SQLAlchemy for your database, without compromising on either.
+
+SQLCrucible lets you define a single model class that works as both a Pydantic model and a SQLAlchemy table, with explicit conversion between the two. Your Pydantic models stay pure Pydantic (working with FastAPI, validation, serialization), your SQLAlchemy models stay pure SQLAlchemy (supporting relationships, inheritance, Alembic), and conversion only happens when you ask for it.
+
+## Key Features
+
+- **Explicit conversion** — `to_sa_model()` and `from_sa_model()` make it clear when you're crossing the boundary between Pydantic and SQLAlchemy
+- **Native SQLAlchemy** — use `mapped_column()`, `relationship()`, and `__mapper_args__` directly; if SQLAlchemy supports it, so does SQLCrucible
+- **Escape hatches everywhere** — mix with plain SQLAlchemy models, attach entities to existing tables, customize generated models, or drop down to raw queries
+- **Full inheritance support** — single table, joined table, and concrete table inheritance all work out of the box
+- **Type stub generation** — generate `.pyi` stubs for IDE autocompletion and type checking of SQLAlchemy columns
+- **Multiple frameworks** — works with Pydantic, dataclasses, and attrs
+
+## Example
+
+```python
+from typing import Annotated
+from uuid import UUID, uuid4
+
+from pydantic import Field
+from sqlalchemy import create_engine, select
+from sqlalchemy.orm import Session, mapped_column
+
+from sqlcrucible import SAType, SQLCrucibleBaseModel
+
+class Artist(SQLCrucibleBaseModel):
+    __sqlalchemy_params__ = {"__tablename__": "artist"}
+
+    id: Annotated[UUID, mapped_column(primary_key=True)] = Field(default_factory=uuid4)
+    name: str
+
+engine = create_engine("sqlite:///:memory:")
+SAType[Artist].__table__.metadata.create_all(engine)
+
+artist = Artist(name="Bob Dylan")
+with Session(engine) as session:
+    session.add(artist.to_sa_model())
+    session.commit()
+
+with Session(engine) as session:
+    sa_artist = session.scalar(
+        select(SAType[Artist]).where(SAType[Artist].name == "Bob Dylan")
+    )
+    artist = Artist.from_sa_model(sa_artist)
+```
+
+## Installation
+
+```bash
+pip install sqlcrucible
+```
+
+## Documentation
+
+Full documentation is available at [sqlcrucible.rdrj.uk](https://sqlcrucible.rdrj.uk/).
+
+---
+
+<p align="center">
+  🏴󠁧󠁢󠁳󠁣󠁴󠁿 Made with haggis
+</p>

sqlcrucible-0.2.2/README.md

@@ -0,0 +1,63 @@
+# SQLCrucible
+
+Get the full power of Pydantic for your API and the full power of SQLAlchemy for your database, without compromising on either.
+
+SQLCrucible lets you define a single model class that works as both a Pydantic model and a SQLAlchemy table, with explicit conversion between the two. Your Pydantic models stay pure Pydantic (working with FastAPI, validation, serialization), your SQLAlchemy models stay pure SQLAlchemy (supporting relationships, inheritance, Alembic), and conversion only happens when you ask for it.
+
+## Key Features
+
+- **Explicit conversion** — `to_sa_model()` and `from_sa_model()` make it clear when you're crossing the boundary between Pydantic and SQLAlchemy
+- **Native SQLAlchemy** — use `mapped_column()`, `relationship()`, and `__mapper_args__` directly; if SQLAlchemy supports it, so does SQLCrucible
+- **Escape hatches everywhere** — mix with plain SQLAlchemy models, attach entities to existing tables, customize generated models, or drop down to raw queries
+- **Full inheritance support** — single table, joined table, and concrete table inheritance all work out of the box
+- **Type stub generation** — generate `.pyi` stubs for IDE autocompletion and type checking of SQLAlchemy columns
+- **Multiple frameworks** — works with Pydantic, dataclasses, and attrs
+
+## Example
+
+```python
+from typing import Annotated
+from uuid import UUID, uuid4
+
+from pydantic import Field
+from sqlalchemy import create_engine, select
+from sqlalchemy.orm import Session, mapped_column
+
+from sqlcrucible import SAType, SQLCrucibleBaseModel
+
+class Artist(SQLCrucibleBaseModel):
+    __sqlalchemy_params__ = {"__tablename__": "artist"}
+
+    id: Annotated[UUID, mapped_column(primary_key=True)] = Field(default_factory=uuid4)
+    name: str
+
+engine = create_engine("sqlite:///:memory:")
+SAType[Artist].__table__.metadata.create_all(engine)
+
+artist = Artist(name="Bob Dylan")
+with Session(engine) as session:
+    session.add(artist.to_sa_model())
+    session.commit()
+
+with Session(engine) as session:
+    sa_artist = session.scalar(
+        select(SAType[Artist]).where(SAType[Artist].name == "Bob Dylan")
+    )
+    artist = Artist.from_sa_model(sa_artist)
+```
+
+## Installation
+
+```bash
+pip install sqlcrucible
+```
+
+## Documentation
+
+Full documentation is available at [sqlcrucible.rdrj.uk](https://sqlcrucible.rdrj.uk/).
+
+---
+
+<p align="center">
+  🏴󠁧󠁢󠁳󠁣󠁴󠁿 Made with haggis
+</p>

{sqlcrucible-0.2.1 → sqlcrucible-0.2.2}/src/sqlcrucible/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '0.2.1'
-__version_tuple__ = version_tuple = (0, 2, 1)
+__version__ = version = '0.2.2'
+__version_tuple__ = version_tuple = (0, 2, 2)
 
 __commit_id__ = commit_id = None