fastapi-admin-kit 0.3.0__tar.gz → 0.3.2__tar.gz

{fastapi_admin_kit-0.3.0 → fastapi_admin_kit-0.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-admin-kit
-Version: 0.3.0
+Version: 0.3.2
 Summary: Drop-in admin panel for FastAPI + SQLAlchemy + SQLModel apps
 Project-URL: Homepage, https://github.com/borhanst/fastapi-admin-kit
 Project-URL: Documentation, https://borhanst.github.io/fastapi-admin-kit/
@@ -31,6 +31,8 @@ Requires-Dist: jinja2>=3.1.0
 Requires-Dist: pre-commit>=4.6.0
 Requires-Dist: python-multipart>=0.0.9
 Requires-Dist: sqlalchemy>=2.0.0
+Provides-Extra: alembic
+Requires-Dist: alembic>=1.13.0; extra == 'alembic'
 Provides-Extra: dev
 Requires-Dist: hatch>=1.13.0; extra == 'dev'
 Requires-Dist: httpx>=0.27.0; extra == 'dev'
@@ -44,6 +46,8 @@ Provides-Extra: docs
 Requires-Dist: mkdocs-material>=9.5.0; extra == 'docs'
 Requires-Dist: mkdocs>=1.6.0; extra == 'docs'
 Requires-Dist: mkdocstrings[python]>=0.25.0; extra == 'docs'
+Provides-Extra: excel
+Requires-Dist: openpyxl>=3.1.0; extra == 'excel'
 Provides-Extra: full
 Requires-Dist: pyjwt>=2.13.0; extra == 'full'
 Requires-Dist: uvicorn>=0.30.0; extra == 'full'

{fastapi_admin_kit-0.3.0 → fastapi_admin_kit-0.3.2}/fastapi_admin_kit/__init__.py

@@ -5,6 +5,7 @@ from fastapi_admin_kit.admin.decorators import column
 from fastapi_admin_kit.auth.mixins import AuthModelMixin
 from fastapi_admin_kit.config import DatabaseConfig, DatabaseType
 from fastapi_admin_kit.exceptions import ConfigError
+from fastapi_admin_kit.export_import import CSVExport, CSVImport, ExportBase, ImportBase
 from fastapi_admin_kit.inline import InlineModelAdmin, StackedInline, TabularInline
 from fastapi_admin_kit.nav import (
     BuiltNavGroup,
@@ -81,5 +82,10 @@ __all__ = [
     "SearchView",
     # Per-model assets
     "AdminExtra",
+    # Export/Import
+    "ExportBase",
+    "ImportBase",
+    "CSVExport",
+    "CSVImport",
 ]
-__version__ = "0.3.0"
+__version__ = "0.3.2"

{fastapi_admin_kit-0.3.0 → fastapi_admin_kit-0.3.2}/fastapi_admin_kit/admin/admin_database.py

@@ -33,10 +33,12 @@ class AdminDatabase:
         engine: Any | None = None,
         base: Any | None = None,
         database_config: DatabaseConfig | None = None,
+        use_alembic: bool = False,
     ):
         self.engine = engine
         self.base = base
         self.database_config = database_config
+        self.use_alembic = use_alembic
         self._backend = SqlAlchemyDatabaseBackend(
             admin_database=self, database_config=database_config
         )
@@ -48,16 +50,19 @@ class AdminDatabase:
         return self.engine
 
     async def _create_tables(self) -> None:
-        """Create all admin database tables (async-safe)."""
-        from sqlalchemy.ext.asyncio import AsyncEngine
+        """Create all admin database tables (async-safe).
 
-        from fastapi_admin_kit.audit import (
-            models as _audit_models,  # noqa: F401
-        )
+        If ``use_alembic=True`` (production mode), this method does nothing
+        and expects Alembic to manage the schema via migrations.
+        """
+        if self.use_alembic:
+            logger.info("use_alembic=True: skipping create_all; schema managed by Alembic")
+            return
+
+        from sqlalchemy.ext.asyncio import AsyncEngine
 
         # Import models to register them with metadata
-        from fastapi_admin_kit.auth import models as _auth_models  # noqa: F401
-        from fastapi_admin_kit.models.base import Base as AdminBase
+        from fastapi_admin_kit.migrations.models import Base as AdminBase
 
         if isinstance(self.engine, AsyncEngine):
             # Async engine - use run_sync
@@ -166,7 +171,7 @@ class AdminDatabase:
         from sqlalchemy.ext.asyncio import AsyncEngine, AsyncSession
         from sqlalchemy.orm import Session, sessionmaker
 
-        from fastapi_admin_kit.auth.models import Permission, Role
+        from fastapi_admin_kit.migrations.models import Permission, Role
 
         is_async = isinstance(self.engine, AsyncEngine)
 

{fastapi_admin_kit-0.3.0 → fastapi_admin_kit-0.3.2}/fastapi_admin_kit/admin/admin_template.py

@@ -22,6 +22,7 @@ class AdminTemplate:
         dark_mode_default: bool = False,
         dashboard_permission: str | None = None,
         settings_permission: str | None = None,
+        sidebar_bottom_links: list[dict[str, str]] | None = None,
     ):
         self.title = title
         self.logo_url = logo_url
