brilliance-admin 0.43.7__tar.gz → 0.44.0__tar.gz

{brilliance_admin-0.43.7 → brilliance_admin-0.44.0}/.github/workflows/certbot.yml

@@ -7,20 +7,29 @@ jobs:
   setup-https:
     runs-on: ubuntu-latest
     steps:
-      - name: Setup HTTPS with certbot
+      - name: Setup HTTPS with certbot (snap)
         uses: appleboy/ssh-action@master
         with:
           host: ${{ vars.SERVER_HOST }}
           username: deploy
           key: ${{ secrets.SERVER_SSH_KEY }}
           script: |
-            if ! command -v certbot >/dev/null 2>&1; then
+            sudo apt remove -y certbot python3-certbot-nginx || true
+
+            if ! command -v snap >/dev/null 2>&1; then
               sudo apt update
-              sudo apt install -y certbot python3-certbot-nginx
+              sudo apt install -y snapd
             fi
+
+            sudo snap install core || sudo snap refresh core
+            sudo snap install --classic certbot || true
+            sudo ln -sf /snap/bin/certbot /usr/bin/certbot
+
             sudo certbot --nginx \
               -d brilliance-admin.com \
               -d www.brilliance-admin.com \
+              -d docs.brilliance-admin.com \
+              --expand \
               --non-interactive \
               --agree-tos \
               -m admin@brilliance-admin.com \

brilliance_admin-0.44.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Brilliance Admin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NON INFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

{brilliance_admin-0.43.7 → brilliance_admin-0.44.0}/PKG-INFO

@@ -1,8 +1,8 @@
 Metadata-Version: 2.4
 Name: brilliance-admin
