fastapi-admin-kit

KO | EN

gitlite — search

#hacktoberfest #pytorch #nlp #java #css #cross-platform #electron #react #swift #ai

fastapi-admin-kit

(★ 9)

Zero-config FastAPI admin panel — auto-discovered CRUD, RBAC, audit logs, and a modern Tailwind/HTMX UI.

File Explorer

ZIP Download

- - changelog.yml
  - docs.yml
  - release.yml
  - tests.yml
- CODEOWNERS
- - ai-agent-setup.md
  - index.md
- - admin.md
  - auth.md
  - widgets.md
- - configuration.md
  - installation.md
  - quickstart.md
- - alembic-setup.md
  - audit-logging.md
  - auth-rbac.md
  - backends.md
  - cli.md
  - command-palette.md
  - custom-auth-model.md
  - dashboard.md
  - existing-alembic-integration.md
  - features.md
  - filters.md
  - inline-editing-actions.md
  - json-api.md
  - model-registration.md
  - navigation.md
  - notifications.md
  - pagination.md
  - redis-caching.md
  - storage.md
  - themes.md
  - widgets-forms.md
- contributing.md
- index.md
- upcoming-features.md
- __init__.py
- example.py
- example_ai.py
- example_custom_templates.py
- example_notifications.py
- example_sqlmodel.py
- validate_ws.py
- - __init__.py
  - base.py
  - registry.py
- - __init__.py
  - admin_config.py
  - admin_database.py
  - admin_router.py
  - admin_template.py
  - builtin_models.py
  - core.py
  - decorators.py
  - state.py
- - __init__.py
  - agent.py
  - attachments.py
  - builtin_tools.py
  - config.py
  - conversation.py
  - dashboard.py
  - data_access.py
  - deps.py
  - errors.py
  - model_agent.py
  - plugin.py
  - prompts.py
  - serialization.py
  - service.py
  - tools.py
  - usage.py
- - __init__.py
  - auth.py
  - crud.py
  - deps.py
  - middleware.py
  - roles.py
  - schema_generator.py
  - schemas.py
  - search.py
  - security.py
- - __init__.py
  - context.py
  - diff.py
  - event_bus.py
  - events.py
  - listener.py
  - logger.py
  - middleware.py
  - models.py
  - sqlalchemy_logger.py
- - __init__.py
  - backend.py
  - csrf.py
  - dependencies.py
  - hasher.py
  - identity.py
  - mixins.py
  - models.py
  - password.py
  - permissions.py
  - protocol.py
  - proxy.py
  - ratelimit.py
  - router.py
  - session.py
  - totp.py
  - types.py
  - views.py
- - __init__.py
  - memory.py
  - protocols.py
  - sqlalchemy.py
- - __init__.py
  - __main__.py
  - helpers.py
  - migrate.py
  - permissions.py
  - scaffold.py
  - user.py
- - __init__.py
  - ai_chat.py
  - audit.py
  - auth.py
  - behavior.py
  - cache.py
  - database.py
  - nav.py
  - storage.py
  - theme.py
  - ui.py
- - __init__.py
- - __init__.py
  - base.py
  - csv.py
  - excel.py
  - registry.py
- - __init__.py
  - base.py
  - lookups.py
  - registry.py
- - __init__.py
  - pipeline.py
  - types.py
- - __init__.py
  - registry.py
  - types.py
- - __init__.py
  - models.py
- - __init__.py
  - base.py
- - __init__.py
  - config.py
  - dispatcher.py
  - email.py
  - models.py
  - plugin.py
  - realtime.py
  - router.py
  - schemas.py
  - service.py
  - store.py
- - __init__.py
  - base.py
  - cursor.py
  - dynamic.py
  - offset.py
- - __init__.py
- - __init__.py
  - core.py
  - validation.py
- - __init__.py
  - builtin.py
  - schema.py
- - __init__.py
  - base.py
  - local.py
- - base.html
- - __init__.py
  - types.py
- - __init__.py
  - audit.py
  - bulk.py
  - class_views.py
  - context.py
  - dashboard.py
  - delete.py
  - extra.py
  - factory.py
  - file_handler.py
  - form.py
  - list.py
  - list_context.py
  - model_saver.py
  - profile.py
  - protocols.py
  - renderers.py
  - roles.py
  - search.py
  - settings.py
  - sidebar.py
  - totp.py
  - users.py
- - __init__.py
  - base.py
  - inputs.py
  - registry.py
  - relation.py
  - resolver.py
