Merge pull request #15 from benavlabs/docs-fix

Docs fix

Author: igorbenav

README.md

@@ -74,11 +74,15 @@ from .user import (
 
 # Database setup
 engine = create_async_engine("sqlite+aiosqlite:///app.db")
-session = AsyncSession(engine)
+
+# Create database session dependency
+async def get_session():
+    async with AsyncSession(engine) as session:
+        yield session
 
 # Create admin interface
 admin = CRUDAdmin(
-    session=session,
+    session=get_session,
     SECRET_KEY="your-secret-key-here",
     initial_admin={
         "username": "admin",
@@ -121,20 +125,20 @@ Navigate to `/admin` to access your admin interface with:
 
 ### Development (Default)
 ```python
-admin = CRUDAdmin(session=session, SECRET_KEY="key")  # Memory backend
+admin = CRUDAdmin(session=get_session, SECRET_KEY="key")  # Memory backend
 ```
 
 ### Production with Redis
 ```python
-admin = CRUDAdmin(session=session, SECRET_KEY="key").use_redis_sessions(
+admin = CRUDAdmin(session=get_session, SECRET_KEY="key").use_redis_sessions(
     redis_url="redis://localhost:6379"
 )
 ```
 
 ### Production with Security Features
 ```python
 admin = CRUDAdmin(
-    session=session,
+    session=get_session,
     SECRET_KEY=SECRET_KEY,
     # Security features
     allowed_ips=["10.0.0.1"],

crudadmin/admin_interface/crud_admin.py

@@ -151,11 +151,15 @@ class User(Base):
 
         # Setup database
         engine = create_async_engine("sqlite+aiosqlite:///app.db")
-        session = AsyncSession(engine)
+
+        # Create database session dependency
+        async def get_session():
+            async with AsyncSession(engine) as session:
+                yield session
 
         # Create admin interface
         admin = CRUDAdmin(
-            session=session,
+            session=get_session,
             SECRET_KEY=SECRET_KEY,
             initial_admin={
                 "username": "admin",
@@ -167,7 +171,7 @@ class User(Base):
         Production setup with security features:
         ```python
         admin = CRUDAdmin(
-            session=session,
+            session=get_session,
             SECRET_KEY=SECRET_KEY,
             # Security features
             allowed_ips=["10.0.0.1", "10.0.0.2"],
@@ -187,7 +191,7 @@ class User(Base):
         Session management configuration:
         ```python
         admin = CRUDAdmin(
-            session=session,
+            session=get_session,
             SECRET_KEY=SECRET_KEY,
             # Session management settings
             max_sessions_per_user=5,
@@ -269,7 +273,7 @@ class OrderUpdate(BaseModel):
         Event tracking and audit logs:
         ```python
         admin = CRUDAdmin(
-            session=session,
+            session=get_session,
             SECRET_KEY=SECRET_KEY,
             track_events=True,  # Enable event tracking
             # Custom admin database for logs
@@ -446,7 +450,7 @@ async def initialize(self) -> None:
             Manual initialization:
             ```python
             admin = CRUDAdmin(
-                session=async_session,
+                session=get_session,
                 SECRET_KEY="key",
                 setup_on_initialization=False
             )

docs/index.md

@@ -87,11 +87,15 @@ from crudadmin import CRUDAdmin
 
 # Database setup
 engine = create_async_engine("sqlite+aiosqlite:///app.db")
-session = AsyncSession(engine)
+
+# Create database session dependency
+async def get_session():
+    async with AsyncSession(engine) as session:
+        yield session
 
 # Create admin interface
 admin = CRUDAdmin(
-    session=session,
+    session=get_session,
     SECRET_KEY="your-secret-key-here",
     initial_admin={
         "username": "admin",
@@ -197,7 +201,7 @@ CRUDAdmin offers flexible configuration options for different deployment scenari
 from crudadmin import CRUDAdmin
 
 admin = CRUDAdmin(
-    session=async_session,
+    session=get_session,
     SECRET_KEY="your-secret-key",
     initial_admin={
         "username": "admin", 
@@ -220,7 +224,7 @@ app.mount("/admin", admin.app)
 
 ```python
 admin = CRUDAdmin(
-    session=async_session,
+    session=get_session,
     SECRET_KEY=os.environ["ADMIN_SECRET_KEY"],
 
     # Security features
@@ -289,7 +293,7 @@ admin.use_memcached_sessions(
 
 # Hybrid Sessions (Redis + Database)
 admin = CRUDAdmin(
-    session=session,
+    session=get_session,
     SECRET_KEY=SECRET_KEY,
     track_sessions_in_db=True
 ).use_redis_sessions(

docs/quick-start.md

@@ -75,11 +75,14 @@ Assuming you have your SQLAlchemy model, Pydantic schemas and database connectio
 ??? note "Set up your database connection (click to expand)"
     ```python
     from sqlalchemy.ext.asyncio import AsyncSession, create_async_engine
-    from sqlalchemy.orm import sessionmaker
 
     DATABASE_URL = "sqlite+aiosqlite:///./admin_demo.db"
     engine = create_async_engine(DATABASE_URL, echo=True)
-    async_session = sessionmaker(engine, class_=AsyncSession, expire_on_commit=False)
+    
+    # Create database session dependency
+    async def get_session():
+        async with AsyncSession(engine) as session:
+            yield session
     ```
 
 ### Using CRUDAdmin
@@ -96,7 +99,7 @@ from crudadmin import CRUDAdmin
 
 # Create admin interface
 admin = CRUDAdmin(
-    session=async_session,  # Your session factory
+    session=get_session,  # Your session dependency function
     SECRET_KEY=os.environ.get("SECRET_KEY", "your-secret-key-for-development"),
     initial_admin={
         "username": "admin",

docs/usage/admin-users.md

@@ -21,7 +21,7 @@ The easiest way to create your first admin user is during CRUDAdmin initializati
 ```python
 # Create admin interface with initial admin user
 admin = CRUDAdmin(
-    session=async_session,
+    session=get_session,
     SECRET_KEY=os.environ["ADMIN_SECRET_KEY"],
     initial_admin={
         "username": "admin",
@@ -263,7 +263,7 @@ Each admin user can have multiple concurrent sessions:
 ```python
 # Configure session limits (in CRUDAdmin initialization)
 admin = CRUDAdmin(
-    session=async_session,
+    session=get_session,
     SECRET_KEY=key,
     max_sessions_per_user=3,        # Limit concurrent sessions
     session_timeout_minutes=30,     # Auto-logout after inactivity
@@ -287,7 +287,7 @@ admin = CRUDAdmin(
 ```python
 # Development: Simple auto-admin
 admin = CRUDAdmin(
-    session=async_session,
+    session=get_session,
     SECRET_KEY="dev-key-change-in-production",
     initial_admin={
         "username": "admin",
@@ -297,7 +297,7 @@ admin = CRUDAdmin(
 
 # Production: No auto-admin, manual creation
 admin = CRUDAdmin(
-    session=async_session,
+    session=get_session,
     SECRET_KEY=os.environ["ADMIN_SECRET_KEY"],
     initial_admin=None  # Create admin users manually
 )

docs/usage/configuration.md

@@ -25,7 +25,7 @@ from sqlalchemy.ext.asyncio import AsyncSession
 
 # Minimal CRUDAdmin instance
 admin = CRUDAdmin(
-    session=your_async_session,  # Your SQLAlchemy async session
+    session=get_session,  # Your session dependency function
     SECRET_KEY="your-secret-key-here"
 )
 ```
@@ -43,12 +43,16 @@ from sqlalchemy.orm import sessionmaker
 # Database setup
 DATABASE_URL = "sqlite+aiosqlite:///./app.db"
 engine = create_async_engine(DATABASE_URL, echo=True)
-async_session = sessionmaker(engine, class_=AsyncSession, expire_on_commit=False)
+
+# Create database session dependency
+async def get_session():
+    async with AsyncSession(engine) as session:
+        yield session
 
 # Create admin with common settings
 admin = CRUDAdmin(
     # Required parameters (no defaults)
-    session=async_session,
+    session=get_session,
     SECRET_KEY=os.environ.get("ADMIN_SECRET_KEY", "dev-key-change-in-production"),
 
     # Basic interface settings
@@ -70,7 +74,7 @@ admin = CRUDAdmin(
 
 - **Required parameters**: `session` and `SECRET_KEY` have no defaults and must be provided
 - **Optional parameters**: All other parameters have sensible defaults and can be omitted
-- **Most minimal setup**: `CRUDAdmin(session=async_session, SECRET_KEY="your-key")` uses all defaults
+- **Most minimal setup**: `CRUDAdmin(session=get_session, SECRET_KEY="your-key")` uses all defaults
 
 ---
 
@@ -82,10 +86,12 @@ admin = CRUDAdmin(
 Your SQLAlchemy async session factory or callable that returns sessions:
 
 ```python
-# Session factory (most common)
-from sqlalchemy.orm import sessionmaker
-async_session = sessionmaker(engine, class_=AsyncSession, expire_on_commit=False)
-admin = CRUDAdmin(session=async_session, SECRET_KEY=secret_key)
+# Session dependency function (recommended)
+async def get_session():
+    async with AsyncSession(engine) as session:
+        yield session
+
+admin = CRUDAdmin(session=get_session, SECRET_KEY=secret_key)
 ```
 
 #### `SECRET_KEY` (str)
@@ -94,7 +100,7 @@ Critical for session security and cookie signing. **Never use default values in
 ```python
 # ✅ Use environment variables
 admin = CRUDAdmin(
-    session=session, 
+    session=get_session, 
     SECRET_KEY=os.environ["ADMIN_SECRET_KEY"]
 )
 
@@ -109,11 +115,11 @@ URL path where the admin interface will be accessible. **If you want a different
 
 ```python
 # Default: accessible at /admin (no mount_path parameter needed)
-admin = CRUDAdmin(session=session, SECRET_KEY=key)
+admin = CRUDAdmin(session=get_session, SECRET_KEY=key)
 
 # Custom path: accessible at /dashboard (must specify mount_path)
 admin = CRUDAdmin(
-    session=session, 
+    session=get_session, 
     SECRET_KEY=key,
     mount_path="/dashboard"  # Required for non-default paths
 )
@@ -134,22 +140,22 @@ Choose between light and dark themes:
 
 ```python
 # Dark theme (default)
-admin = CRUDAdmin(session=session, SECRET_KEY=key, theme="dark-theme")
+admin = CRUDAdmin(session=get_session, SECRET_KEY=key, theme="dark-theme")
 
 # Light theme
-admin = CRUDAdmin(session=session, SECRET_KEY=key, theme="light-theme")
+admin = CRUDAdmin(session=get_session, SECRET_KEY=key, theme="light-theme")
 ```
 
 #### `admin_db_path` (str, default: None)
 Custom location for the admin database (used for admin users, sessions, etc.):
 
 ```python
 # Default: creates ./crudadmin_data/admin.db
-admin = CRUDAdmin(session=session, SECRET_KEY=key)
+admin = CRUDAdmin(session=get_session, SECRET_KEY=key)
 
 # Custom path
 admin = CRUDAdmin(
-    session=session, 
+    session=get_session, 
     SECRET_KEY=key,
     admin_db_path="./admin/admin_database.db"
 )
@@ -160,11 +166,11 @@ Automatically create an admin user when the system initializes:
 
 ```python
 # No initial admin (default - create manually later)
-admin = CRUDAdmin(session=session, SECRET_KEY=key)
+admin = CRUDAdmin(session=get_session, SECRET_KEY=key)
 
 # Create initial admin automatically
 admin = CRUDAdmin(
-    session=session,
+    session=get_session,
     SECRET_KEY=key,
     initial_admin={
         "username": "admin",
@@ -202,7 +208,7 @@ app.mount("/admin", admin.app)
 ```python
 # If you configured a custom mount_path
 admin = CRUDAdmin(
-    session=async_session,
+    session=get_session,
     SECRET_KEY=key,
     mount_path="/dashboard"
 )
@@ -220,7 +226,7 @@ app.mount("/dashboard", admin.app)
 ```python
 # Simple development configuration
 admin = CRUDAdmin(
-    session=async_session,
+    session=get_session,
     SECRET_KEY="dev-key-change-in-production",  # Simple key for development
     initial_admin={                             # Convenient auto-admin
         "username": "admin",
@@ -234,7 +240,7 @@ admin = CRUDAdmin(
 ```python
 # Basic production configuration
 admin = CRUDAdmin(
-    session=async_session,
+    session=get_session,
     SECRET_KEY=os.environ["ADMIN_SECRET_KEY"],  # Required environment variable
     initial_admin=None,                         # Create admin users manually
     secure_cookies=True,                        # Default: True (good for production)