ilya-green / starlette-admin Goto Github PK

View Code? Open in Web Editor NEW

Fast, beautiful and extensible administrative interface framework for Starlette & FastApi applications

License: MIT License

Shell 0.03% JavaScript 10.71% Python 75.76% CSS 0.12% HTML 13.39%

starlette-admin's Introduction

starlette-admin

Starlette-Admin is a fast, beautiful and extensible administrative interface framework for Starlette/FastApi applications.

Getting started

Check out the documentation.
Try the live demo. (Source code)
Try the several usage examples included in the /examples folder
If you find this project helpful or interesting, please consider giving it a star ⭐️

Features

CRUD any data with ease
Automatic form validation
Advanced table widget with Datatables
Search and filtering
Search highlighting
Multi-column ordering
Export data to CSV/EXCEL/PDF and Browser Print
Authentication
Authorization
Manage Files
Custom views
Custom batch actions
Supported ORMs
- SQLAlchemy
- SQLModel
- MongoEngine
- ODMantic
- Custom backend (doc, example)
Internationalization

Installation

PIP

$ pip install starlette-admin

Poetry

$ poetry add starlette-admin

Example

This is a simple example with SQLAlchemy model

from sqlalchemy import Column, Integer, String, create_engine
from sqlalchemy.ext.declarative import declarative_base
from starlette.applications import Starlette
from starlette_admin.contrib.sqla import Admin, ModelView

Base = declarative_base()
engine = create_engine("sqlite:///test.db", connect_args={"check_same_thread": False})


# Define your model
class Post(Base):
    __tablename__ = "posts"

    id = Column(Integer, primary_key=True)
    title = Column(String)


Base.metadata.create_all(engine)

app = Starlette()  # FastAPI()

# Create admin
admin = Admin(engine, title="Example: SQLAlchemy")

# Add view
admin.add_view(ModelView(Post))

# Mount admin to your app
admin.mount_to(app)