crudadmin 0.3.2__tar.gz → 0.3.4__tar.gz

{crudadmin-0.3.2 → crudadmin-0.3.4}/.gitignore

@@ -61,6 +61,12 @@ local_settings.py
 db.sqlite3
 db.sqlite3-journal
 
+# SQLite databases
+*.db
+*.db-journal*
+*.sqlite
+*.sqlite3
+
 # Flask stuff:
 instance/
 .webassets-cache
@@ -167,6 +173,6 @@ cython_debug/
 .ruff_cache
 
 uv.lock
-.python-version
 
-local_test
+local_test
+crudadmin_data/

{crudadmin-0.3.2 → crudadmin-0.3.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: crudadmin
-Version: 0.3.2
+Version: 0.3.4
 Summary: FastAPI-based admin interface with authentication, event logging and CRUD operations
 Project-URL: Homepage, https://github.com/benavlabs/crudadmin
 Project-URL: Documentation, https://benavlabs.github.io/crudadmin
@@ -115,8 +115,8 @@ Description-Content-Type: text/markdown
 
 **Documentation**: [https://benavlabs.github.io/crudadmin/](https://benavlabs.github.io/crudadmin/)
 
-> [!WARNING]  
-> CRUDAdmin is still experimental. While actively developed and tested, APIs may change between versions. Upgrade with caution in production environments, always carefuly reading the changelog.
+> \[!WARNING\]  
+> CRUDAdmin is still experimental. While actively developed and tested, APIs may change between versions. Upgrade with caution in production environments, always carefully reading the changelog.
 
 ## Features
 
@@ -218,6 +218,21 @@ Navigate to `/admin` to access your admin interface with:
 - Responsive UI with dark/light themes
 - Built-in security features
 
+> \[!WARNING\]
+> **Important for SQLite users:** If you're using SQLite databases (which is the default for CRUDAdmin), make sure to add database files to your `.gitignore` to avoid committing sensitive data like admin credentials and session tokens.
+>
+> ```gitignore
+> # SQLite databases - NEVER commit these to version control
+> *.db
+> *.sqlite
+> *.sqlite3
+> crudadmin_data/
+>
+> # Also exclude database journals
+> *.db-journal
+> *.sqlite3-journal
+> ```
+
 ## Session Backends
 
 ### Development (Default)

{crudadmin-0.3.2 → crudadmin-0.3.4}/README.md

@@ -28,8 +28,8 @@
 
 **Documentation**: [https://benavlabs.github.io/crudadmin/](https://benavlabs.github.io/crudadmin/)
 
-> [!WARNING]  
-> CRUDAdmin is still experimental. While actively developed and tested, APIs may change between versions. Upgrade with caution in production environments, always carefuly reading the changelog.
+> \[!WARNING\]  
+> CRUDAdmin is still experimental. While actively developed and tested, APIs may change between versions. Upgrade with caution in production environments, always carefully reading the changelog.
 
 ## Features
 
@@ -131,6 +131,21 @@ Navigate to `/admin` to access your admin interface with:
 - Responsive UI with dark/light themes
 - Built-in security features
 
+> \[!WARNING\]
+> **Important for SQLite users:** If you're using SQLite databases (which is the default for CRUDAdmin), make sure to add database files to your `.gitignore` to avoid committing sensitive data like admin credentials and session tokens.
+>
+> ```gitignore
+> # SQLite databases - NEVER commit these to version control
+> *.db
+> *.sqlite
+> *.sqlite3
+> crudadmin_data/
+>
+> # Also exclude database journals
+> *.db-journal
+> *.sqlite3-journal
+> ```
+
 ## Session Backends
 
 ### Development (Default)

{crudadmin-0.3.2 → crudadmin-0.3.4}/crudadmin/admin_interface/admin_site.py

@@ -1,6 +1,6 @@
 import logging
 from collections.abc import AsyncGenerator, Callable
-from datetime import UTC, datetime
+from datetime import datetime, timezone
 from typing import Any, Dict, Optional, cast
 
 from fastapi import APIRouter, Cookie, Depends, Request, Response
@@ -19,6 +19,8 @@ from ..session.storage import AbstractSessionStorage, get_session_storage
 from .auth import AdminAuthentication
 from .typing import RouteResponse
 
+UTC = timezone.utc
+
 logger = logging.getLogger(__name__)
 
 EndpointCallable = Callable[..., Any]

{crudadmin-0.3.2 → crudadmin-0.3.4}/crudadmin/admin_interface/crud_admin.py

@@ -1,8 +1,9 @@
 import logging
 import os
+import sys
 import time
 from collections.abc import Awaitable, Callable
-from datetime import UTC, datetime, timedelta
+from datetime import datetime, timedelta, timezone
 from typing import (
     Any,
     AsyncGenerator,
@@ -10,13 +11,17 @@ from typing import (
     List,
     Optional,
     Type,
-    TypeAlias,
     TypedDict,
     TypeVar,
     Union,
     cast,
 )
 
+if sys.version_info >= (3, 10):
+    from typing import TypeAlias
+else:
+    from typing_extensions import TypeAlias
+
 from fastapi import APIRouter, Depends, FastAPI, Request
 from fastapi.security import OAuth2PasswordBearer
 from fastapi.staticfiles import StaticFiles
@@ -43,6 +48,8 @@ from .admin_site import AdminSite
 from .model_view import ModelView
 from .typing import RouteResponse
 
+UTC = timezone.utc
+
 logger = logging.getLogger("crudadmin")
 
 ModelType = TypeVar("ModelType", bound=DeclarativeBase)
@@ -796,6 +803,7 @@ class CRUDAdmin:
         update_schema: Type[BaseModel],
         update_internal_schema: Optional[Type[BaseModel]] = None,
         delete_schema: Optional[Type[BaseModel]] = None,
+        select_schema: Optional[Type[BaseModel]] = None,
         include_in_models: bool = True,
         allowed_actions: Optional[set[str]] = None,
         password_transformer: Optional[Any] = None,
@@ -812,6 +820,7 @@ class CRUDAdmin:
             update_schema: Pydantic schema for update operations
             update_internal_schema: Internal schema for special update cases
             delete_schema: Schema for delete operations
+            select_schema: Optional schema for read operations (excludes fields from queries)
             include_in_models: Show in models list in admin UI
             allowed_actions: **Set of allowed operations:**
                 - **"view"**: Allow viewing records
@@ -828,6 +837,7 @@ class CRUDAdmin:
         Notes:
             - Forms are auto-generated with field types determined from Pydantic schemas
             - Actions controlled by allowed_actions parameter
+            - Use select_schema to exclude problematic fields (e.g., TSVector) from read operations
             - Use password_transformer for models with password fields that need hashing
 
             URL Routes:
@@ -865,6 +875,29 @@ class CRUDAdmin:
             )
             ```
 
+            Excluding problematic fields (e.g., TSVector):
+            ```python
+            class DocumentCreate(BaseModel):
+                title: str
+                content: str
+                # TSVector field excluded from this schema
+
+            class DocumentSelect(BaseModel):
+                id: int
+                title: str
+                content: str
+                created_at: datetime
+                # search_vector (TSVector) field excluded
+
+            admin.add_view(
+                model=Document,
+                create_schema=DocumentCreate,
+                update_schema=DocumentCreate,
+                select_schema=DocumentSelect,  # TSVector field excluded from reads
+                allowed_actions={"view", "create", "update"}
+            )
+            ```
+
             User with password handling:
             ```python
             from crudadmin.admin_interface.model_view import PasswordTransformer
@@ -1021,6 +1054,7 @@ class CRUDAdmin:
             update_schema=update_schema,
             update_internal_schema=update_internal_schema,
             delete_schema=delete_schema,
+            select_schema=select_schema,
             admin_site=self.admin_site,
             allowed_actions=allowed_actions,
             event_integration=self.event_integration,

{crudadmin-0.3.2 → crudadmin-0.3.4}/crudadmin/admin_interface/model_view.py

@@ -772,7 +772,10 @@ class ModelView:
                     f"{pk_name}__in": valid_ids
                 }
                 records_to_delete = await self.crud.get_multi(
-                    db=db, limit=len(valid_ids), **cast(Any, filter_criteria)
+                    db=db,
+                    limit=len(valid_ids),
+                    schema_to_select=self.select_schema,
+                    **cast(Any, filter_criteria),
                 )
 
                 request.state.deleted_records = records_to_delete.get("data", [])
@@ -804,6 +807,7 @@ class ModelView:
                     db=db,
                     offset=(adjusted_page - 1) * rows_per_page,
                     limit=rows_per_page,
+                    schema_to_select=self.select_schema,
                 )
 
                 items: Dict[str, Any] = {
@@ -947,6 +951,7 @@ class ModelView:
                     limit=rows_per_page,
                     sort_columns=sort_columns,
                     sort_orders=sort_orders,
+                    schema_to_select=self.select_schema,
                     **cast(Any, filter_criteria),
                 )
 
@@ -1053,7 +1058,9 @@ class ModelView:
             db: AsyncSession = Depends(self.session),
         ) -> Response:
             """Show a form to update an existing record by `id`."""
