Skip to main content

React SPA admin for SQLAlchemy with FastAPI and Starlette

Project description

Build Status


spa-sqladmin: React SPA Admin for Starlette/FastAPI

spa-sqladmin is a modern React SPA rewrite of sqladmin providing a better UI/UX.

Main features include:


Installation

$ pip install spa-sqladmin

Or with uv:

$ uv add spa-sqladmin

Screenshots

spa-sqladmin-screenshot-1 spa-sqladmin-screenshot-2 spa-sqladmin-screenshot-3

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 spa_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 spa_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.

Find an extensive example in the example folder.

For a full overview of Admin(...) parameters, icon formats, palette syntax, and custom admin patterns, see docs/USAGE.md.

Acknowledgements

This project would not have been possible without sqladmin.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

spa_sqladmin-0.1.0.tar.gz (246.5 kB view details)

Uploaded Source

Built Distribution

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

spa_sqladmin-0.1.0-py3-none-any.whl (255.0 kB view details)

Uploaded Python 3

File details

Details for the file spa_sqladmin-0.1.0.tar.gz.

File metadata

  • Download URL: spa_sqladmin-0.1.0.tar.gz
  • Upload date:
  • Size: 246.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.2 {"installer":{"name":"uv","version":"0.11.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 spa_sqladmin-0.1.0.tar.gz
Algorithm Hash digest
SHA256 27b3a89b5f0e4c71c8ae57f304acf8aab13c930762f9b4fe5eb840ee6b962a16
MD5 00a88d392c6e3c78983f3148db5a24a9
BLAKE2b-256 b293a2fa718caa912ad5d7240fd079da82b14f0b51682c17565de56df6d736ee

See more details on using hashes here.

File details

Details for the file spa_sqladmin-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: spa_sqladmin-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 255.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.2 {"installer":{"name":"uv","version":"0.11.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 spa_sqladmin-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 382879694577da7d30c6f7b99dab6633c06eb499e449900cab14a3d8ec70bf12
MD5 94c9b31dff40c6143aa5412aed4107a4
BLAKE2b-256 33c49181f9a44914a865cb0d84c9610dd49659dfd7752032c34d4b207e5c1128

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 Pingdom Monitoring Sentry Error logging StatusPage Status page