@@ -31,6 +32,7 @@ class AdminTemplate:
         self.dark_mode_default = dark_mode_default
         self.dashboard_permission = dashboard_permission
         self.settings_permission = settings_permission
+        self.sidebar_bottom_links: list[dict[str, str]] = sidebar_bottom_links or []
         self._nav_groups_built: list = []
 
     def _init_jinja(self, app: Any) -> None:
@@ -221,6 +223,7 @@ class AdminTemplate:
             "current_user": user_for_template,
             "dashboard_visible": dashboard_visible,
             "settings_visible": settings_visible,
+            "sidebar_bottom_links": self.sidebar_bottom_links,
         }
 
     async def apply_sidebar_context(self, request: Any, user: Any, context: dict) -> dict:

{fastapi_admin_kit-0.3.0 → fastapi_admin_kit-0.3.2}/fastapi_admin_kit/admin/builtin_models.py

@@ -170,6 +170,8 @@ class UserAdmin(ModelAdmin):
 class RoleAdmin(ModelAdmin):
     tag = "admin"
     icon = "shield-check"
+    verbose_name = "Admin Role"
+    verbose_name_plural = "Admin Roles"
     list_display = ["id", "name", "description"]
     search_fields = ["name"]
     exclude = ["users"]

{fastapi_admin_kit-0.3.0 → fastapi_admin_kit-0.3.2}/fastapi_admin_kit/admin/core.py

@@ -180,6 +180,7 @@ class Admin:
         mobile_sidebar: str = "overlay",
         dashboard_permission: str | None = None,
         settings_permission: str | None = None,
+        sidebar_bottom_links: list[dict[str, str]] | None = None,
     ):
         self.registry = AdminRegistry()
         self._app: FastAPI | None = app
@@ -261,11 +262,17 @@ class Admin:
                     require_tags=require_tags,
                     dashboard_permission=dashboard_permission,
                     settings_permission=settings_permission,
+                    sidebar_bottom_links=sidebar_bottom_links,
                 ),
             )
 
         if database is None:
-            database = AdminDatabase(engine=engine, base=base, database_config=database_config)
+            database = AdminDatabase(
+                engine=engine,
+                base=base,
+                database_config=database_config,
+                use_alembic=config.behavior.use_alembic,
+            )
 
         if router is None:
             router = AdminRouter(
@@ -283,6 +290,7 @@ class Admin:
                 dark_mode_default=config.ui.dark_mode_default,
                 dashboard_permission=config.nav.dashboard_permission,
                 settings_permission=config.nav.settings_permission,
+                sidebar_bottom_links=config.nav.sidebar_bottom_links,
             )
 
         self.config = config
@@ -538,7 +546,8 @@ class Admin:
         # 8.2 Apply skip_models — mark listed models to hide from admin
         skip_models = self.config.behavior.skip_models
         # Built-in internal models are always hidden from admin
-        default_skip = {"RefreshToken", "UserPermission", "UserTOTP"}
+        # Note: model class names match table names (e.g., admin_refresh_tokens)
+        default_skip = {"admin_refresh_tokens", "admin_user_permissions", "admin_user_totp"}
         all_skip = default_skip | skip_models
         skip_lower = {s.lower() for s in all_skip}
         for registered in self.registry.all():
@@ -555,7 +564,9 @@ class Admin:
                 from fastapi_admin_kit.db import create_session_factory
 
                 session_factory = create_session_factory(engine)
-                from fastapi_admin_kit.backends.sqlalchemy import SqlAlchemyAuditBackend
+                from fastapi_admin_kit.backends.sqlalchemy import (
+                    SqlAlchemyAuditBackend,
+                )
 
                 audit_backend = SqlAlchemyAuditBackend()
                 audit_backend.attach_listeners(session_factory, self.registry)
@@ -736,7 +747,9 @@ class Admin:
         # Unified signing-key source for sessions, CSRF, and JWT (see AdminState).
         app.state.admin_secret_key = state.secret_key
         # Multi-ORM backend: store composed backend and derive individual adapters
-        from fastapi_admin_kit.backends.sqlalchemy import SqlAlchemySessionAdapter
+        from fastapi_admin_kit.backends.sqlalchemy import (
+            SqlAlchemySessionAdapter,
+        )
 
         app.state.admin_backend = self.backend
         app.state.admin_session_backend_class = SqlAlchemySessionAdapter
