brilliance-admin 0.40.0__tar.gz → 0.41.0__tar.gz

brilliance_admin-0.41.0/PKG-INFO

@@ -0,0 +1,155 @@
+Metadata-Version: 2.4
+Name: brilliance-admin
+Version: 0.41.0
+Summary: General-purpose admin panel framework powered by FastAPI. Some call it heavenly in its brilliance.
+License-Expression: AGPL-3.0
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: asgiref>=3.11.0
+Requires-Dist: fastapi>=0.115.8
+Requires-Dist: jinja2>=3.1.6
+Provides-Extra: example
+Requires-Dist: uvicorn>=0.34.0; extra == "example"
+Requires-Dist: faker>=38.2.0; extra == "example"
+Requires-Dist: pyjwt>=2.10.1; extra == "example"
+Requires-Dist: structlog>=25.5.0; extra == "example"
+Requires-Dist: rich>=14.2.0; extra == "example"
+Provides-Extra: tests
+Requires-Dist: pytest>=8.4.2; extra == "tests"
+Requires-Dist: pytest-asyncio>=1.2.0; extra == "tests"
+Requires-Dist: httpx>=0.28.1; extra == "tests"
+Requires-Dist: pytest-mock>=3.15.1; extra == "tests"
+Requires-Dist: sqlalchemy>=2.0.41; extra == "tests"
+Requires-Dist: aiosqlite>=0.22.1; extra == "tests"
+Requires-Dist: factory-boy>=3.3.3; extra == "tests"
+Requires-Dist: pyjwt>=2.10.1; extra == "tests"
+Provides-Extra: scalar
+Requires-Dist: scalar-fastapi>=1.5.0; extra == "scalar"
+Dynamic: license-file
+
+<div align="center">
+  <img src="https://github.com/brilliance-admin/backend-python/blob/main/example/static/logo.png?raw=true"
+       alt="Brilliance Admin"
+       width="600">
+</div>
+
+<div align="center">
+
+[![PyPI](https://img.shields.io/pypi/v/brilliance-admin)](https://pypi.org/project/brilliance-admin/)
+[![License](https://img.shields.io/pypi/l/brilliance-admin)](https://github.com/brilliance-admin/backend-python/blob/main/LICENSE)
+[![CI](https://github.com/brilliance-admin/backend-python/actions/workflows/deploy.yml/badge.svg)](https://github.com/brilliance-admin/backend-python/actions)
+
+</div>
+
+General-purpose admin panel framework powered by FastAPI. Some call it heavenly in its brilliance.
+
+- Serves a prebuilt SPA frontend as static files
+- Generates schemas for frontend sections on the backend
+- Provides a backend-driven API for admin interfaces
+- Designed for fast data management and data viewing from any sources
+- Inspired by Django Admin and Django REST Framework
+- Focused on minimal boilerplate and simplified backend-controlled configuration
+
+### [Live Demo](https://brilliance-admin.com/) | [Example App](https://github.com/brilliance-admin/backend-python/tree/main/example) | Documentation (todo)
+
+
+### Features:
+
+* Tables with full CRUD support, including filtering, sorting, and pagination.
+* Ability to define custom table actions with forms, response messages, and file uploads.
+* SQLAlchemy integration with automatic field generation from models.
+* Authorization via any account data source.
+* Localization support with language selection in the interface.
+
+## How to use it
+
+Installation:
+``` shell
+pip install brilliance-admin
+```
+
+You need to generate `AdminSchema` instance:
+``` python
+from admin_panel import schema
+
+admin_schema = schema.AdminSchema(
+    title='Admin Panel',
+    auth=YourAdminAuthentication(),
+    groups=[
+        schema.Group(
+            slug='example',
+            title='Example',
+            icon='mdi-star',
+            categories=[
+                CategoryExample(),
+            ]
+        ),
+    ],
+)
+
+admin_app = admin_schema.generate_app()
+
+# Your FastAPI app
+app = FastAPI()
+app.mount('/admin', admin_app)
+```
+
+### SQLAlchemy integration
+Brilliance Admin supports automatic schema generation from SQLAlchemy and provides a ready-made CRUD implementation for tables.
+
+``` python
+from admin_panel import sqlalchemy
+from admin_panel.translations import TranslateText as _
+
+from your_project.models import Terminal
+
+
+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 = 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),
+    )
+
+
+category = TerminalAdmin()
+```
+
+Now, the `TerminalAdmin` instance can be passed to `categories`.
+
+### Can be used both via inheritance and instancing
+
+For `SQLAlchemyFieldsSchema`
+
+``` python
+class TerminalTableSchema(sqlalchemy.SQLAlchemyFieldsSchema):
+    model = Terminal
+    fields = ['id', 'created_at']
+
+    created_at=schema.DateTimeField(range=True)
+
+
+class TerminalAdmin(sqlalchemy.SQLAlchemyAdmin):
+    table_schema = TerminalTableSchema()
+```
+
+And `SQLAlchemyAdmin` category schema itself
+
+> If `table_schema` is not specified, it will be generated automatically and will include all discovered fields and relationships of the table in the output.
+
+``` python
+category = sqlalchemy.SQLAlchemyAdmin(db_async_session=async_sessionmaker, model=Terminal)
+```

brilliance_admin-0.41.0/README.md

@@ -0,0 +1,125 @@
+<div align="center">
+  <img src="https://github.com/brilliance-admin/backend-python/blob/main/example/static/logo.png?raw=true"
+       alt="Brilliance Admin"
+       width="600">
+</div>
+
+<div align="center">
+
+[![PyPI](https://img.shields.io/pypi/v/brilliance-admin)](https://pypi.org/project/brilliance-admin/)
+[![License](https://img.shields.io/pypi/l/brilliance-admin)](https://github.com/brilliance-admin/backend-python/blob/main/LICENSE)
+[![CI](https://github.com/brilliance-admin/backend-python/actions/workflows/deploy.yml/badge.svg)](https://github.com/brilliance-admin/backend-python/actions)
+
+</div>
+
+General-purpose admin panel framework powered by FastAPI. Some call it heavenly in its brilliance.
+
+- Serves a prebuilt SPA frontend as static files
+- Generates schemas for frontend sections on the backend
+- Provides a backend-driven API for admin interfaces
+- Designed for fast data management and data viewing from any sources
+- Inspired by Django Admin and Django REST Framework
+- Focused on minimal boilerplate and simplified backend-controlled configuration
+
+### [Live Demo](https://brilliance-admin.com/) | [Example App](https://github.com/brilliance-admin/backend-python/tree/main/example) | Documentation (todo)
+
+
+### Features:
+
+* Tables with full CRUD support, including filtering, sorting, and pagination.
+* Ability to define custom table actions with forms, response messages, and file uploads.
+* SQLAlchemy integration with automatic field generation from models.
+* Authorization via any account data source.
+* Localization support with language selection in the interface.
+
+## How to use it
+
+Installation:
+``` shell
+pip install brilliance-admin
+```
+
+You need to generate `AdminSchema` instance:
+``` python
+from admin_panel import schema
+
+admin_schema = schema.AdminSchema(
+    title='Admin Panel',
+    auth=YourAdminAuthentication(),
+    groups=[
+        schema.Group(
+            slug='example',
+            title='Example',
+            icon='mdi-star',
+            categories=[
+                CategoryExample(),
+            ]
+        ),
+    ],
+)
+
+admin_app = admin_schema.generate_app()
+
+# Your FastAPI app
+app = FastAPI()
+app.mount('/admin', admin_app)
+```
+
+### SQLAlchemy integration
+Brilliance Admin supports automatic schema generation from SQLAlchemy and provides a ready-made CRUD implementation for tables.
+
+``` python
+from admin_panel import sqlalchemy
+from admin_panel.translations import TranslateText as _
+
+from your_project.models import Terminal
+
+
+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 = 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),
+    )
+
+
+category = TerminalAdmin()
+```
+
+Now, the `TerminalAdmin` instance can be passed to `categories`.
+
+### Can be used both via inheritance and instancing
+
+For `SQLAlchemyFieldsSchema`
+
+``` python
+class TerminalTableSchema(sqlalchemy.SQLAlchemyFieldsSchema):
+    model = Terminal
+    fields = ['id', 'created_at']
+
+    created_at=schema.DateTimeField(range=True)
+
+
+class TerminalAdmin(sqlalchemy.SQLAlchemyAdmin):
+    table_schema = TerminalTableSchema()
+```
+
+And `SQLAlchemyAdmin` category schema itself
+
+> If `table_schema` is not specified, it will be generated automatically and will include all discovered fields and relationships of the table in the output.
+
+``` python
+category = sqlalchemy.SQLAlchemyAdmin(db_async_session=async_sessionmaker, model=Terminal)
+```

{brilliance_admin-0.40.0 → brilliance_admin-0.41.0}/admin_panel/schema/admin_schema.py

@@ -33,7 +33,6 @@ class AdminSettingsData(DataclassBase):
     description: str | TranslateText | None
     login_greetings_message: str | TranslateText | None
     navbar_density: str
-    logo_image: str | None
     languages: Dict[str, str] | None
 
 
@@ -52,9 +51,12 @@ class AdminSchema:
     title: str | TranslateText | None = 'Admin'
     description: str | TranslateText | None = None
     login_greetings_message: str | TranslateText | None = None
+
+    logo_image: str | None = None
+    favicon_image: str = '/admin/static/favicon.jpg'
+
     navbar_density: str = 'default'
 
-    favicon_image: str = '/admin/static/favicon.ico'
     backend_prefix = None
     static_prefix = None
 
@@ -107,7 +109,6 @@ class AdminSchema:
             description=self.description,
             login_greetings_message=self.login_greetings_message,
             navbar_density=self.navbar_density,
-            logo_image=None,
             languages=languages,
         )
 
@@ -171,11 +172,16 @@ class AdminSchema:
         if not static_prefix:
             static_prefix = urljoin(str(request.base_url), '/admin/static/')
 
+        logo_image = self.logo_image
+        if logo_image and logo_image.startswith('/'):
+            logo_image = urljoin(str(request.base_url), logo_image)
+
         settings_json = {
             'backend_prefix': backend_prefix,
             'static_prefix': static_prefix,
-            'version': importlib.metadata.version('admin-panel'),
+            'version': importlib.metadata.version('brilliance-admin'),
             'api_timeout_ms': 1000 * 5,
+            'logo_image': logo_image,
         }
         data = AdminIndexContextData(
             title=str(self.title),