Skip to main content

Fork of SQLAdmin with custom modifications

Project description

Build Status Publish Status Coverage Package version Supported Python versions


SQLAlchemy Admin for Starlette/FastAPI

SQLAdmin is a flexible Admin interface for SQLAlchemy models.

Main features include:


Documentation: https://aminalaee.github.io/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

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.

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

sqladmin_whiteleads-1.4.0.7.tar.gz (1.4 MB view details)

Uploaded Source

Built Distribution

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

sqladmin_whiteleads-1.4.0.7-py3-none-any.whl (1.4 MB view details)

Uploaded Python 3

File details

Details for the file sqladmin_whiteleads-1.4.0.7.tar.gz.

File metadata

  • Download URL: sqladmin_whiteleads-1.4.0.7.tar.gz
  • Upload date:
  • Size: 1.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.11

File hashes

Hashes for sqladmin_whiteleads-1.4.0.7.tar.gz
Algorithm Hash digest
SHA256 f378dd66c2b577b48d0c8589b52ec39980609971d6d7b58cb11317f45192d9f5
MD5 59392c63436b7dfb705758556f7ab246
BLAKE2b-256 5b08f07861d108ed8351afa8a1449cc4f212d186f1f23a550383cba959409da7

See more details on using hashes here.

File details

Details for the file sqladmin_whiteleads-1.4.0.7-py3-none-any.whl.

File metadata

File hashes

Hashes for sqladmin_whiteleads-1.4.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 bd27764b9641b142dca91888df6835de843a4dc0337247d8d3cca7be1023d570
MD5 b06fa06320b1d74b9e5d6c4fe81146e5
BLAKE2b-256 f9144bef15519686b9dffa630519710aaf22038334a194d4e14b23f86fd0e6e2

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