- __init__.py
- db.py
- exceptions.py
- field_types.py
- flash.py
- inline.py
- inspection.py
- modeladmin.py
- nav.py
- py.typed
- redis.py
- registry.py
- router.py
- search_utils.py
- types.py
- validation.py
- views.py
- generate_changelog.py
- conftest.py
- test_2fa.py
- test_admin.py
- test_admin_components.py
- test_admin_config.py
- test_ai_agent.py
- test_ai_attachments.py
- test_api_crud.py
- test_api_security.py
- test_audit.py
- test_auth.py
- test_auth_routes.py
- test_custom_templates.py
- test_dashboard.py
- test_endpoint_decorator.py
- test_export_endpoint.py
- test_filters.py
- test_inspection.py
- test_inspector.py
- test_jwt.py
- test_memory_backend.py
- test_models.py
- test_native_stream.py
- test_nav.py
- test_notifications.py
- test_notifications_admin_integration.py
- test_notifications_api.py
- test_notifications_model_events.py
- test_notifications_orm_agnostic.py
- test_pagination.py
- test_permissions.py
- test_profile.py
- test_redis_cache.py
- test_registry.py
- test_role_routes.py
- test_routes.py
- test_schema_materialization.py
- test_search.py
- test_security.py
- test_security_api_validation.py
- test_security_audit.py
- test_security_endpoint_defaults.py
- test_security_mass_assignment.py
- test_security_phase4.py
- test_security_ratelimit.py
- test_security_rbac.py
- test_security_sensitive_fields.py
- test_security_stale_jwt.py
- test_security_token_revocation.py
- test_security_totp_login.py
- test_security_xss.py
- test_session_security.py
- test_shell_layout.py
- test_storage.py
- test_storage_traversal.py
- test_stream_persistence.py
- test_user_management.py
- test_validator.py
- test_view_factory.py
- test_widget_resolver.py
- test_widgets.py
.gitignore
.pre-commit-config.yaml
CHANGELOG.md
LICENSE
mkdocs.yml
pyproject.toml
README.md
SECURITY.md
test_on_complete.py

# Use via CDN

jsDelivr

jsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.

Version

File

Link

Example

# Project Badges

PyPI version Visit
Python versions Visit
License Visit
Tests Visit

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

A drop-in admin panel for FastAPI + SQLAlchemy + SQLModel apps, inspired by Django Admin.

