Admin interface for SQLAlchemy.
Project description
SQLAlchemy Admin dashboard
SQLAdmin is a flexible Admin interface for SQLAlchemy models.
Main features include:
Documentation: https://aminalaee.github.io/sqladmin
Source Code: https://github.com/encode/starlette
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
from sqlalchemy.orm import sessionmaker
Base = declarative_base()
engine = create_engine(
"sqlite:///example.db",
connect_args={"check_same_thread": False},
)
Session = sessionmaker(bind=engine)
db = Session()
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, db)
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 starlette.applications import Starlette
from sqladmin import Admin, ModelAdmin
app = Starlette()
admin = Admin(app, db)
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.
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.1.0.tar.gz
(602.3 kB
view hashes)
Built Distribution
sqladmin-0.1.0-py3-none-any.whl
(606.8 kB
view hashes)