Skip to content

Simple and lightweight data managment framework powered by FastAPI and Vue3 Vuetify all-in-one. Some call it heavenly in its brilliance.

License

Notifications You must be signed in to change notification settings

brilliance-admin/backend-python

Repository files navigation

Brilliance Admin

PyPI CI

Simple and lightweight data management framework powered by FastAPI and Vue3 Vuetify all-in-one.
Integrated with SQLAlchemy. Inspaired by Django Admin and DRF.
Some call it heavenly in its brilliance.

Preview

Brilliance Admin provides

A quick way to create a data management interface using:

  • Admin page - endpoint with a prebuilt SPA frontend Vue3 + Vuetify
    This endpoint can be added to any ASGI compatable backend. For existing project or standalone admin app.
  • API to fetch the UI JSON schema
  • API methods for that UI to work with (to read and modify data)

Screenshots

Key ideas

  • API Oriented
    Data generation/updating API separated from rendering fontend with zero hardcode, this makes it possible to have a single frontend with multiple backend implementations in different languages and makes test coverage easier.
  • Rich visualization
    Providing rich and convenient ways to display and manage data (tables, charts, etc) from any data source.
  • UI JSON Schema
    Represents the data describing the structure of entire admin panel UI.
    You only need to specify what should be rendered. The frontend will display it and automatically request data from the backend for rendering or updates.
  • ORM
    Automatic generation from ORM for schema UI frontend and backend methods for CRUD operations.
  • Minimal boilerplate
    Focused on simplified, but rich configuration.

Features

  • Tables with full CRUD support, including filtering, sorting, and pagination.
  • Ability to define custom table actions with forms, response messages, and file downloads.
  • Graphs via ChartJS
  • Localization support
  • Adapted for different screen sizes and mobile devices
  • Auth via any account data source

Integrations:

  • SQLAlchemy - schema autogeneration for tables + CRUD operations + authorization

Planned:

  • Dashboard features
  • Role-based access permissions system via interface
  • Backend interface for storing and viewing action history in the admin interface
  • Nested data support for creation and detail views (inline editing), nested CRUD workflows
  • Django ORM integration
  • Support for Oauth providers

Installation:

pip install brilliance-admin

Usage example

You need to generate AdminSchema instance:

from brilliance_admin import schema


class CategoryExample(schema.CategoryTable):
    "Implementation of get_list and retrieve; update and create are optional"


admin_schema = schema.AdminSchema(
    title='Admin Panel',
    auth=YourAdminAuthentication(),
    categories=[
        schema.Category(
            slug='example',
            categories=[
                CategoryExample(),
            ]
        ),
    ],
)

admin_app = admin_schema.generate_app()

# Your FastAPI app (Any ASGI framework can be used)
app = FastAPI()
app.mount('/admin', admin_app)

For more details, check out our how-to-start documentation

Comparison of Similar Projects

The project closest in concept is React Admin.
It is an SPA frontend that store the schema UI inside and works with separate API backend providers.

The key difference of Brilliance Admin is that its all-in-one.
It is more focused on rapid setup for data management, without the need to work with frontend configuration, while it still available.

Comparison of Similar Python Projects

Criterion Brilliance Admin Django Admin FastAPI Admin Starlette Admin SQLAdmin
Base framework FastAPI Django FastAPI Starlette FastAPI
ASGI compatible Yes Partial Yes Yes Yes
Rendering model Prebuilt Vue 3 + Vuetify SPA + Jinja2 Server-side Django templates Server-side Jinja2 templates + Tabler UI Server-side Jinja2 templates + Tabler UI Server-side Jinja2 templates + Bootstrap
Frontend architecture Separate frontend (SPA) Classic server-rendered UI Server-rendered UI with JS interactivity Server-rendered UI with JS interactivity Server-rendered UI
Data source Any source + SQLAlchemy Django ORM Tortoise ORM Any source + SQLAlchemy, MongoDB SQLAlchemy
Multiple databases per model Yes Database routers No (global engine) Yes (session per ModelView) No (single engine per Admin)
Schema generation User-defined format From Django models From ORM models User-defined format From SQLAlchemy models
Async support Yes No Yes Yes Yes
API-first approach Yes No Partially Partially No
Built-in Localization Yes Yes No No No

About

Simple and lightweight data managment framework powered by FastAPI and Vue3 Vuetify all-in-one. Some call it heavenly in its brilliance.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published