adminsite

An admin panel for the SQLAlchemy 2.0 ORM that works with FastAPI, Starlette and Litestar.

Live demo · Documentation · Changelog · For AI assistants

adminsite is in alpha. It is tested and it works, but names may still change before 0.1.0, so pin the version you install.

Installation

pip install adminsite==0.1.0a16

Add the driver your database needs, such as asyncpg or aiosqlite.

Usage

from adminsite import Admin, Link, ModelView


class OrderView(ModelView[Order]):
    fields = [Order.id, Order.customer, Order.status, Order.total]
    searchable_fields = [
        Link(Order.customer, Customer.name),
        Link(Order.customer, Customer.email),
    ]
    list_filters = [Order.status, Order.created_at]


app.mount("/admin", Admin(engine, views=[OrderView]))

The settings name your models' own attributes, so a type checker catches a misspelt one. The labels, filters, form controls and validation come from your models. Getting started builds a complete app, signing in included, in a few minutes.

Features

• Pages from your models: a searchable, sortable list with filters and saved views, a page for each record, and forms with validation.
• Related records: pick a related record from a searchable list, and edit child rows, such as an order's lines, inside the parent's form.
• Built-in filters for choices, yes or no, number and date ranges, related records and text.
• Custom filters for anything the built-in ones do not cover, such as "overdue" or "spent over €1,000".
• Actions that run your own code on the selected rows, on every row the filters match, on one record or on the whole table, with a dialog for any values they need.
• Permissions for each view, action, field and row.
• Hooks that run your code before and after a save or delete, in the same transaction, and can refuse it with a message.
• An audit log: who changed what and when, including actions, exports and sign ins, with a history on every record and an activity page you can filter.
• Import from CSV or Excel with a preview of every row, and export to CSV.
• File and image uploads, stored on disk or wherever you choose.
• A dashboard of stats, charts and the latest records.
• A JSON API that shares the same views and permissions.
• Signing in with a fixed list of users or your own user table.
• Pages and plugins of your own, such as reports or settings, in the same layout.
• Translations, with Persian built in and right to left layouts, and every time shown in the reader's time zone.
• Light and dark themes, a layout for phones, and pages that work with a keyboard and a screen reader.
• Async or sync, on SQLite, Postgres and MySQL, with no N+1 queries.
• No Node and no CDN: everything ships inside the package.

How it works

adminsite is one ASGI app, mounted inside yours. Every page and the JSON API go through the ModelView you write for each model, so its rules hold everywhere.

Documentation

• Getting started sets up a working admin in a few minutes.
• Views covers everything a view can say about a model.
• Permissions is worth reading before you put the admin in front of anyone.
• The reference lists every class and option.

Contributing

Issues and pull requests are welcome. CONTRIBUTING.md says how to run the tests and rebuild the stylesheet.

License

MIT