fastapi-admin-kit 0.1.0__tar.gz → 0.1.1__tar.gz

{fastapi_admin_kit-0.1.0 → fastapi_admin_kit-0.1.1}/.gitignore

@@ -28,6 +28,7 @@ pip-delete-this-directory.txt
 # Virtual environments
 .venv/
 venv/
+list/
 ENV/
 env/
 .env

{fastapi_admin_kit-0.1.0 → fastapi_admin_kit-0.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-admin-kit
-Version: 0.1.0
+Version: 0.1.1
 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/
@@ -25,13 +25,13 @@ Classifier: Typing :: Typed
 Requires-Python: >=3.11
 Requires-Dist: aiosqlite>=0.20.0
 Requires-Dist: bcrypt>=4.0.0
-Requires-Dist: fastapi>=0.136.3
+Requires-Dist: fastapi>=0.115.0
 Requires-Dist: itsdangerous>=2.2.0
 Requires-Dist: jinja2>=3.1.0
 Requires-Dist: pyjwt>=2.13.0
 Requires-Dist: python-multipart>=0.0.9
 Requires-Dist: sqlalchemy>=2.0.0
-Requires-Dist: uvicorn>=0.49.0
+Requires-Dist: uvicorn>=0.30.0
 Provides-Extra: dev
 Requires-Dist: hatch>=1.13.0; extra == 'dev'
 Requires-Dist: httpx>=0.27.0; extra == 'dev'
@@ -58,6 +58,8 @@ Description-Content-Type: text/markdown
 
 A drop-in admin panel for FastAPI + SQLAlchemy apps, inspired by Django Unfold.
 
+> **⚠️ Important Notice:** This project is **not production-ready yet**. It is under active development, and the API and code may massive changes. Use it for development and testing purposes only.
+
 📖 **[Documentation](https://borhanst.github.io/fastapi-admin-kit/)** | 🚀 **[Quick Start](#quick-start)** | 📦 **[PyPI](https://pypi.org/project/fastapi-admin-kit/)**
 
 ## Features
@@ -66,7 +68,8 @@ A drop-in admin panel for FastAPI + SQLAlchemy apps, inspired by Django Unfold.
 - Built-in authentication, RBAC, and audit logging
 - Modern UI with Tailwind CSS, HTMX, and Alpine.js
 - Fully customizable widgets, themes, and templates
-- CLI for user management (`fastapi-admin-kit` / `fak` — create superusers, list users, change passwords)
+- Inline editing from list view with 3-dot action menu
+- CLI for user management (`fak-admin` / `fak` — create superusers, list users, change passwords)
 - Async-first with support for PostgreSQL, MySQL, and SQLite
 
 ## Installation
@@ -138,15 +141,15 @@ Both the full name and the short alias work interchangeably:
 
 ```bash
 # Create a superuser
-fastapi-admin-kit create-superuser -e admin@example.com -p mypassword
-fak create-superuser -e admin@example.com -p mypassword       # short alias
+fak-admin createsuperuser -e admin@example.com -p mypassword
+fak createsuperuser -e admin@example.com -p mypassword       # short alias
 
 # List all admin users
-fastapi-admin-kit users
+fak-admin users
 fak users
 
 # Change a user's password
-fastapi-admin-kit changepassword -e admin@example.com -p newpassword
+fak-admin changepassword -e admin@example.com -p newpassword
 fak changepassword -e admin@example.com -p newpassword
 ```
 

{fastapi_admin_kit-0.1.0 → fastapi_admin_kit-0.1.1}/README.md

@@ -6,6 +6,8 @@
 
 A drop-in admin panel for FastAPI + SQLAlchemy apps, inspired by Django Unfold.
 
+> **⚠️ Important Notice:** This project is **not production-ready yet**. It is under active development, and the API and code may massive changes. Use it for development and testing purposes only.
+
 📖 **[Documentation](https://borhanst.github.io/fastapi-admin-kit/)** | 🚀 **[Quick Start](#quick-start)** | 📦 **[PyPI](https://pypi.org/project/fastapi-admin-kit/)**
 
 ## Features
@@ -14,7 +16,8 @@ A drop-in admin panel for FastAPI + SQLAlchemy apps, inspired by Django Unfold.
 - Built-in authentication, RBAC, and audit logging
 - Modern UI with Tailwind CSS, HTMX, and Alpine.js
 - Fully customizable widgets, themes, and templates
-- CLI for user management (`fastapi-admin-kit` / `fak` — create superusers, list users, change passwords)
+- Inline editing from list view with 3-dot action menu
+- CLI for user management (`fak-admin` / `fak` — create superusers, list users, change passwords)
 - Async-first with support for PostgreSQL, MySQL, and SQLite
 
 ## Installation
@@ -86,15 +89,15 @@ Both the full name and the short alias work interchangeably:
 
 ```bash
 # Create a superuser
-fastapi-admin-kit create-superuser -e admin@example.com -p mypassword
-fak create-superuser -e admin@example.com -p mypassword       # short alias
+fak-admin createsuperuser -e admin@example.com -p mypassword
+fak createsuperuser -e admin@example.com -p mypassword       # short alias
 
 # List all admin users
-fastapi-admin-kit users
+fak-admin users
 fak users
 
 # Change a user's password
-fastapi-admin-kit changepassword -e admin@example.com -p newpassword
+fak-admin changepassword -e admin@example.com -p newpassword
 fak changepassword -e admin@example.com -p newpassword
 ```
 

{fastapi_admin_kit-0.1.0 → fastapi_admin_kit-0.1.1}/fastapi_admin_kit/__init__.py

@@ -2,6 +2,7 @@
 
 from fastapi_admin_kit.admin import Admin
 from fastapi_admin_kit.admin.decorators import column
+from fastapi_admin_kit.config import DatabaseConfig, DatabaseType
 from fastapi_admin_kit.exceptions import ConfigError
 from fastapi_admin_kit.nav import (
     BuiltNavGroup,
@@ -40,6 +41,8 @@ __all__ = [
     "Admin",
     "AdminRegistry",
     "ConfigError",
+    "DatabaseConfig",
+    "DatabaseType",
     "RegisteredModel",
     "ModelAdmin",
     "column",
@@ -70,4 +73,4 @@ __all__ = [
     # Per-model assets
     "AdminExtra",
 ]
-__version__ = "0.1.0"
+__version__ = "0.1.1"

{fastapi_admin_kit-0.1.0 → fastapi_admin_kit-0.1.1}/fastapi_admin_kit/admin/admin_database.py

@@ -1,9 +1,10 @@
 """Admin database setup and initialization."""
 
-from typing import TYPE_CHECKING, Any
+from __future__ import annotations
 
-if TYPE_CHECKING:
-    pass
+from typing import Any
+
+from fastapi_admin_kit.config.database import DatabaseConfig
 
 
 class AdminDatabase:
@@ -13,9 +14,17 @@ class AdminDatabase:
         self,
         engine: Any | None = None,
         base: Any | None = None,
+        database_config: DatabaseConfig | None = None,
     ):
         self.engine = engine
         self.base = base
+        self.database_config = database_config
+
+    def _ensure_engine(self) -> Any:
+        """Create the async engine from ``database_config`` if no engine is set."""
+        if self.engine is None and self.database_config is not None:
+            self.engine = self.database_config.create_engine()
+        return self.engine
 
     async def _create_tables(self) -> None:
         """Create all admin database tables (async-safe)."""

{fastapi_admin_kit-0.1.0 → fastapi_admin_kit-0.1.1}/fastapi_admin_kit/admin/core.py

@@ -21,6 +21,7 @@ from fastapi_admin_kit.config import (
     AuditConfig,
     AuthConfig,
     BehaviorConfig,
+    DatabaseConfig,
     NavConfig,
     StorageConfig,
     ThemeConfig,
@@ -116,6 +117,7 @@ class Admin:
         self,
         app: FastAPI | None = None,
         engine: Engine | None = None,
+        database_config: DatabaseConfig | None = None,
         *,
         # Component instances (new API)
         config: AdminConfig | None = None,
@@ -257,7 +259,9 @@ class Admin:
             )
 
         if database is None:
-            database = AdminDatabase(engine=engine, base=base)
+            database = AdminDatabase(
+                engine=engine, base=base, database_config=database_config
+            )
 
         if router is None:
             router = AdminRouter(
@@ -426,9 +430,12 @@ class Admin:
                 "Admin requires a FastAPI app instance. Pass app= or call setup(app=)."
             )
 
+        self.database._ensure_engine()
+
         if self.database.engine is None:
             raise ConfigError(
-                "Admin requires a SQLAlchemy engine. Pass engine= to Admin()."
+                "Admin requires a SQLAlchemy engine. "
+                "Pass engine= or database_config= to Admin()."
             )
 
         app = self._app

{fastapi_admin_kit-0.1.0 → fastapi_admin_kit-0.1.1}/fastapi_admin_kit/auth/csrf.py

@@ -9,7 +9,7 @@ import time
 
 from fastapi import HTTPException, Request, Response
 from starlette.middleware.base import BaseHTTPMiddleware
-from starlette.responses import JSONResponse, RedirectResponse
+from starlette.responses import RedirectResponse
 
 CSRF_COOKIE_NAME = "admin_csrf_token"
 CSRF_FORM_FIELD = "csrf_token"

fastapi_admin_kit-0.1.1/fastapi_admin_kit/cli/__init__.py

@@ -0,0 +1,79 @@
+"""CLI commands for FastAPI Admin Kit."""
+
+from __future__ import annotations
+
+import argparse
+import sys
+
+from fastapi_admin_kit.cli.scaffold import scaffold_project
+from fastapi_admin_kit.cli.user import (
+    handle_user_command,
+    register_user_commands,
+)
+
+
+def _init_project(args: argparse.Namespace) -> None:
+    """Create a new FastAPI project with uv."""
+    scaffold_project(
+        project_name=args.name,
+        layout=args.layout,
+        directory=args.directory,
+        skip_venv=args.no_venv,
+        skip_git=args.no_git,
+    )
+
+
+def main() -> None:
+    """Main CLI entry point."""
+    parser = argparse.ArgumentParser(
+        description="FastAPI Admin Kit CLI — manage admin users and scaffold projects.",
+    )
+    subparsers = parser.add_subparsers(
+        dest="command", help="Available commands"
+    )
+
+    # Register command groups
+    register_user_commands(subparsers)
+
+    # init — scaffold a new FastAPI project
+    init_parser = subparsers.add_parser(
+        "init", help="Create a new FastAPI project with uv"
+    )
+    init_parser.add_argument(
+        "name", nargs="?", default=None, help="Project name"
+    )
+    init_parser.add_argument(
+        "-l",
+        "--layout",
+        choices=["flat", "app", "src"],
+        default=None,
+        help="Project layout (flat, app, src). Interactive if omitted.",
+    )
+    init_parser.add_argument(
+        "-d",
+        "--directory",
+        default=None,
+        help="Target directory (defaults to project name)",
+    )
+    init_parser.add_argument(
+        "--no-venv", action="store_true", help="Skip uv venv creation"
+    )
+    init_parser.add_argument(
+        "--no-git", action="store_true", help="Skip git init"
+    )
+
+    args = parser.parse_args()
+
+    if args.command is None:
+        parser.print_help()
+        sys.exit(1)
+
+    # Dispatch
+    if args.command in ("createsuperuser", "users", "changepassword"):
+        handle_user_command(args)
+    elif args.command == "init":
+        _init_project(args)
+
+
+if __name__ == "__main__":
+    main()

fastapi_admin_kit-0.1.1/fastapi_admin_kit/cli/__main__.py

@@ -0,0 +1,5 @@
+"""Allow running CLI as `python -m fastapi_admin_kit.cli`."""
+
+from fastapi_admin_kit.cli import main
+
+main()

fastapi_admin_kit-0.1.1/fastapi_admin_kit/cli/scaffold.py

@@ -0,0 +1,287 @@
+"""Interactive project scaffolding for FastAPI projects with uv."""
+
+from __future__ import annotations
+
+import subprocess
+import sys
+from pathlib import Path
+
+LAYOUTS = {
+    "flat": {
+        "name": "Flat (main.py in root)",
+        "description": "Simple layout — main.py at project root",
+        "files": {
+            "main.py": '''\
+from contextlib import asynccontextmanager
+
+from fastapi import FastAPI
+
+
+@asynccontextmanager
+async def lifespan(app: FastAPI):
+    print("Starting up...")
+    yield
+    print("Shutting down...")
+
+
+app = FastAPI(title="{project_name}", lifespan=lifespan)
+
+
+@app.get("/")
+async def root():
+    return {{"message": "Hello from {project_name}!"}}
+
+
+@app.get("/health")
+async def health():
+    return {{"status": "ok"}}
+''',
+        },
+    },
+    "app": {
+        "name": "App directory (app/main.py)",
+        "description": "Recommended — app/ package with __init__.py",
+        "files": {
+            "app/__init__.py": "",
+            "app/main.py": '''\
+from contextlib import asynccontextmanager
+
+from fastapi import FastAPI
+
+
+@asynccontextmanager
+async def lifespan(app: FastAPI):
+    print("Starting up...")
+    yield
+    print("Shutting down...")
+
+
+app = FastAPI(title="{project_name}", lifespan=lifespan)
+
+
+@app.get("/")
+async def root():
+    return {{"message": "Hello from {project_name}!"}}
+
+
+@app.get("/health")
+async def health():
+    return {{"status": "ok"}}
+''',
+        },
+    },
+    "src": {
+        "name": "Src layout (src/app/main.py)",
+        "description": "Src layout — installable package with src/ root",
+        "files": {
+            "src/__init__.py": "",
+            "src/app/__init__.py": "",
+            "src/app/main.py": '''\
+from contextlib import asynccontextmanager
+
+from fastapi import FastAPI
+
+
+@asynccontextmanager
+async def lifespan(app: FastAPI):
+    print("Starting up...")
+    yield
+    print("Shutting down...")
+
+
+app = FastAPI(title="{project_name}", lifespan=lifespan)
+
+
+@app.get("/")
+async def root():
+    return {{"message": "Hello from {project_name}!"}}
+
+
+@app.get("/health")
+async def health():
+    return {{"status": "ok"}}
+''',
+        },
+    },
+}
+
+
+def _pyproject_content(project_name: str, layout: str, description: str = "") -> str:
+    """Generate pyproject.toml content."""
+    entrypoints = {
+        "flat": "main:app",
+        "app": "app.main:app",
+        "src": "app.main:app",
+    }
+    packages_val = {
+        "flat": "main.py",
+        "app": "app",
+        "src": "src/app",
+    }
+
+    return f'''\
+[project]
+name = "{project_name}"
+version = "0.1.0"
+description = "{description or project_name}"
+readme = "README.md"
+requires-python = ">=3.11"
+dependencies = [
+    "fastapi[standard]>=0.115.0",
+    "uvicorn[standard]>=0.30.0",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["{packages_val[layout]}"]
+
+[tool.fastapi]
+entrypoint = "{entrypoints[layout]}"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.ruff]
+line-length = 100
+target-version = "py311"
+'''
+
+
+def _gitignore_content() -> str:
+    return '''\
+__pycache__/
+*.py[cod]
+*.egg-info/
+dist/
+build/
+.venv/
+.env
+*.db
+*.sqlite3
+'''
+
+
+def _python_version_content() -> str:
+    return "3.11\n"
+
+
+def _input(prompt: str, default: str = "") -> str:
+    """Read user input with optional default."""
+    suffix = f" [{default}]" if default else ""
+    value = input(f"{prompt}{suffix}: ").strip()
+    return value or default
+
+
+def _select(options: list[str], prompt: str) -> int:
+    """Display numbered options and return selected index."""
+    print(f"\n{prompt}")
+    for i, opt in enumerate(options, 1):
+        print(f"  {i}) {opt}")
+    while True:
+        choice = input("\nEnter number: ").strip()
+        if choice.isdigit() and 1 <= int(choice) <= len(options):
+            return int(choice) - 1
+        print(f"Invalid choice. Enter 1-{len(options)}.")
+
+
+def _run(cmd: list[str], cwd: Path) -> bool:
+    """Run a subprocess, return True on success."""
+    result = subprocess.run(cmd, cwd=cwd, capture_output=True, text=True)
+    if result.returncode != 0:
+        print(f"Error running {' '.join(cmd)}:")
+        print(result.stderr or result.stdout)
+        return False
+    return True
+
+
+def scaffold_project(
+    project_name: str | None = None,
+    layout: str | None = None,
+    directory: str | None = None,
+    skip_venv: bool = False,
+    skip_git: bool = False,
+) -> Path:
+    """
+    Create a new FastAPI project.
+
+    Interactive when args are missing; non-interactive when all provided.
+    Returns the project directory path.
+    """
+    # --- Collect inputs interactively ---
+    if not project_name:
+        project_name = _input("Project name", "my-fastapi-app")
+
+    if not layout:
+        options = [f"{LAYOUTS[k]['name']} — {LAYOUTS[k]['description']}" for k in LAYOUTS]
+        idx = _select(options, "Select project structure:")
+        layout = list(LAYOUTS.keys())[idx]
+
+    project_dir = Path(directory or project_name).resolve()
+
+    if project_dir.exists() and any(project_dir.iterdir()):
+        confirm = _input(f"'{project_dir}' already exists. Overwrite?", "n")
+        if confirm.lower() not in ("y", "yes"):
+            print("Aborted.")
+            sys.exit(1)
+
+    project_dir.mkdir(parents=True, exist_ok=True)
+
+    # --- Write files ---
+    print(f"\nCreating project '{project_name}' in {project_dir} ...")
+
+    # pyproject.toml
+    (project_dir / "pyproject.toml").write_text(_pyproject_content(project_name, layout))
+
+    # .gitignore
+    (project_dir / ".gitignore").write_text(_gitignore_content())
+
+    # .python-version
+    (project_dir / ".python-version").write_text(_python_version_content())
+
+    # README.md
+    (project_dir / "README.md").write_text(f"# {project_name}\n\nA FastAPI project.\n")
+
+    # Layout files
+    layout_data = LAYOUTS[layout]
+    for rel_path, content in layout_data["files"].items():
+        file_path = project_dir / rel_path
+        file_path.parent.mkdir(parents=True, exist_ok=True)
+        file_path.write_text(content.format(project_name=project_name))
+
+    print("Project files created.")
+
+    # --- uv init ---
+    if not skip_venv:
+        print("\nSetting up virtual environment with uv...")
+        if not _run(["uv", "venv"], project_dir):
+            print("Warning: uv venv creation failed. Create manually: uv venv")
+        else:
+            print("  Virtual environment created.")
+
+        print("Installing dependencies...")
+        if not _run(["uv", "sync"], project_dir):
+            # uv sync may fail if uv.lock doesn't exist yet, try uv pip install
+            print("  Trying uv pip install...")
+            _run(["uv", "pip", "install", "-e", "."], project_dir)
+        else:
+            print("  Dependencies installed.")
+
+    # --- git init ---
+    if not skip_git:
+        print("\nInitializing git repository...")
+        _run(["git", "init"], project_dir)
+        _run(["git", "add", "."], project_dir)
+        _run(["git", "commit", "-m", "Initial commit"], project_dir)
+        print("  Git repository initialized.")
+
+    # --- Summary ---
+    entrypoints = {"flat": "main:app", "app": "app.main:app", "src": "app.main:app"}
+    print(f"\nDone! Project '{project_name}' is ready.\n")
+    print(f"  cd {project_dir.name}")
+    if not skip_venv:
+        print("  source .venv/bin/activate  # or: uv run fastapi dev")
+    print("  fastapi dev                # starts at http://localhost:8000")
+    print(f"\n  Entrypoint: {entrypoints[layout]}")
+    print(f"  Layout: {LAYOUTS[layout]['name']}")
+
+    return project_dir

fastapi_admin_kit-0.1.0/fastapi_admin_kit/cli.py → fastapi_admin_kit-0.1.1/fastapi_admin_kit/cli/user.py

@@ -1,4 +1,4 @@
-"""CLI commands for FastAPI Admin Kit."""
+"""User management CLI commands."""
 
 from __future__ import annotations
 
@@ -79,6 +79,7 @@ async def _list_users(args: argparse.Namespace) -> None:
 
     from fastapi_admin_kit.auth.models import AdminUser
     from fastapi_admin_kit.models.base import Base
+
     database_url = _resolve_database_url(args.database_url)
     engine = create_async_engine(database_url)
 
@@ -154,16 +155,9 @@ async def _change_password(args: argparse.Namespace) -> None:
     await engine.dispose()
 
 
-def main() -> None:
-    """Main CLI entry point."""
-    parser = argparse.ArgumentParser(
-        description="FastAPI Admin Kit CLI — manage admin users and database.",
-    )
-    subparsers = parser.add_subparsers(
-        dest="command", help="Available commands"
-    )
-
-    # create-superuser
+def register_user_commands(subparsers) -> None:
+    """Register user management subcommands."""
+    # createsuperuser
     create_parser = subparsers.add_parser(
         "createsuperuser", help="Create a new superuser"
     )
@@ -183,7 +177,7 @@ def main() -> None:
         help="Database URL (or set DATABASE_URL env var)",
     )
 
-    # list-users
+    # users
     list_parser = subparsers.add_parser(
         "users", help="List all admin users"
     )
@@ -211,19 +205,12 @@ def main() -> None:
         help="Database URL (or set DATABASE_URL env var)",
     )
 
-    args = parser.parse_args()
-
-    if args.command is None:
-        parser.print_help()
-        sys.exit(1)
 
+def handle_user_command(args: argparse.Namespace) -> None:
+    """Dispatch user management commands."""
     if args.command == "createsuperuser":
         asyncio.run(_create_superuser(args))
     elif args.command == "users":
         asyncio.run(_list_users(args))
     elif args.command == "changepassword":
         asyncio.run(_change_password(args))
-
-
-if __name__ == "__main__":
-    main()

{fastapi_admin_kit-0.1.0 → fastapi_admin_kit-0.1.1}/fastapi_admin_kit/config/__init__.py

@@ -3,6 +3,7 @@
 from fastapi_admin_kit.config.audit import AuditConfig
 from fastapi_admin_kit.config.auth import AuthConfig
 from fastapi_admin_kit.config.behavior import BehaviorConfig
+from fastapi_admin_kit.config.database import DatabaseConfig, DatabaseType
 from fastapi_admin_kit.config.nav import NavConfig
 from fastapi_admin_kit.config.storage import StorageConfig
 from fastapi_admin_kit.config.theme import ThemeConfig
@@ -11,6 +12,8 @@ from fastapi_admin_kit.config.ui import UIConfig
 __all__ = [
     "AuthConfig",
     "AuditConfig",
+    "DatabaseConfig",
+    "DatabaseType",
     "UIConfig",
     "BehaviorConfig",
     "StorageConfig",