-            item = await self.crud.get(db=db, id=id)
+            item = await self.crud.get(
+                db=db, id=id, schema_to_select=self.select_schema
+            )
             if not item:
                 return JSONResponse(
                     status_code=404, content={"message": f"Item with id {id} not found"}
@@ -1112,7 +1119,9 @@ class ModelView:
                     status_code=422, content={"message": "No id parameter provided"}
                 )
 
-            item = await self.crud.get(db=db, id=id)
+            item = await self.crud.get(
+                db=db, id=id, schema_to_select=self.select_schema
+            )
             if not item:
                 return JSONResponse(
                     status_code=404, content={"message": f"Item with id {id} not found"}
@@ -1283,7 +1292,11 @@ class ModelView:
                 filter_criteria[f"{search_column}__ilike"] = f"%{search_value}%"
 
             items_result = await self.crud.get_multi(
-                db=db, offset=offset, limit=limit, **cast(Any, filter_criteria)
+                db=db,
+                offset=offset,
+                limit=limit,
+                schema_to_select=self.select_schema,
+                **cast(Any, filter_criteria),
             )
 
             items: Dict[str, Any] = {

{crudadmin-0.3.2 → crudadmin-0.3.4}/crudadmin/admin_user/models.py

@@ -1,9 +1,11 @@
-from datetime import UTC, datetime
+from datetime import datetime, timezone
 from typing import Optional, Type
 
 from sqlalchemy import Boolean, DateTime, String
 from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column
 
+UTC = timezone.utc
+
 
 def create_admin_user(base: Type[DeclarativeBase]) -> Type[DeclarativeBase]:
     class AdminUser(base):  # type: ignore

{crudadmin-0.3.2 → crudadmin-0.3.4}/crudadmin/core/schemas/timestamp.py

@@ -1,23 +1,25 @@
-from datetime import UTC, datetime
+from datetime import datetime, timezone
 from typing import Any, Optional
 
 from pydantic import BaseModel, Field, field_serializer
 
+UTC = timezone.utc
+
 
 class TimestampSchema(BaseModel):
     created_at: datetime = Field(default_factory=lambda: datetime.now(UTC))
     updated_at: Optional[datetime] = Field(default=None)
 
     @field_serializer("created_at")
-    def serialize_dt(self, created_at: datetime | None, _info: Any) -> str | None:
+    def serialize_dt(self, created_at: Optional[datetime], _info: Any) -> Optional[str]:
         if created_at is not None:
             return created_at.isoformat()
         return None
 
     @field_serializer("updated_at")
     def serialize_updated_at(
-        self, updated_at: datetime | None, _info: Any
-    ) -> str | None:
+        self, updated_at: Optional[datetime], _info: Any
+    ) -> Optional[str]:
         if updated_at is not None:
             return updated_at.isoformat()
         return None

{crudadmin-0.3.2 → crudadmin-0.3.4}/crudadmin/event/decorators.py

@@ -1,7 +1,7 @@
 import functools
 import logging
 from collections.abc import Callable
-from datetime import UTC, datetime
+from datetime import datetime, timezone
 from typing import Any, Dict, Optional, Type
 
 from fastapi import Request
@@ -11,6 +11,8 @@ from sqlalchemy.orm import DeclarativeBase
 
 from .models import EventType
 
+UTC = timezone.utc
+
 logger = logging.getLogger(__name__)
 
 

{crudadmin-0.3.2 → crudadmin-0.3.4}/crudadmin/event/models.py

@@ -1,4 +1,4 @@
-from datetime import UTC, datetime
+from datetime import datetime, timezone
 from typing import Any, Optional, cast
 
 from sqlalchemy import JSON, DateTime, String
@@ -7,6 +7,8 @@ from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column
 
 from .schemas import EventStatus, EventType
 
+UTC = timezone.utc
+
 
 def create_admin_event_log(base: type[DeclarativeBase]) -> type[DeclarativeBase]:
     tablename = "admin_event_log"

{crudadmin-0.3.2 → crudadmin-0.3.4}/crudadmin/event/service.py

@@ -1,6 +1,6 @@
 import json
 import logging
-from datetime import UTC, datetime, timedelta
+from datetime import datetime, timedelta, timezone
 from decimal import Decimal
 from enum import Enum
 from typing import Any, Optional, cast
@@ -19,6 +19,8 @@ from .schemas import (
     EventType,
 )
 
+UTC = timezone.utc
+
 logger = logging.getLogger(__name__)
 
 

{crudadmin-0.3.2 → crudadmin-0.3.4}/crudadmin/session/backends/database.py

@@ -6,7 +6,7 @@ dashboard for session management and monitoring.
 """
 
 import logging
-from datetime import UTC, datetime
+from datetime import datetime, timezone
 from typing import Any, Optional, TypeVar
 
 from pydantic import BaseModel
@@ -16,6 +16,8 @@ from ...core.db import DatabaseConfig
 from ..schemas import AdminSessionCreate, AdminSessionUpdate
 from ..storage import AbstractSessionStorage
 
+UTC = timezone.utc
+
 T = TypeVar("T", bound=BaseModel)
 logger = logging.getLogger(__name__)
 

{crudadmin-0.3.2 → crudadmin-0.3.4}/crudadmin/session/backends/memory.py

@@ -1,13 +1,15 @@
 import json
 import logging
 import re
-from datetime import UTC, datetime, timedelta
+from datetime import datetime, timedelta, timezone
 from typing import Optional, Pattern, TypeVar
 
 from pydantic import BaseModel
 
 from ..storage import AbstractSessionStorage
 
+UTC = timezone.utc
+
 T = TypeVar("T", bound=BaseModel)
 logger = logging.getLogger(__name__)
 

{crudadmin-0.3.2 → crudadmin-0.3.4}/crudadmin/session/manager.py

@@ -1,6 +1,6 @@
 import logging
 import secrets
-from datetime import UTC, datetime, timedelta
+from datetime import datetime, timedelta, timezone
 from typing import Any, Literal, Optional
 
 from fastapi import Request, Response
@@ -10,6 +10,8 @@ from .schemas import CSRFToken, SessionCreate, SessionData, UserAgentInfo
 from .storage import AbstractSessionStorage, get_session_storage
 from .user_agents_types import parse
 
+UTC = timezone.utc
+
 logger = logging.getLogger(__name__)
 
 SamesiteType = Literal["lax", "strict", "none"]

{crudadmin-0.3.2 → crudadmin-0.3.4}/crudadmin/session/models.py

@@ -1,9 +1,11 @@
-from datetime import UTC, datetime
+from datetime import datetime, timezone
 from typing import Any
 
 from sqlalchemy import JSON, Boolean, DateTime, String
 from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column
 
+UTC = timezone.utc
+
 
 def create_admin_session_model(base: type[DeclarativeBase]) -> type[DeclarativeBase]:
     class AdminSession(base):  # type: ignore

{crudadmin-0.3.2 → crudadmin-0.3.4}/crudadmin/session/schemas.py

@@ -1,4 +1,4 @@
-from datetime import UTC, datetime
+from datetime import datetime, timezone
 from enum import Enum
 from typing import Any, Optional
 from uuid import uuid4
@@ -7,6 +7,8 @@ from pydantic import BaseModel, Field, field_validator
 
 from ..core.schemas.timestamp import TimestampSchema
 
+UTC = timezone.utc
+
 
 class DeviceType(str, Enum):
     """Device type enumeration"""

{crudadmin-0.3.2 → crudadmin-0.3.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "crudadmin"
-version = "0.3.2"
+version = "0.3.4"
 description = "FastAPI-based admin interface with authentication, event logging and CRUD operations"
 readme = "README.md"
 requires-python = ">=3.9.2"