@@ -848,6 +861,7 @@ class Admin:
             "bars-": "menu",
             "bars-3": "menu",
             "arrow-down-tray": "download",
+            "arrow-up-tray": "upload",
             "arrow-path": "refresh",
             "paper-airplane": "send",
             "exclamation-triangle": "warning",
@@ -983,8 +997,8 @@ class Admin:
             RoleAdmin,
             UserAdmin,
         )
-        from fastapi_admin_kit.audit.models import AuditLog
-        from fastapi_admin_kit.auth.models import (
+        from fastapi_admin_kit.migrations.models import (
+            AuditLog,
             LoginAttempt,
             Permission,
             Role,

{fastapi_admin_kit-0.3.0 → fastapi_admin_kit-0.3.2}/fastapi_admin_kit/audit/context.py

@@ -3,7 +3,10 @@
 from __future__ import annotations
 
 from contextvars import ContextVar
-from typing import Any
+from typing import TYPE_CHECKING, Any
+
+if TYPE_CHECKING:
+    from fastapi_admin_kit.audit.events import AuditEvent
 
 # Context variable to store audit context (user, IP, user_agent, etc.)
 _current_audit_context: ContextVar[dict] = ContextVar("_current_audit_context", default={})
@@ -60,3 +63,32 @@ class AuditContext:
     def clear_context(self) -> None:
         """Clear the audit context."""
         clear_audit_context()
+
+
+async def log_audit_event(request: Any, event: AuditEvent) -> None:
+    """Persist an AuditEvent directly to the database.
+
+    Used for EXPORT/IMPORT events that don't go through the SQLAlchemy
+    before_flush listener.
+    """
+    from fastapi_admin_kit.audit.models import AuditLog
+    from fastapi_admin_kit.db import get_db_session
+
+    session = get_db_session(request)
+    ctx = get_audit_context()
+
+    entry = AuditLog(
+        action=event.event_type,
+        model_name=event.model_name,
+        table_name=event.table_name,
+        object_id=event.object_id,
+        object_repr=event.object_repr,
+        changes=event.changes,
+        full_snapshot=event.full_snapshot,
+        user_id=event.user_id or ctx.get("user_id"),
+        user_email=event.user_email or ctx.get("user_email"),
+        ip_address=event.ip_address or ctx.get("ip_address"),
+        user_agent=event.user_agent or ctx.get("user_agent"),
+    )
+    session.add(entry)
+    await session.flush()

{fastapi_admin_kit-0.3.0 → fastapi_admin_kit-0.3.2}/fastapi_admin_kit/audit/events.py

@@ -9,13 +9,13 @@ from typing import Any
 
 @dataclass
 class AuditEvent:
-    """Represents a single audit event (CREATE, UPDATE, or DELETE).
+    """Represents a single audit event (CREATE, UPDATE, DELETE, EXPORT, or IMPORT).
 
     This is a pure data structure with no side effects, making it
     easy to test and serialize.
     """
 
-    event_type: str  # "CREATE" | "UPDATE" | "DELETE"
+    event_type: str  # "CREATE" | "UPDATE" | "DELETE" | "EXPORT" | "IMPORT"
     model_name: str
     table_name: str
     object_id: str

{fastapi_admin_kit-0.3.0 → fastapi_admin_kit-0.3.2}/fastapi_admin_kit/audit/logger.py

@@ -26,3 +26,11 @@ class AuditLogger(ABC):
     @abstractmethod
     def log_delete(self, event: AuditEvent) -> None:
         """Persist a DELETE audit event."""
+
+    @abstractmethod
+    def log_export(self, event: AuditEvent) -> None:
+        """Persist an EXPORT audit event."""
+
+    @abstractmethod
+    def log_import(self, event: AuditEvent) -> None:
+        """Persist an IMPORT audit event."""

fastapi_admin_kit-0.3.2/fastapi_admin_kit/audit/models.py

@@ -0,0 +1,22 @@
+"""SQLAlchemy model for the admin audit log.
+
+.. deprecated:: 2.1.0
+   This module is deprecated. Use ``fastapi_admin_kit.migrations.models`` instead,
+   which materializes models from schemas for both runtime and Alembic migrations.
+   This module will be removed in v3.0.
+"""
+
+from __future__ import annotations
+
+import warnings
+
+from fastapi_admin_kit.migrations.models import AuditLog
+
+warnings.warn(
+    "fastapi_admin_kit.audit.models is deprecated and will be removed in v3.0. "
+    "Use fastapi_admin_kit.migrations.models instead.",
+    DeprecationWarning,
+    stacklevel=2,
+)
+
+__all__ = ["AuditLog"]

{fastapi_admin_kit-0.3.0 → fastapi_admin_kit-0.3.2}/fastapi_admin_kit/audit/sqlalchemy_logger.py

@@ -32,6 +32,12 @@ class SqlAlchemyAuditLogger(AuditLogger):
     def log_delete(self, event: AuditEvent) -> None:
         self._buffer(event)
 
+    def log_export(self, event: AuditEvent) -> None:
+        self._buffer(event)
+
+    def log_import(self, event: AuditEvent) -> None:
+        self._buffer(event)
+
     def _buffer(self, event: AuditEvent) -> None:
         entry = AuditLog(
             user_id=event.user_id,

fastapi_admin_kit-0.3.2/fastapi_admin_kit/auth/models.py

@@ -0,0 +1,45 @@
+"""SQLAlchemy models for admin auth: roles, users, permissions.
+
+.. deprecated:: 2.1.0
+   This module is deprecated. Use ``fastapi_admin_kit.migrations.models`` instead,
+   which materializes models from schemas for both runtime and Alembic migrations.
+   This module will be removed in v3.0.
+"""
+
+from __future__ import annotations
+
+import warnings
+
+from fastapi_admin_kit.auth.mixins import AuthModelMixin
+from fastapi_admin_kit.migrations.models import (
+    LoginAttempt,
+    Permission,
+    RefreshToken,
+    Role,
+    User,
+    UserPermission,
+    UserTOTP,
+    admin_role_permissions,
+    admin_user_roles,
+)
+
+warnings.warn(
+    "fastapi_admin_kit.auth.models is deprecated and will be removed in v3.0. "
+    "Use fastapi_admin_kit.migrations.models instead.",
+    DeprecationWarning,
+    stacklevel=2,
+)
+
+# Re-export the mixin
+__all__ = [
+    "AuthModelMixin",
+    "User",
+    "Role",
+    "Permission",
+    "UserPermission",
+    "RefreshToken",
+    "UserTOTP",
+    "LoginAttempt",
+    "admin_user_roles",
+    "admin_role_permissions",
+]

{fastapi_admin_kit-0.3.0 → fastapi_admin_kit-0.3.2}/fastapi_admin_kit/auth/permissions.py

@@ -82,6 +82,10 @@ class PermissionChecker:
                 ps.can_edit = True
             if perm.can_delete:
                 ps.can_delete = True
+            if perm.can_export:
+                ps.can_export = True
+            if perm.can_import:
+                ps.can_import = True
 
         return self._role_cache
 
@@ -116,6 +120,10 @@ class PermissionChecker:
                 ps.can_edit = True
             if perm.can_delete:
                 ps.can_delete = True
+            if perm.can_export:
+                ps.can_export = True
+            if perm.can_import:
+                ps.can_import = True
 
         return self._direct_cache
 
@@ -137,7 +145,7 @@ class PermissionChecker:
     async def has_permission(self, table_name: str, action: str) -> bool:
         """Return True if the current user may perform *action* on *table_name*.
 
-        Actions: ``"view"`` | ``"create"`` | ``"edit"`` | ``"delete"``
+        Actions: ``"view"`` | ``"create"`` | ``"edit"`` | ``"delete"`` | ``"export"`` | ``"import"``
 
         Superusers always return True. Results are cached per-request.
         """
@@ -191,6 +199,8 @@ class PermissionChecker:
                 can_create=True,
                 can_edit=True,
                 can_delete=True,
+                can_export=True,
+                can_import=True,
             )
         # Check if cache has been populated for this table
         cache_populated = any(key[0] == table_name for key in self._cache)
@@ -207,6 +217,8 @@ class PermissionChecker:
             can_create=self._cache.get((table_name, "create"), False),
             can_edit=self._cache.get((table_name, "edit"), False),
             can_delete=self._cache.get((table_name, "delete"), False),
+            can_export=self._cache.get((table_name, "export"), False),
+            can_import=self._cache.get((table_name, "import"), False),
         )
 
     async def load_permissions(self, table_name: str) -> PermissionSet:
@@ -218,4 +230,6 @@ class PermissionChecker:
         await self.has_permission(table_name, "create")
         await self.has_permission(table_name, "edit")
         await self.has_permission(table_name, "delete")
+        await self.has_permission(table_name, "export")
+        await self.has_permission(table_name, "import")
         return self.permission_set(table_name)

{fastapi_admin_kit-0.3.0 → fastapi_admin_kit-0.3.2}/fastapi_admin_kit/auth/types.py

@@ -13,6 +13,8 @@ class PermissionSet:
     can_create: bool = False
     can_edit: bool = False
     can_delete: bool = False
+    can_export: bool = False
+    can_import: bool = False
 
 
 @dataclass