sqladmin-litestar-plugin

Overview

The SQLAdminPlugin integrates SQLAdmin with a Litestar application.

Installation

To install the dependencies, run:

pip install sqladmin-litestar-plugin

Usage

To use the plugin, import the SQLAdminPlugin class and pass it to the Litestar application.

By default, the plugin will create a new admin interface at /admin.

Example

from litestar import Litestar
from sqladmin import ModelView
from sqladmin_litestar_plugin import SQLAdminPlugin
from sqlalchemy import Column, Integer, String
from sqlalchemy.ext.asyncio import create_async_engine
from sqlalchemy.orm import declarative_base


engine = create_async_engine("sqlite+aiosqlite:///example.db")
Base = declarative_base()


class User(Base):
    __tablename__ = "users"

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


class UserAdmin(ModelView, model=User):
    column_list = [User.id, User.name]


async def on_startup() -> None:
    async with engine.begin() as conn:
        await conn.run_sync(Base.metadata.create_all)  # Create tables


admin = SQLAdminPlugin(views=[UserAdmin], engine=engine)
app = Litestar(plugins=[admin], on_startup=[on_startup])

Configuration

The SQLAdminPlugin accepts the following arguments:

• views: A sequence of ModelView classes to add to the admin app. Each ModelView class configures the interface for a SQL model.
• engine: An SQLAlchemy engine to connect to your database.
• sessionmaker: An SQLAlchemy sessionmaker instance used to manage sessions.
• base_url: The base URL where the admin app will be hosted.
• title: The title of the admin app, which appears in the browser's title bar and the header of the admin interface.
• logo_url: The URL of the logo to display in the admin app, enhancing brand visibility.
• templates_dir: The directory containing the Jinja2 templates for the admin interface, allowing for customization of the UI.
• middlewares: A sequence of Starlette middlewares to add to the admin app, useful for handling requests or adding additional functionality.
• authentication_backend: An authentication backend to secure the admin app, managing user authentication and authorization.

Views are not added to the admin app until the Litestar application is instantiated, so you can append views to the views list until this point.

TO DO

• An AuthenticationBackend that integrates with Litestar's session authentication.