starlette-admin
An extensible administrative interface framework for FastAPI and Starlette applications.
Installation
# Using uv
uv add starlette-admin
# Using pip
pip install starlette-admin
Quickstart
Get a fully functional administrative dashboard up and running in minutes. This example demonstrates an integration with FastAPI and SQLAlchemy.
from contextlib import asynccontextmanager
from datetime import datetime, timezone
from fastapi import FastAPI
from sqlalchemy import create_engine
from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column
from starlette_admin.contrib.sqla import Admin, ModelView
engine = create_engine("sqlite:///blog.db", connect_args={"check_same_thread": False})
class Base(DeclarativeBase):
pass
class Post(Base):
__tablename__ = "posts"
id: Mapped[int] = mapped_column(primary_key=True)
title: Mapped[str]
content: Mapped[str]
published: Mapped[bool] = mapped_column(default=False)
created_at: Mapped[datetime] = mapped_column(
default=lambda: datetime.now(timezone.utc)
)
class PostView(ModelView):
fields = ["id", "title", "content", "published", "created_at"]
searchable_fields = ("title", "content")
@asynccontextmanager
async def lifespan(app: FastAPI):
Base.metadata.create_all(engine)
yield
app = FastAPI(lifespan=lifespan)
admin = Admin(engine, title="Blog Admin", secret_key="change-me")
admin.add_view(PostView(Post, icon="fa fa-newspaper"))
admin.mount_to(app)
Run with fastapi dev and open http://127.0.0.1:8000/admin.
Features
- Generated CRUD pages for your models
- Pagination, sorting, search, and shareable URLs
- Nested AND/OR filter builder
- Inline editing for related models
- Bulk actions and custom row actions
- CSV, Excel, JSON, and PDF export
- CSV, JSON and Excel import with dry-run validation
- Local and S3-compatible file storage (Amazon S3, MinIO, ...)
- Event hooks before and after CRUD operations
- Pluggable authentication, storage, fields, actions, and model views
- Theme customization, dark mode, internationalization, and timezone support
Supported ORMs & Backends
starlette-admin is built to be agnostic. It ships with built-in support for popular ORMs and databases:
| Backend | Package Path |
|---|---|
| SQLAlchemy | starlette_admin.contrib.sqla |
| SQLModel | starlette_admin.contrib.sqlmodel |
| Tortoise ORM | starlette_admin.contrib.tortoise |
| Beanie (MongoDB) | starlette_admin.contrib.beanie |
| MongoEngine | starlette_admin.contrib.mongoengine |
| Custom Data Sources | Subclass BaseModelView |
Documentation & Resources
- Full Documentation
- Quickstart Guide
- User Guide (Covers views, fields, filters, actions, and auth)
- API Reference
Live Demo
Explore the interface in action: starlette-admin-demo.jowilf.com
Contributing
Contributions are always welcome! Whether it is reporting a bug, discussing improvements, or submitting a pull request, your input helps make this project better.
Please review our CONTRIBUTING.md guidelines before opening a pull request.
License
This project is licensed under the MIT License.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file starlette_admin-1.0.0.tar.gz.
File metadata
- Download URL: starlette_admin-1.0.0.tar.gz
- Upload date:
- Size: 1.2 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.12.5 {"installer":{"name":"uv","version":"0.12.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d15b76f120934756e1604fd5f02adf12535e4288edab5db3aad80bfb2879e5b3
|
|
| MD5 |
9115d451f08cb5ee77efdbf5119d4313
|
|
| BLAKE2b-256 |
83d0cead64b8e0cd1659e04f290dd7b41e7d7d1474c771b86fbf1b71d17f0ef5
|
File details
Details for the file starlette_admin-1.0.0-py3-none-any.whl.
File metadata
- Download URL: starlette_admin-1.0.0-py3-none-any.whl
- Upload date:
- Size: 1.4 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.12.5 {"installer":{"name":"uv","version":"0.12.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
fbda5d19910d633e1bd155b52c0821e78c9a32e02a91f532429759455eb25d1b
|
|
| MD5 |
9783f3b3db7ec3da0a359f0eb2f227ba
|
|
| BLAKE2b-256 |
5c52ebcbd7f11d509b61d6079a17a7be28588c78d8a4e2f3c2c12f3ef55914e0
|
