refactor: simplify belgie database dependency wiring (#100)

Author: mplemay

README.md

@@ -108,17 +108,27 @@ class OAuthState(Base):
 ### 2) Configure Belgie
 
 ```python
+from collections.abc import AsyncGenerator
+
+from sqlalchemy.engine import URL
+from sqlalchemy.ext.asyncio import AsyncSession, async_sessionmaker, create_async_engine
+
 from belgie import Belgie, BelgieSettings
-from belgie.oauth.google import GoogleOAuth
-from belgie.alchemy import SqliteSettings
 from belgie.alchemy import BelgieAdapter
+from belgie.oauth.google import GoogleOAuth
 
 settings = BelgieSettings(
     secret="your-secret-key",
     base_url="http://localhost:8000",
 )
 
-database = SqliteSettings(database="./app.db")
+engine = create_async_engine(URL.create("sqlite+aiosqlite", database="./app.db"))
+session_maker = async_sessionmaker(engine, class_=AsyncSession, expire_on_commit=False)
+
+
+async def get_db() -> AsyncGenerator[AsyncSession, None]:
+    async with session_maker() as session:
+        yield session
 
 adapter = BelgieAdapter(
     user=User,
@@ -130,7 +140,7 @@ adapter = BelgieAdapter(
 auth = Belgie(
     settings=settings,
     adapter=adapter,
-    database=database,
+    database=get_db,
 )
 
 google_oauth_plugin = auth.add_plugin(

docs/configuration.md

@@ -177,14 +177,18 @@ BELGIE_URLS_SIGNOUT_REDIRECT=/
 ### Python Configuration
 
 ```python
+from collections.abc import AsyncGenerator
+
+from sqlalchemy.engine import URL
+from sqlalchemy.ext.asyncio import AsyncSession, async_sessionmaker, create_async_engine
+
 from belgie import (
     Belgie,
     BelgieSettings,
     CookieSettings,
     SessionSettings,
     URLSettings,
 )
-from belgie.alchemy import SqliteSettings
 from belgie.alchemy import BelgieAdapter
 from belgie.oauth.google import GoogleOAuth
 
@@ -206,10 +210,17 @@ settings = BelgieSettings(
     ),
 )
 
-database = SqliteSettings(database="./app.db")
+engine = create_async_engine(URL.create("sqlite+aiosqlite", database="./app.db"))
+session_maker = async_sessionmaker(engine, class_=AsyncSession, expire_on_commit=False)
+
+
+async def get_db() -> AsyncGenerator[AsyncSession, None]:
+    async with session_maker() as session:
+        yield session
+
 adapter = BelgieAdapter(...)
 