![FastAPI Admin Kit Dashboard](https://raw.githubusercontent.com/borhanst/fastapi-admin-kit/main/docs/assets/images/admin-dashboard.png)

📖 **[Documentation](https://borhanst.github.io/fastapi-admin-kit/)** | 🚀 **[Quick Start](#quick-start)** | 📦 **[PyPI](https://pypi.org/project/fastapi-admin-kit/)**

## Features

> See the **[Full Features List](https://borhanst.github.io/fastapi-admin-kit/guide/features/)** for every feature with detailed docs links.

- **Zero-Config Auto-Discovery** — Register a model, get full CRUD UI automatically
- **SQLAlchemy & SQLModel** — Works with both ORMs out of the box
- **Built-in Auth & RBAC** — Session-based auth with role-based permissions per model
- **Audit Logging** — Every create, update, and delete is recorded with full diffs
- **Modern UI** — Tailwind CSS, HTMX, and Alpine.js with dark mode
- **17 Built-in Widgets** — TextInput, Toggle, DatePicker, FileUpload, Wysiwyg, and more
- **Inline Editing** — Edit records directly from list view with 3-dot action menu
- **Command Palette** — `Cmd+K` / `Ctrl+K` global search across models and fields

- **Dashboard** — Configurable stat cards, charts, tables, and progress bars
- **CLI Tools** — `fak-admin` / `fak` for superuser management and project scaffolding
- **Pagination** — Offset, cursor, or dynamic strategies per model
- **Filters** — Text, boolean, relation, and enum sidebar filters
- **File Uploads** — Built-in local storage backend with upload widgets
- **Async-First** — PostgreSQL, MySQL, and SQLite with auto URL normalization
- **CSRF & Rate Limiting** — Security built-in out of the box

## Installation

```bash
# pip
pip install fastapi-admin-kit

# uv
uv add fastapi-admin-kit
```

For database-specific async drivers:

```bash
# pip
pip install fastapi-admin-kit[postgres]  # PostgreSQL via asyncpg
pip install fastapi-admin-kit[mysql]     # MySQL via aiomysql

# uv
uv add fastapi-admin-kit[postgres]  # PostgreSQL via asyncpg
uv add fastapi-admin-kit[mysql]     # MySQL via aiomysql
```

For the full experience with uvicorn and JWT support:

```bash
# pip
pip install fastapi-admin-kit[full]

# uv
uv add fastapi-admin-kit[full]
```

## Quick Start

```python
import os
import secrets
from contextlib import asynccontextmanager

from fastapi import FastAPI
from sqlalchemy import Column, Float, Integer, String
from sqlalchemy.ext.asyncio import AsyncSession, create_async_engine
from sqlalchemy.orm import DeclarativeBase, relationship, sessionmaker

from fastapi_admin_kit import Admin
from fastapi_admin_kit.auth.backend import BuiltinAuthBackend
from fastapi_admin_kit.auth.mixins import AuthModelMixin
from fastapi_admin_kit.auth.models import Role, admin_user_roles

class Base(DeclarativeBase):
    pass

class User(AuthModelMixin, Base):
    __tablename__ = "users"
    id = Column(Integer, primary_key=True)
    email = Column(String(255), unique=True, nullable=False)
    full_name = Column(String(255))

roles = relationship(
        "Role", secondary=admin_user_roles, back_populates="users"
    )

class Product(Base):
    __tablename__ = "products"
    id = Column(Integer, primary_key=True)
    name = Column(String(100), nullable=False)
    price = Column(Float, nullable=False)

DATABASE_URL = os.getenv("DATABASE_URL", "sqlite+aiosqlite:///./app.db")
SECRET_KEY = os.getenv("SECRET_KEY", secrets.token_urlsafe(32))

engine = create_async_engine(DATABASE_URL)
async_session = sessionmaker(engine, class_=AsyncSession)

@asynccontextmanager
async def lifespan(app: FastAPI):
    async with engine.begin() as conn:
        await conn.run_sync(Base.metadata.create_all)
    await admin.setup()
    yield
    await engine.dispose()

app = FastAPI(lifespan=lifespan)
admin = Admin(
    app=app,
    engine=engine,
    base=Base,
    secret_key=SECRET_KEY,
    auth_model=User,
    auth_backend=BuiltinAuthBackend(),
)
admin.register(Product)
```

Run with:

```bash
pip install fastapi-admin-kit[full]
uvicorn main:app --reload
```

Open [http://localhost:8000/admin/](http://localhost:8000/admin/) and log in with:

- **Email:** `admin@example.com`
- **Password:** `admin`

!!! warning
    Change the default password immediately in production!

## CLI Usage

Both the full name and the short alias work interchangeably:

```bash
# Create a superuser
fak-admin createsuperuser -e admin@example.com -p mypassword
fak createsuperuser -e admin@example.com -p mypassword       # short alias

# List all admin users
fak-admin users
fak users

# Change a user's password
fak-admin changepassword -e admin@example.com -p newpassword
fak changepassword -e admin@example.com -p newpassword

# Scaffold a new fastapi project
fak init myproject

# Permission management
fak createpermissions --base myapp.models.Base
fak createpermissions myapp.models.User myapp.models.Product
```

All commands accept `-d DATABASE_URL` or read the `DATABASE_URL` environment variable.

## Configuration

### Environment Variables

| Variable | Description | Default |
|---|---|---|
| `DATABASE_URL` | Async database connection string | `sqlite+aiosqlite:///./app.db` |
| `SECRET_KEY` | Signing key for sessions/CSRF/JWT (min 32 chars) | Auto-generated if unset |

### Admin Options

```python
from fastapi_admin_kit import Admin

admin = Admin(
    app=app,
    engine=engine,
    base=Base,
    secret_key=SECRET_KEY,
    title="My Admin",           # Admin panel title
    admin_path="/admin",        # URL prefix
    # Auth
    auth_backend=BuiltinAuthBackend(),
    # Environment badge
    environment_label="Production",
    environment_color="danger",
)
```

### Database Support

- **SQLite** (default, built-in via `aiosqlite`)
- **PostgreSQL**: `pip install fastapi-admin-kit[postgres]` + set `DATABASE_URL=postgresql+asyncpg://...`
- **MySQL**: `pip install fastapi-admin-kit[mysql]` + set `DATABASE_URL=mysql+aiomysql://...`

### Optional Dependencies

| Extra | Packages | When to use |
|---|---|---|
| `full` | `uvicorn`, `pyjwt` | Running the dev server or using JWT API auth |
| `postgres` | `asyncpg` | PostgreSQL databases |
| `mysql` | `aiomysql` | MySQL databases |
| `sqlmodel` | `sqlmodel` | Using SQLModel models |
| `docs` | `mkdocs`, `mkdocs-material` | Building documentation |

## Security

- Session cookies use `SameSite=Strict` and `Secure` by default
- CSRF protection on all state-changing requests
- Rate limiting on authentication endpoints
- Passwords hashed with bcrypt
- SQL injection prevention via identifier validation
- Secret key validated to be >= 32 characters at startup

## Development

```bash
# Install with dev dependencies
uv sync

# Run tests with coverage
uv run pytest --cov=fastapi_admin_kit

# Lint
uv run ruff check fastapi_admin_kit/

# Format
uv run ruff format fastapi_admin_kit/

# Build distribution
uv build
```

## License

MIT

fastapi-admin-kit

File Explorer

# Use via CDN

# Project Badges

Was this content helpful?

Recent Feedback

Download README