SQLAlchemy admin for FastAPI and Starlette
Project description
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
- WTForms form building
- SQLModel support
- UI using Tabler
Documentation: https://aminalaee.dev/sqladmin
Source Code: https://github.com/aminalaee/sqladmin
Online Demo: Demo
Installation
Install using pip
:
$ pip install sqladmin
This will install the full version of sqladmin with optional dependencies:
$ pip install "sqladmin[full]"
Screenshots
Quickstart
Let's define an example SQLAlchemy model:
from sqlalchemy import Column, Integer, String, create_engine
from sqlalchemy.orm 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, ModelView
app = FastAPI()
admin = Admin(app, engine)
class UserAdmin(ModelView, model=User):
column_list = [User.id, User.name]
admin.add_view(UserAdmin)
Or if you want to use SQLAdmin
with Starlette
:
from sqladmin import Admin, ModelView
from starlette.applications import Starlette
app = Starlette()
admin = Admin(app, engine)
class UserAdmin(ModelView, model=User):
column_list = [User.id, User.name]
admin.add_view(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
orm
package.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
sqladmin-0.16.1.tar.gz
(543.9 kB
view hashes)
Built Distribution
sqladmin-0.16.1-py3-none-any.whl
(559.1 kB
view hashes)
Close
Hashes for sqladmin-0.16.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | eb90d453740a5749e5f9701e1d4d35d4db9c54f5d907f0705873e2aa0ac2913f |
|
MD5 | 7757d92b7c369eb879009d87f16ef809 |
|
BLAKE2b-256 | 68dbd8ef9dd3739e271568ebab6870cfdfc8dddbc189fe79742da0eb3b8bb9d9 |