-Version: 0.43.7
-Summary: Simple and lightweight admin panel framework powered by FastAPI and Vue3 Vuetify together. Some call it heavenly in its brilliance.
-License-Expression: AGPL-3.0
+Version: 0.44.0
+Summary: Simple and lightweight data managment framework powered by FastAPI and Vue3 Vuetify all-in-one. Some call it heavenly in its brilliance.
+License-Expression: MIT
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
@@ -37,58 +37,69 @@ Dynamic: license-file
 [![PyPI](https://img.shields.io/pypi/v/brilliance-admin)](https://pypi.org/project/brilliance-admin/)
 [![CI](https://github.com/brilliance-admin/backend-python/actions/workflows/deploy.yml/badge.svg)](https://github.com/brilliance-admin/backend-python/actions)
 
-Simple and lightweight admin panel framework powered by `FastAPI` and `Vue3` `Vuetify` together. \
+Simple and lightweight data managment 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._
 
-### [Live Demo](https://brilliance-admin.com/) | [Demo Sources](https://github.com/brilliance-admin/backend-python/tree/main/example) | Documentation (todo)
+### [Live Demo](https://brilliance-admin.com/) | [Demo Sources](https://github.com/brilliance-admin/backend-python/tree/main/example) | [Documentation](https://docs.brilliance-admin.com/)
 
   <img src="https://github.com/brilliance-admin/backend-python/blob/main/screenshots/websitemockupgenerator.png?raw=true"
        alt="Preview">
 
 </div>
 
-**Key ideas:**
-- **API oriented**\
-Works entirely on FastAPI and provides a prebuilt SPA [frontend](https://github.com/brilliance-admin/frontend) via static files (Vue3 + Vuetify). No separate startup is required.
-> 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**\
+### Brilliance Admin provides
+
+A quick way to create a data management interface using:
+
+- Admin page - endpoint with a prebuilt SPA [frontend Vue3 + Vuetify](https://github.com/brilliance-admin/frontend) <br>
+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)
+
+## Key ideas
+
+- **API Oriented** <br>
+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**  <br>
 Providing rich and convenient ways to display and manage data (tables, charts, etc) from any data source.
-- **ORM**\
-Automatic schema generation and methods for CRUD operations.
-- **Minimal boilerplate**\
+- **UI JSON Schema** <br>
+Represents the data describing the structure of entire admin panel UI. <br>
+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** <br>
+Automatic generation from ORM for schema UI frontend and backend methods for CRUD operations.
+- **Minimal boilerplate** <br>
 Focused on simplified, but rich configuration.
 
-**How it works:**
-- After authentication, the user receives the admin panel schema, and the frontend renders it
-- The frontend communicates with the backend via API to fetch and modify data
-
-### Features:
+## 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
-* Authorization via any account data source
+* 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
 
-## How to use it
-
-Installation:
+## Installation:
 ``` shell
 pip install brilliance-admin
 ```
 
+## Usage example
+
 You need to generate `AdminSchema` instance:
 ``` python
 from brilliance_admin import schema
@@ -101,11 +112,9 @@ class CategoryExample(schema.CategoryTable):
 admin_schema = schema.AdminSchema(
     title='Admin Panel',
     auth=YourAdminAuthentication(),
-    groups=[
-        schema.Group(
+    categories=[
+        schema.Category(
             slug='example',
-            title='Example',
-            icon='mdi-star',
             categories=[
                 CategoryExample(),
             ]
@@ -115,98 +124,27 @@ admin_schema = schema.AdminSchema(
 
 admin_app = admin_schema.generate_app()
 
-# Your FastAPI app
+# Your FastAPI app (Any ASGI framework can be used)
 app = FastAPI()
 app.mount('/admin', admin_app)
 ```
 
-## SQLAlchemy integration
-
-Supports automatic schema generation for CRUD tables:
-
-``` python
-category = sqlalchemy.SQLAlchemyAdmin(db_async_session=async_sessionmaker, model=Terminal)
-```
-
-> [!NOTE]
-> If `table_schema` is not specified, it will be generated automatically with all discovered fields and relationships
-
-Now, the `category` instance can be passed to `categories`.
-
-### DRF class style schema
-
-``` python
-from brilliance_admin import sqlalchemy
-from brilliance_admin.translations import TranslateText as _
-
-from your_project.models import Terminal
-
-
-class TerminalFiltersSchema(sqlalchemy.SQLAlchemyFieldsSchema):
-    model = Terminal
-    fields = ['id', 'created_at']
-    created_at = schema.DateTimeField(range=True)
-
-
-class TerminalSchema(sqlalchemy.SQLAlchemyFieldsSchema):
-    model = Terminal
-    list_display = ['id', 'merchant_id']
-
-
-class TerminalAdmin(sqlalchemy.SQLAlchemyAdmin):
-    db_async_session = async_sessionmaker
-    model = Terminal
-    title = _('terminals')
-    icon = 'mdi-console-network-outline'
-    
-    ordering_fields = ['id']
-    search_fields = ['id', 'title']
-
-    table_schema = TerminalSchema()
-    table_filters = TerminalFiltersSchema()
-
-
-category = TerminalAdmin()
-```
-
-### Can be used both via inheritance and instancing
+For more details, check out our [how-to-start documentation](https://docs.brilliance-admin.com/how-to-start/)
 
-Optionally, functional-style generation can be used to reduce boilerplate code
-
-Availiable for `SQLAlchemyAdmin` and `SQLAlchemyFieldsSchema`
-
-``` python
-category = sqlalchemy.SQLAlchemyAdmin(
-    db_async_session=async_sessionmaker,
-    model=Terminal,
-
-    table_schema = sqlalchemy.SQLAlchemyFieldsSchema(
-        model=Terminal, 
-        list_display=['id', 'merchant_id'],
-    ),
-    table_filters = sqlalchemy.SQLAlchemyFieldsSchema(
-        model=Terminal, 
-        fields=['id', 'created_at'],
-        created_at=schema.DateTimeField(range=True),
-    ),
-)
-```
+## Comparison of Similar Projects
 
-### SQLAlchemy JWT Authentication
+The project closest in concept is [React Admin](https://github.com/marmelab/react-admin). <br>
+It is an SPA frontend that store the schema UI inside and works with separate API backend providers.
 
-``` python
-auth = sqlalchemy.SQLAlchemyJWTAdminAuthentication(
-    secret='auth_secret',
-    db_async_session=async_session,
-    user_model=User,
-)
-```
+The key difference of Brilliance Admin is that its all-in-one. <br>
+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 Projects
+## Comparison of Similar Python Projects
 
 | Criterion | Brilliance Admin | Django Admin | FastAPI Admin | Starlette Admin | SQLAdmin |
-|---------|------------------|---------------------|---------------|-----------------|----------|
-| Base framework | FastAPI | Django | FastAPI | Starlette / FastAPI | FastAPI / Starlette |
+|---------|------------------|--------------|---------------|-----------------|----------|
+| 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 |

{brilliance_admin-0.43.7 → brilliance_admin-0.44.0}/README.md

@@ -6,58 +6,69 @@
 [![PyPI](https://img.shields.io/pypi/v/brilliance-admin)](https://pypi.org/project/brilliance-admin/)
 [![CI](https://github.com/brilliance-admin/backend-python/actions/workflows/deploy.yml/badge.svg)](https://github.com/brilliance-admin/backend-python/actions)
 
-Simple and lightweight admin panel framework powered by `FastAPI` and `Vue3` `Vuetify` together. \
+Simple and lightweight data managment 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._
 
-### [Live Demo](https://brilliance-admin.com/) | [Demo Sources](https://github.com/brilliance-admin/backend-python/tree/main/example) | Documentation (todo)
+### [Live Demo](https://brilliance-admin.com/) | [Demo Sources](https://github.com/brilliance-admin/backend-python/tree/main/example) | [Documentation](https://docs.brilliance-admin.com/)
 
   <img src="https://github.com/brilliance-admin/backend-python/blob/main/screenshots/websitemockupgenerator.png?raw=true"
        alt="Preview">
 
 </div>
 
-**Key ideas:**
-- **API oriented**\
-Works entirely on FastAPI and provides a prebuilt SPA [frontend](https://github.com/brilliance-admin/frontend) via static files (Vue3 + Vuetify). No separate startup is required.
-> 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**\
+### Brilliance Admin provides
+
+A quick way to create a data management interface using:
+
+- Admin page - endpoint with a prebuilt SPA [frontend Vue3 + Vuetify](https://github.com/brilliance-admin/frontend) <br>
+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)
+
+## Key ideas
+
+- **API Oriented** <br>
+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**  <br>
 Providing rich and convenient ways to display and manage data (tables, charts, etc) from any data source.
-- **ORM**\
-Automatic schema generation and methods for CRUD operations.
-- **Minimal boilerplate**\
+- **UI JSON Schema** <br>
+Represents the data describing the structure of entire admin panel UI. <br>
+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** <br>
+Automatic generation from ORM for schema UI frontend and backend methods for CRUD operations.
+- **Minimal boilerplate** <br>
 Focused on simplified, but rich configuration.
 
-**How it works:**
-- After authentication, the user receives the admin panel schema, and the frontend renders it
-- The frontend communicates with the backend via API to fetch and modify data
-
-### Features:
+## 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
-* Authorization via any account data source
+* 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
 
-## How to use it
-
-Installation:
+## Installation:
 ``` shell
 pip install brilliance-admin
 ```
 
+## Usage example
+
 You need to generate `AdminSchema` instance:
 ``` python
 from brilliance_admin import schema
@@ -70,11 +81,9 @@ class CategoryExample(schema.CategoryTable):
 admin_schema = schema.AdminSchema(
     title='Admin Panel',
     auth=YourAdminAuthentication(),
-    groups=[
-        schema.Group(
+    categories=[
+        schema.Category(
             slug='example',
-            title='Example',
-            icon='mdi-star',
             categories=[
                 CategoryExample(),
             ]
@@ -84,98 +93,27 @@ admin_schema = schema.AdminSchema(
 
 admin_app = admin_schema.generate_app()
 
-# Your FastAPI app
+# Your FastAPI app (Any ASGI framework can be used)
 app = FastAPI()
 app.mount('/admin', admin_app)
 ```
 
-## SQLAlchemy integration
-
-Supports automatic schema generation for CRUD tables:
-
-``` python
-category = sqlalchemy.SQLAlchemyAdmin(db_async_session=async_sessionmaker, model=Terminal)
-```
-
-> [!NOTE]
-> If `table_schema` is not specified, it will be generated automatically with all discovered fields and relationships
-
-Now, the `category` instance can be passed to `categories`.
-
-### DRF class style schema
-
-``` python
-from brilliance_admin import sqlalchemy
-from brilliance_admin.translations import TranslateText as _
-
-from your_project.models import Terminal
-
-
-class TerminalFiltersSchema(sqlalchemy.SQLAlchemyFieldsSchema):
-    model = Terminal
-    fields = ['id', 'created_at']
-    created_at = schema.DateTimeField(range=True)
-
-
-class TerminalSchema(sqlalchemy.SQLAlchemyFieldsSchema):
-    model = Terminal
-    list_display = ['id', 'merchant_id']
-
-
-class TerminalAdmin(sqlalchemy.SQLAlchemyAdmin):
-    db_async_session = async_sessionmaker
-    model = Terminal
-    title = _('terminals')
-    icon = 'mdi-console-network-outline'
-    
-    ordering_fields = ['id']
-    search_fields = ['id', 'title']
-
-    table_schema = TerminalSchema()
-    table_filters = TerminalFiltersSchema()
-
-
-category = TerminalAdmin()
-```
-
-### Can be used both via inheritance and instancing
+For more details, check out our [how-to-start documentation](https://docs.brilliance-admin.com/how-to-start/)
 
-Optionally, functional-style generation can be used to reduce boilerplate code
-
-Availiable for `SQLAlchemyAdmin` and `SQLAlchemyFieldsSchema`
-
-``` python
-category = sqlalchemy.SQLAlchemyAdmin(
-    db_async_session=async_sessionmaker,
-    model=Terminal,
-
-    table_schema = sqlalchemy.SQLAlchemyFieldsSchema(
-        model=Terminal, 
-        list_display=['id', 'merchant_id'],
-    ),
-    table_filters = sqlalchemy.SQLAlchemyFieldsSchema(
-        model=Terminal, 
-        fields=['id', 'created_at'],
-        created_at=schema.DateTimeField(range=True),
-    ),
-)
-```
+## Comparison of Similar Projects
 
-### SQLAlchemy JWT Authentication
+The project closest in concept is [React Admin](https://github.com/marmelab/react-admin). <br>
+It is an SPA frontend that store the schema UI inside and works with separate API backend providers.
 
-``` python
-auth = sqlalchemy.SQLAlchemyJWTAdminAuthentication(
-    secret='auth_secret',
-    db_async_session=async_session,
-    user_model=User,
-)
-```
+The key difference of Brilliance Admin is that its all-in-one. <br>
+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 Projects
+## Comparison of Similar Python Projects
 
 | Criterion | Brilliance Admin | Django Admin | FastAPI Admin | Starlette Admin | SQLAdmin |
-|---------|------------------|---------------------|---------------|-----------------|----------|
-| Base framework | FastAPI | Django | FastAPI | Starlette / FastAPI | FastAPI / Starlette |
+|---------|------------------|--------------|---------------|-----------------|----------|
+| 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 |

{brilliance_admin-0.43.7 → brilliance_admin-0.44.0}/brilliance_admin/schema/__init__.py

@@ -1,7 +1,7 @@
 # pylint: disable=wildcard-import, unused-wildcard-import, unused-import
 # flake8: noqa: F405
 from .admin_schema import AdminSchema, AdminSchemaData
-from .category import Category
+from .category import CategoryGroup, CategoryLink
 from .graphs import *
-from .group import Group
 from .table import *
+from .table.category_table import CategoryTable

{brilliance_admin-0.43.7 → brilliance_admin-0.44.0}/brilliance_admin/schema/admin_schema.py

@@ -7,11 +7,12 @@ from urllib.parse import urljoin
 from fastapi import FastAPI, Request
 from fastapi.middleware.cors import CORSMiddleware
 from fastapi.staticfiles import StaticFiles
+from pydantic import Field
 from pydantic.dataclasses import dataclass
 
 from brilliance_admin.auth import UserABC
 from brilliance_admin.docs import build_redoc_docs, build_scalar_docs
-from brilliance_admin.schema.group import Group, GroupSchemaData
+from brilliance_admin.schema.category import BaseCategory, CategorySchemaData
 from brilliance_admin.translations import LanguageContext, LanguageManager
 from brilliance_admin.utils import DataclassBase, SupportsStr
 
@@ -23,8 +24,8 @@ DEFAULT_LANGUAGES = {
 
 @dataclass
 class AdminSchemaData(DataclassBase):
-    groups: Dict[str, GroupSchemaData]
     profile: UserABC | Any
+    categories: Dict[str, CategorySchemaData] = Field(default_factory=dict)
 
     def __post_init__(self):
         if not isinstance(self.profile, UserABC):
@@ -50,7 +51,7 @@ class AdminIndexContextData(DataclassBase):
 
 @dataclass
 class AdminSchema:
-    groups: List[Group]
+    categories: List[BaseCategory]
     auth: Any
 
     title: SupportsStr | None = 'Admin'
@@ -68,9 +69,9 @@ class AdminSchema:
     language_manager: LanguageManager | None = None
 
     def __post_init__(self):
-        for group in self.groups:
-            if not issubclass(group.__class__, Group):
-                raise TypeError(f'Group "{group}" is not instance of Group subclass')
+        for category in self.categories:
+            if not issubclass(category.__class__, BaseCategory):
+                raise TypeError(f'Root category "{category}" is not instance of BaseCategory subclass')
 
         if not self.language_manager:
             self.language_manager = LanguageManager(DEFAULT_LANGUAGES)
@@ -81,24 +82,25 @@ class AdminSchema:
     def generate_schema(self, user: UserABC, language_slug: str | None) -> AdminSchemaData:
         language_context: LanguageContext = self.get_language_context(language_slug)
 
-        groups = {}
+        result = AdminSchemaData(profile=user)
 
-        for group in self.groups:
-            if not group.slug:
-                msg = f'Category group {type(group).__name__}.slug is empty'
+        for category in self.categories:
+            if not category.slug:
+                msg = f'Category {type(category).__name__}.slug is empty'
                 raise AttributeError(msg)
 
-            groups[group.slug] = group.generate_schema(user, language_context)
+            try:
+                result.categories[category.slug] = category.generate_schema(user, language_context).to_dict(keep_none=False)
+            except Exception as e:
+                msg = f'Root category "{category.slug}" generate_schema error: {e}'
+                raise Exception(msg) from e
 
-        return AdminSchemaData(
-            groups=groups,
-            profile=user,
-        )
+        return result
 
-    def get_group(self, group_slug: str) -> Optional[Group]:
-        for group in self.groups:
-            if group.slug == group_slug:
-                return group
+    def get_group(self, group_slug: str) -> Optional[BaseCategory]:
+        for category in self.categories:
+            if category.slug == group_slug:
+                return category
 
         return None