-belgie = Belgie(settings=settings, adapter=adapter, database=database)
+belgie = Belgie(settings=settings, adapter=adapter, database=get_db)
 belgie.add_plugin(
     GoogleOAuth(
         client_id="your-client-id",

docs/quickstart.md

@@ -78,8 +78,12 @@ class OAuthState(Base):
 ### 2. Configure Authentication
 
 ```python
+from collections.abc import AsyncGenerator
+
+from sqlalchemy.engine import URL
+from sqlalchemy.ext.asyncio import AsyncSession, async_sessionmaker, create_async_engine
+
 from belgie import Belgie, BelgieSettings
-from belgie.alchemy import SqliteSettings
 from belgie.alchemy import BelgieAdapter
 from belgie.oauth.google import GoogleOAuth
 
@@ -90,7 +94,13 @@ settings = BelgieSettings(
 )
 
 # Configure database
-database = SqliteSettings(database="./app.db")
+engine = create_async_engine(URL.create("sqlite+aiosqlite", database="./app.db"))
+session_maker = async_sessionmaker(engine, class_=AsyncSession, expire_on_commit=False)
+
+
+async def get_db() -> AsyncGenerator[AsyncSession, None]:
+    async with session_maker() as session:
+        yield session
 
 # Create adapter
 adapter = BelgieAdapter(
@@ -104,7 +114,7 @@ adapter = BelgieAdapter(
 auth = Belgie(
     settings=settings,
     adapter=adapter,
-    database=database,
+    database=get_db,
 )
 google_oauth_plugin = auth.add_plugin(
     GoogleOAuth(

docs/scopes.md

@@ -23,15 +23,26 @@ your app is requesting and can approve or deny access.
 Configure scopes in your `GoogleOAuth`:
 
 ```python
+from collections.abc import AsyncGenerator
+
+from sqlalchemy.engine import URL
+from sqlalchemy.ext.asyncio import AsyncSession, async_sessionmaker, create_async_engine
+
 from belgie import Belgie, BelgieSettings
-from belgie.alchemy import SqliteSettings
 from belgie.alchemy import BelgieAdapter
 from belgie.oauth.google import GoogleOAuth
 
 settings = BelgieSettings(secret="your-secret", base_url="http://localhost:8000")
-database = SqliteSettings(database="./app.db")
+engine = create_async_engine(URL.create("sqlite+aiosqlite", database="./app.db"))
+session_maker = async_sessionmaker(engine, class_=AsyncSession, expire_on_commit=False)
+
+
+async def get_db() -> AsyncGenerator[AsyncSession, None]:
+    async with session_maker() as session:
+        yield session
+
 adapter = BelgieAdapter(...)
-belgie = Belgie(settings=settings, adapter=adapter, database=database)
+belgie = Belgie(settings=settings, adapter=adapter, database=get_db)
 belgie.add_plugin(
     GoogleOAuth(
         client_id="your-client-id",

examples/auth/main.py

@@ -1,10 +1,12 @@
-from collections.abc import AsyncIterator
+from collections.abc import AsyncGenerator, AsyncIterator
 from contextlib import asynccontextmanager
 from typing import Annotated
 
 from brussels.base import DataclassBase
 from fastapi import Depends, FastAPI, Security
 from fastapi.responses import RedirectResponse
+from sqlalchemy.engine import URL
+from sqlalchemy.ext.asyncio import AsyncSession, async_sessionmaker, create_async_engine
 
 from belgie import (
     Belgie,
@@ -13,19 +15,28 @@
     SessionSettings,
     URLSettings,
 )
-from belgie.alchemy import BelgieAdapter, SqliteSettings
+from belgie.alchemy import BelgieAdapter
 from belgie.oauth.google import GoogleOAuth, GoogleOAuthClient
 from examples.alchemy.auth_models import Account, OAuthState, Session, User
 
-db_settings = SqliteSettings(database="./belgie_auth_example.db", echo=True)
+engine = create_async_engine(
+    URL.create("sqlite+aiosqlite", database="./belgie_auth_example.db"),
+    echo=True,
+)
+session_maker = async_sessionmaker(engine, class_=AsyncSession, expire_on_commit=False)
+
+
+async def get_db() -> AsyncGenerator[AsyncSession, None]:
+    async with session_maker() as session:
+        yield session
 
 
 @asynccontextmanager
 async def lifespan(_app: FastAPI) -> AsyncIterator[None]:
-    async with db_settings.engine.begin() as conn:
+    async with engine.begin() as conn:
         await conn.run_sync(DataclassBase.metadata.create_all)
     yield
-    await db_settings.engine.dispose()
+    await engine.dispose()
 
 
 app = FastAPI(title="Belgie Example App", lifespan=lifespan)
@@ -58,7 +69,7 @@ async def lifespan(_app: FastAPI) -> AsyncIterator[None]:
 belgie = Belgie(
     settings=settings,
     adapter=adapter,
-    database=db_settings,
+    database=get_db,
 )
 google_oauth_plugin = belgie.add_plugin(
     GoogleOAuth(

examples/mcp/main.py

@@ -12,15 +12,17 @@
 from fastapi.responses import RedirectResponse
 from mcp.server.mcpserver import MCPServer
 from sqlalchemy import JSON, ForeignKey, Text, UniqueConstraint
+from sqlalchemy.engine import URL
+from sqlalchemy.ext.asyncio import AsyncSession, async_sessionmaker, create_async_engine
 from sqlalchemy.orm import Mapped, mapped_column, relationship
 
 from belgie import Belgie, BelgieClient, BelgieSettings, CookieSettings, SessionSettings, URLSettings
-from belgie.alchemy import BelgieAdapter, SqliteSettings
+from belgie.alchemy import BelgieAdapter
 from belgie.mcp import Mcp, get_user_from_access_token
 from belgie.oauth.server import OAuthResource, OAuthServer
 
 if TYPE_CHECKING:
-    from collections.abc import AsyncIterator
+    from collections.abc import AsyncGenerator, AsyncIterator
 
 
 class User(DataclassBase, PrimaryKeyMixin, TimestampMixin):
@@ -120,18 +122,27 @@ class OAuthState(DataclassBase, PrimaryKeyMixin, TimestampMixin):
 DB_PATH = "./belgie_mcp_example.db"
 
 
-db_settings = SqliteSettings(database=DB_PATH, echo=True)
+engine = create_async_engine(
+    URL.create("sqlite+aiosqlite", database=DB_PATH),
+    echo=True,
+)
+session_maker = async_sessionmaker(engine, class_=AsyncSession, expire_on_commit=False)
+
+
+async def get_db() -> AsyncGenerator[AsyncSession, None]:
+    async with session_maker() as session:
+        yield session
 
 
 @asynccontextmanager
 async def lifespan(_app: FastAPI) -> AsyncIterator[None]:
-    async with db_settings.engine.begin() as conn:
+    async with engine.begin() as conn:
         await conn.run_sync(DataclassBase.metadata.create_all)
 
     async with mcp_server.session_manager.run():
         yield
 
-    await db_settings.engine.dispose()
+    await engine.dispose()
 
 
 app = FastAPI(title="Belgie MCP OAuth Example", lifespan=lifespan)
@@ -164,7 +175,7 @@ async def lifespan(_app: FastAPI) -> AsyncIterator[None]:
 belgie = Belgie(
     settings=settings,
     adapter=adapter,
-    database=db_settings,
+    database=get_db,
 )
 
 oauth_settings = OAuthServer(

examples/oauth/main.py

@@ -1,8 +1,10 @@
-from collections.abc import AsyncIterator
+from collections.abc import AsyncGenerator, AsyncIterator
 from contextlib import asynccontextmanager
 
 from brussels.base import DataclassBase
 from fastapi import FastAPI
+from sqlalchemy.engine import URL
+from sqlalchemy.ext.asyncio import AsyncSession, async_sessionmaker, create_async_engine
 
 from belgie import (
     Belgie,
@@ -11,22 +13,31 @@
     SessionSettings,
     URLSettings,
 )
-from belgie.alchemy import BelgieAdapter, SqliteSettings
+from belgie.alchemy import BelgieAdapter
 from belgie.oauth.server import OAuthServer
 from examples.alchemy.auth_models import Account, OAuthState, Session, User
 
 DB_PATH = "./belgie_oauth_example.db"
 
 
-db_settings = SqliteSettings(database=DB_PATH, echo=True)
+engine = create_async_engine(
+    URL.create("sqlite+aiosqlite", database=DB_PATH),
+    echo=True,
+)
+session_maker = async_sessionmaker(engine, class_=AsyncSession, expire_on_commit=False)
+
+
+async def get_db() -> AsyncGenerator[AsyncSession, None]:
+    async with session_maker() as session:
+        yield session
 
 
 @asynccontextmanager
 async def lifespan(_app: FastAPI) -> AsyncIterator[None]:
-    async with db_settings.engine.begin() as conn:
+    async with engine.begin() as conn:
         await conn.run_sync(DataclassBase.metadata.create_all)
     yield
-    await db_settings.engine.dispose()
+    await engine.dispose()
 
 
 app = FastAPI(title="Belgie OAuth Server Example", lifespan=lifespan)
@@ -59,7 +70,7 @@ async def lifespan(_app: FastAPI) -> AsyncIterator[None]:
 belgie = Belgie(
     settings=settings,
     adapter=adapter,
-    database=db_settings,
+    database=get_db,
 )
 
 oauth_settings = OAuthServer(

examples/oauth_client_plugin/main.py

@@ -1,27 +1,38 @@
-from collections.abc import AsyncIterator
+from collections.abc import AsyncGenerator, AsyncIterator
 from contextlib import asynccontextmanager
 from typing import Annotated
 
 from brussels.base import DataclassBase
 from fastapi import Depends, FastAPI, Security
 from fastapi.responses import RedirectResponse
+from sqlalchemy.engine import URL
+from sqlalchemy.ext.asyncio import AsyncSession, async_sessionmaker, create_async_engine
 
 from belgie import Belgie, BelgieSettings, CookieSettings, SessionSettings, URLSettings
-from belgie.alchemy import BelgieAdapter, SqliteSettings
+from belgie.alchemy import BelgieAdapter
 from belgie.oauth.google import GoogleOAuth, GoogleOAuthClient
 from examples.alchemy.auth_models import Account, OAuthState, Session, User
 
 DB_PATH = "./belgie_oauth_client_example.db"
 
-db_settings = SqliteSettings(database=DB_PATH, echo=True)
+engine = create_async_engine(
+    URL.create("sqlite+aiosqlite", database=DB_PATH),
+    echo=True,
+)
+session_maker = async_sessionmaker(engine, class_=AsyncSession, expire_on_commit=False)
+
+
+async def get_db() -> AsyncGenerator[AsyncSession, None]:
+    async with session_maker() as session:
+        yield session
 
 
 @asynccontextmanager
 async def lifespan(_app: FastAPI) -> AsyncIterator[None]:
-    async with db_settings.engine.begin() as conn:
+    async with engine.begin() as conn:
         await conn.run_sync(DataclassBase.metadata.create_all)
     yield
-    await db_settings.engine.dispose()
+    await engine.dispose()
 
 
 app = FastAPI(title="Belgie OAuth Client Plugin Example", lifespan=lifespan)
@@ -54,7 +65,7 @@ async def lifespan(_app: FastAPI) -> AsyncIterator[None]:
 belgie = Belgie(
     settings=settings,
     adapter=adapter,
-    database=db_settings,
+    database=get_db,
 )
 
 google_oauth_plugin = belgie.add_plugin(