sqlakit 0.3.0__tar.gz → 0.3.1__tar.gz

{sqlakit-0.3.0 → sqlakit-0.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sqlakit
-Version: 0.3.0
+Version: 0.3.1
 Summary: A toolkit for SQLAlchemy applications.
 Keywords: sqlalchemy,database,orm,sql,asyncio
 Author: Anton Ruhlov
@@ -185,44 +185,6 @@ feed.next_cursor
 feed.previous_cursor
 ```
 
-## Active Record
-
-An instance saves and deletes itself, and the query is available on the class:
-
-```python
-from sqlalchemy.orm import Mapped, mapped_column
-
-from sqlakit import Database
-from sqlakit.orm import Model
-
-db = Database("postgresql+psycopg://localhost/app")
-
-
-class Note(Model):
-    __tablename__ = "notes"
-
-    id: Mapped[int] = mapped_column(primary_key=True)
-    text: Mapped[str]
-
-
-Note.set_db(db)
-
-with db.transaction():
-    note = Note(text="ada")
-    note.save()
-
-    Note.query.where(Note.text == "ada").all()
-    note.delete()
-```
-
-`set_db()` binds a model to a database. Call it on a base class and every model
-under it inherits the binding. With the global `db` from the section below you
-don't need it at all: the model uses the global registry automatically.
-
-This layer is optional. Everything else works on plain `SQLAlchemy` models, so
-if saving belongs in your repositories or services, skip `sqlakit.orm`
-entirely.
-
 ## Testing
 
 A test runs inside a transaction that rolls back at the end, so nothing the
@@ -328,6 +290,42 @@ with db.using("replica").connect():
     list_users()  # the models read the replica
 ```
 
+## Active Record
+
+An instance saves and deletes itself, and the query is available on the class.
+A model on the registry needs no wiring of its own:
+
+```python
+from sqlalchemy.orm import Mapped, mapped_column
+
+from sqlakit import db
+from sqlakit.orm import Model
+
+
+class Note(Model):
+    __tablename__ = "notes"
+
+    id: Mapped[int] = mapped_column(primary_key=True)
+    text: Mapped[str]
+
+
+with db.transaction():
+    note = Note(text="ada").save()
+
+    Note.query.where(Note.text == "ada").all()
+    note.delete()
+```
+
+A model that belongs on another database in the registry names its alias with
+`__db__ = "warehouse"`. With a `Database` of your own, `set_db()` binds the
+model to it. Either goes on a base class, and every model under it inherits
+the binding.
+
+This layer is optional. Everything else works on plain `SQLAlchemy` models, so
+if saving belongs in your repositories or services, skip `sqlakit.orm`
+entirely. `SQLModel` classes are `SQLAlchemy` models, and work either way: the
+[examples](examples/) show both.
+
 ## The async API
 
 The async API is identical: the same classes, the same methods. Only the import

{sqlakit-0.3.0 → sqlakit-0.3.1}/README.md

@@ -153,44 +153,6 @@ feed.next_cursor
 feed.previous_cursor
 ```
 
-## Active Record
-
-An instance saves and deletes itself, and the query is available on the class:
-
-```python
-from sqlalchemy.orm import Mapped, mapped_column
-
-from sqlakit import Database
-from sqlakit.orm import Model
-
-db = Database("postgresql+psycopg://localhost/app")
-
-
-class Note(Model):
-    __tablename__ = "notes"
-
-    id: Mapped[int] = mapped_column(primary_key=True)
-    text: Mapped[str]
-
-
-Note.set_db(db)
-
-with db.transaction():
-    note = Note(text="ada")
-    note.save()
-
-    Note.query.where(Note.text == "ada").all()
-    note.delete()
-```
-
-`set_db()` binds a model to a database. Call it on a base class and every model
-under it inherits the binding. With the global `db` from the section below you
-don't need it at all: the model uses the global registry automatically.
-
-This layer is optional. Everything else works on plain `SQLAlchemy` models, so
-if saving belongs in your repositories or services, skip `sqlakit.orm`
-entirely.
-
 ## Testing
 
 A test runs inside a transaction that rolls back at the end, so nothing the
@@ -296,6 +258,42 @@ with db.using("replica").connect():
     list_users()  # the models read the replica
 ```
 
+## Active Record
+
+An instance saves and deletes itself, and the query is available on the class.
+A model on the registry needs no wiring of its own:
+
+```python
+from sqlalchemy.orm import Mapped, mapped_column
+
+from sqlakit import db
+from sqlakit.orm import Model
+
+
+class Note(Model):
+    __tablename__ = "notes"
+
+    id: Mapped[int] = mapped_column(primary_key=True)
+    text: Mapped[str]
+
+
+with db.transaction():
+    note = Note(text="ada").save()
+
+    Note.query.where(Note.text == "ada").all()
+    note.delete()
+```
+
+A model that belongs on another database in the registry names its alias with
+`__db__ = "warehouse"`. With a `Database` of your own, `set_db()` binds the
+model to it. Either goes on a base class, and every model under it inherits
+the binding.
+
+This layer is optional. Everything else works on plain `SQLAlchemy` models, so
+if saving belongs in your repositories or services, skip `sqlakit.orm`
+entirely. `SQLModel` classes are `SQLAlchemy` models, and work either way: the
+[examples](examples/) show both.
+
 ## The async API
 
 The async API is identical: the same classes, the same methods. Only the import

{sqlakit-0.3.0 → sqlakit-0.3.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "sqlakit"
-version = "0.3.0"
+version = "0.3.1"
 description = "A toolkit for SQLAlchemy applications."
 readme = "README.md"
 license = "MIT"
@@ -163,8 +163,8 @@ skip = "./.venv,./site,./uv.lock,./.git"
 [dependency-groups]
 dev = [
     "pytest>=9.1.1",
-    "ty>=0.0.72",
-    "ruff>=0.16.3",
+    "ty>=0.0.75",
+    "ruff>=0.16.5",
     "poethepoet>=0.48.0",
     "anyio>=4.14.2",
     "trio>=0.34.0",

{sqlakit-0.3.0 → sqlakit-0.3.1}/pyproject.toml.orig

@@ -1,6 +1,6 @@
 [project]
 name = "sqlakit"
-version = "0.3.0"
+version = "0.3.1"
 description = "A toolkit for SQLAlchemy applications."
 readme = "README.md"
 license = "MIT"
@@ -30,8 +30,6 @@ Repository = "https://github.com/antonrh/sqlakit"
 Documentation = "https://github.com/antonrh/sqlakit"
 
 [project.optional-dependencies]
-# `greenlet`, which the async API runs on. `SQLAlchemy` installs it by itself
-# where a wheel exists, and this asks for it on the platforms where none does.
 asyncio = [
     "sqlalchemy[asyncio]>=2.0.22",
 ]
@@ -56,8 +54,8 @@ default-groups = ["dev", "docs"]
 [dependency-groups]
 dev = [
     "pytest>=9.1.1",
-    "ty>=0.0.72",
-    "ruff>=0.16.3",
+    "ty>=0.0.75",
+    "ruff>=0.16.5",
     "poethepoet>=0.48.0",
     "anyio>=4.14.2",
     "trio>=0.34.0",