Skip to main content

Build Status Publish Status Coverage Package version Supported Python versions


SQLAlchemy Admin for Starlette/FastAPI

General info

SQLAdmin is a flexible Admin interface for SQLAlchemy models.

Main features include:


Documentation: https://smithyhq.github.io/sqladmin

Source Code: https://github.com/smithyhq/sqladmin

Live Demo: https://sqladmin-demo.vercel.app/admin (Username: superadmin Password: superadmin)


Installation

Install using pip:

$ pip install sqladmin

Some features need extra packages, which are grouped into optional extras:

Extra Installs Enables
auth itsdangerous Session-backed authentication
i18n babel Internationalization and localization
full both of the above Everything
$ pip install "sqladmin[auth]"
$ pip install "sqladmin[i18n]"
$ pip install "sqladmin[full]"

Screenshots

sqladmin-1 sqladmin-2

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.

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.31.0.tar.gz (1.0 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sqladmin-0.31.0-py3-none-any.whl (1.0 MB view details)

Uploaded Python 3

File details

Details for the file sqladmin-0.31.0.tar.gz.

File metadata

  • Download URL: sqladmin-0.31.0.tar.gz
  • Upload date:
  • Size: 1.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.12.2 {"installer":{"name":"uv","version":"0.12.2","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

Hashes for sqladmin-0.31.0.tar.gz
Algorithm Hash digest
SHA256 1b125cbdaf1aac75b13504a0bc7e6b4a1b2d6ffdc5e34272ac2a0c8b729c3e1b
MD5 1852cf29c7ea0e4c2527a4ec950c8852
BLAKE2b-256 c9688d333eefb54cfb531cf485026465abda62ecf0da86866dd0cef5d0c87a79

See more details on using hashes here.

File details

Details for the file sqladmin-0.31.0-py3-none-any.whl.

File metadata

  • Download URL: sqladmin-0.31.0-py3-none-any.whl
  • Upload date:
  • Size: 1.0 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.12.2 {"installer":{"name":"uv","version":"0.12.2","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

Hashes for sqladmin-0.31.0-py3-none-any.whl
Algorithm Hash digest
SHA256 28e980d048d88f372e552fb7b2770e510aab78872e8bf1b6adf19dcaea0716b7
MD5 d41e223ee0b8f595b43cef8917b2ccaa
BLAKE2b-256 661a882f69b61c218e10ce454a3122747a959621bc60321ae96b8d59adedb3e7

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page