Skip to main content

Fork of SQLAlchemy 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

sqlalchemy_whiteleads-1.4.0.2.tar.gz (49.3 kB view details)

Uploaded Source

Built Distribution

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

sqlalchemy_whiteleads-1.4.0.2-py3-none-any.whl (42.0 kB view details)

Uploaded Python 3

File details

Details for the file sqlalchemy_whiteleads-1.4.0.2.tar.gz.

File metadata

  • Download URL: sqlalchemy_whiteleads-1.4.0.2.tar.gz
  • Upload date:
  • Size: 49.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.11

File hashes

Hashes for sqlalchemy_whiteleads-1.4.0.2.tar.gz
Algorithm Hash digest
SHA256 cb7fc855d098c904b099ef96bf6d005033a03fcc9c900b2d7ad870dda5d22c42
MD5 38285ed0ba8a0f7943032d67be03683d
BLAKE2b-256 19b2ddb594c21b608fb8f6734bbd78b918d13a2bcd6fbfe9f66cc5dd23c2ebcf

See more details on using hashes here.

File details

Details for the file sqlalchemy_whiteleads-1.4.0.2-py3-none-any.whl.

File metadata

File hashes

Hashes for sqlalchemy_whiteleads-1.4.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 7b91cb0a126c35a3f94b64abb800348a709b7749c38a811d7ba0768535e10797
MD5 f4edaeaa7b52d14387b72f7bc5eda7b0
BLAKE2b-256 dac8aea5d941e5feddd37492e3118921066beeb8b097dcd3c7dc3f6ac100933c

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