SQLAlchemy Admin for Starlette/FastAPI
SQLAdmin is a flexible Admin interface for SQLAlchemy models.
Main features include:
- SQLAlchemy sync/async engines
- Starlette integration
- FastAPI integration
- SQLModel support
- Modern UI using Tabler
Documentation: https://aminalaee.github.io/sqladmin
Source Code: https://github.com/aminalaee/sqladmin
Online Demo: Demo
Installation
$ pip install sqladmin
Quickstart
Let's define an example SQLAlchemy model:
from sqlalchemy import Column, Integer, String, create_engine
from sqlalchemy.ext.declarative import declarative_base
Base = declarative_base()
engine = create_engine(
"sqlite:///example.db",
connect_args={"check_same_thread": False},
)
class User(Base):
__tablename__ = "users"
id = Column(Integer, primary_key=True)
name = Column(String)
Base.metadata.create_all(engine) # Create tables
If you want to use SQLAdmin with FastAPI:
from fastapi import FastAPI
from sqladmin import Admin, ModelAdmin
app = FastAPI()
admin = Admin(app, engine)
class UserAdmin(ModelAdmin, model=User):
column_list = [User.id, User.name]
admin.register_model(UserAdmin)
Or if you want to use SQLAdmin with Starlette:
from sqladmin import Admin, ModelAdmin
from starlette.applications import Starlette
app = Starlette()
admin = Admin(app, engine)
class UserAdmin(ModelAdmin, model=User):
column_list = [User.id, User.name]
admin.register_model(UserAdmin)
Now visiting /admin on your browser you can see the SQLAdmin interface.
Related projects and inspirations
- Flask-Admin Admin interface for Flask supporting different database backends and ORMs. This project has inspired SQLAdmin extensively and most of the features and configurations are implemented the same.
- FastAPI-Admin Admin interface for FastAPI which works with
TortoiseORM. - Dashboard Admin interface for ASGI frameworks which works with the
ormpackage.
14 Dec 5, 2022
225 Jan 5, 2023
562 Jan 1, 2023
63 Dec 30, 2022
465 Jan 7, 2023
1.4k Jan 2, 2023
228 Jan 2, 2023
14 May 2, 2021
300 Dec 26, 2022
229 Dec 21, 2022
9 Nov 20, 2022
1k Jan 2, 2023