brilliance-admin 0.39.0__tar.gz

brilliance_admin-0.39.0/.configs/docker/Dockerfile

@@ -0,0 +1,22 @@
+FROM python:3.12-slim
+
+# The installer requires curl (and certificates) to download the release archive
+RUN apt-get update && apt-get install -y --no-install-recommends curl ca-certificates
+
+# Download the latest installer
+ADD https://astral.sh/uv/install.sh /uv-installer.sh
+
+# Run the installer then remove it
+RUN sh /uv-installer.sh && rm /uv-installer.sh
+
+# Ensure the installed binary is on the `PATH`
+ENV PATH="/root/.local/bin/:$PATH"
+
+# Copy the project into the image
+ADD . /app
+
+RUN apt-get install -y --no-install-recommends curl build-essential gettext libpq-dev git ssh openssh-client
+
+# Sync the project into a new environment, using the frozen lockfile
+WORKDIR /app
+RUN uv sync --frozen

brilliance_admin-0.39.0/.configs/docker/docker-compose.yml

@@ -0,0 +1,35 @@
+name: brilliance
+
+volumes:
+  db_data:
+
+services:
+  backend:
+    build:
+      context: ./../..
+      dockerfile: .configs/docker/Dockerfile
+    volumes:
+      - ./../../:/app
+      - ~/.ssh/id_rsa:/root/.ssh/id_rsa:delegated
+      - ~/.ssh/known_hosts:/root/.ssh/known_hosts:delegated
+    env_file:
+      - ./../../.env
+    tmpfs:
+      - /tmp
+    ports:
+      - 8082:8082
+    command: uv run uvicorn example.main:app --host 0.0.0.0 --port 8082 --reload --proxy-headers --forwarded-allow-ips='*'
+    healthcheck:
+      test: ['CMD', 'curl', '-f', 'http://127.0.0.1:8082']
+      interval: 5s
+      timeout: 2s
+      retries: 5
+
+  postgres:
+    image: postgres:alpine
+    env_file:
+      - ./../../.env
+    volumes:
+      - db_data:/var/lib/postgresql/data
+    ports:
+      - 5432:5432

brilliance_admin-0.39.0/.configs/nginx/example.conf

@@ -0,0 +1,25 @@
+server {
+    listen 80;
+    server_name brilliance-admin.com www.brilliance-admin.com;
+
+    return 301 https://$host$request_uri;
+}
+
+server {
+    listen 443 ssl;
+    server_name brilliance-admin.com www.brilliance-admin.com;
+
+    ssl_certificate /etc/letsencrypt/live/brilliance-admin.com/fullchain.pem;
+    ssl_certificate_key /etc/letsencrypt/live/brilliance-admin.com/privkey.pem;
+
+    ssl_protocols TLSv1.2 TLSv1.3;
+    ssl_prefer_server_ciphers off;
+
+    location / {
+        proxy_pass http://127.0.0.1:8082;
+        proxy_set_header Host $host;
+        proxy_set_header X-Real-IP $remote_addr;
+        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+        proxy_set_header X-Forwarded-Proto https;
+    }
+}

brilliance_admin-0.39.0/.github/workflows/certbot.yml

@@ -0,0 +1,27 @@
+name: Setup HTTPS
+
+on:
+  workflow_dispatch:
+
+jobs:
+  setup-https:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Setup HTTPS with certbot
+        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 update
+              sudo apt install -y certbot python3-certbot-nginx
+            fi
+            sudo certbot --nginx \
+              -d brilliance-admin.com \
+              -d www.brilliance-admin.com \
+              --non-interactive \
+              --agree-tos \
+              -m admin@brilliance-admin.com \
+              --redirect

brilliance_admin-0.39.0/.github/workflows/deploy.yml

@@ -0,0 +1,127 @@
+name: CI-CD Pipeline
+
+on:
+  push:
+    branches: [ main ]
+
+jobs:
+  build-test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v5
+
+      - name: Build containers
+        run: docker compose -f .configs/docker/docker-compose.yml build
+
+      - name: Run tests
+        run: docker compose -f .configs/docker/docker-compose.yml run --rm backend sh -c 'uv sync --all-groups --all-extras && uv run pytest'
+
+  deploy:
+    needs: build-test
+    runs-on: ubuntu-latest
+    if: ${{ success() }}
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v5
+
+      - name: Clone repo via GitHub App
+        uses: GuillaumeFalourd/clone-github-repo-action@v2
+        with:
+          owner: brilliance-admin
+          repository: backend-python
+          app_id: ${{ secrets.GH_APP_ID }}
+          installation_id: ${{ secrets.GH_APP_INSTALLATION_ID }}
+          private_key: ${{ secrets.GH_APP_PRIVATE_KEY }}
+
+      - name: Ensure rsync installed on server
+        uses: appleboy/ssh-action@master
+        with:
+          host: ${{ vars.SERVER_HOST }}
+          username: deploy
+          key: ${{ secrets.SERVER_SSH_KEY }}
+          script: |
+            if ! command -v rsync >/dev/null 2>&1; then
+              sudo apt update
+              sudo apt install -y rsync
+            fi
+
+      - name: Fix folder permissions
+        uses: appleboy/ssh-action@master
+        with:
+          host: ${{ vars.SERVER_HOST }}
+          username: deploy
+          key: ${{ secrets.SERVER_SSH_KEY }}
+          script: |
+            sudo chown -R deploy:deploy /home/deploy/apps/backend-python
+
+      - name: Copy files to server
+        uses: burnett01/rsync-deployments@v8
+        with:
+          switches: -avzr --delete --chown=deploy:deploy
+          path: .
+          remote_path: /home/deploy/apps/backend-python
+          remote_host: ${{ vars.SERVER_HOST }}
+          remote_user: deploy
+          remote_key: ${{ secrets.SERVER_SSH_KEY }}
+
+      - name: Run Docker on server
+        uses: appleboy/ssh-action@master
+        with:
+          host: ${{ vars.SERVER_HOST }}
+          username: deploy
+          key: ${{ secrets.SERVER_SSH_KEY }}
+          script: |
+            cd /home/deploy/apps/backend-python
+            docker compose -f .configs/docker/docker-compose.yml run --rm backend /bin/bash -c "uv sync --all-groups --all-extras"
+            docker compose -f .configs/docker/docker-compose.yml up -d --build
+
+      - name: Wait backend healthy
+        uses: appleboy/ssh-action@master
+        with:
+          host: ${{ vars.SERVER_HOST }}
+          username: deploy
+          key: ${{ secrets.SERVER_SSH_KEY }}
+          script: |
+            for i in 1 2 3 4 5 6; do
+              STATUS=$(docker inspect --format='{{.State.Health.Status}}' brilliance-backend-1 2>/dev/null || true)
+              if [ "$STATUS" = "healthy" ]; then
+                exit 0
+              fi
+              sleep 3
+            done
+            exit 1
+
+  update-nginx:
+    needs: deploy
+    runs-on: ubuntu-latest
+    if: ${{ success() }}
+    steps:
+
+      - name: Ensure nginx is running
+        uses: appleboy/ssh-action@master
+        with:
+          host: ${{ vars.SERVER_HOST }}
+          username: deploy
+          key: ${{ secrets.SERVER_SSH_KEY }}
+          script: |
+            if ! systemctl is-active --quiet nginx; then
+              sudo systemctl start nginx
+            fi
+            sudo systemctl status nginx --no-pager
+
+      - name: Ensure nginx and update config
+        uses: appleboy/ssh-action@master
+        with:
+          host: ${{ vars.SERVER_HOST }}
+          username: deploy
+          key: ${{ secrets.SERVER_SSH_KEY }}
+          script: |
+            if ! command -v nginx >/dev/null 2>&1; then
+              sudo apt update
+              sudo apt install -y nginx
+            fi
+            sudo ln -sf /home/deploy/apps/backend-python/.configs/nginx/example.conf /etc/nginx/sites-enabled/example
+            sudo rm -f /etc/nginx/sites-enabled/default
+            sudo nginx -t
+            sudo systemctl reload nginx

brilliance_admin-0.39.0/.github/workflows/install-docker.yml

@@ -0,0 +1,26 @@
+name: Install Docker on server
+
+on:
+  workflow_dispatch:
+
+jobs:
+  install-docker:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Ensure Docker installed and deploy in docker group
+        uses: appleboy/ssh-action@master
+        with:
+          host: ${{ vars.SERVER_HOST }}
+          username: ${{ vars.SERVER_USER }}
+          key: ${{ secrets.SERVER_SSH_KEY }}
+          script: |
+            if ! command -v docker >/dev/null 2>&1; then
+              sudo apt update
+              sudo apt install -y ca-certificates curl gnupg
+              sudo install -m 0755 -d /etc/apt/keyrings
+              curl -fsSL https://download.docker.com/linux/debian/gpg | sudo gpg --dearmor -o /etc/apt/keyrings/docker.gpg
+              sudo chmod a+r /etc/apt/keyrings/docker.gpg
+              echo "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/debian $(. /etc/os-release && echo "$VERSION_CODENAME") stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
+              sudo apt update
+              sudo apt install -y docker-ce docker-ce-cli containerd.io docker-compose-plugin
+            fi

brilliance_admin-0.39.0/.gitignore

@@ -0,0 +1,11 @@
+# Python-generated files
+test.db
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv

brilliance_admin-0.39.0/.isort.cfg

@@ -0,0 +1,7 @@
+[isort]
+line_length=120
+py_version=39
+multi_line_output=4
+known_third_party=fastapi
+known_first_party=app,tests
+virtual_env=py3

brilliance_admin-0.39.0/.python-version

@@ -0,0 +1 @@
+3.10

brilliance_admin-0.39.0/LICENSE

@@ -0,0 +1,17 @@
+GNU AFFERO GENERAL PUBLIC LICENSE
+Version 3, 19 November 2007
+
+Copyright (C) 2025 Your Name
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as published
+by the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program.  If not, see <https://www.gnu.org/licenses/>.

brilliance_admin-0.39.0/PKG-INFO

@@ -0,0 +1,76 @@
+Metadata-Version: 2.4
+Name: brilliance-admin
+Version: 0.39.0
+Summary: General-purpose admin panel backend
+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
+
+# Brilliance Admin Backend
+
+Brilliance Admin Backend is a backend framework for building admin panels with Python and FastAPI.
+
+- 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
+
+Features:
+- 
+[Live Demo](https://brilliance-admin.com/)
+
+
+## Development
+
+``` shell
+uv sync --all-groups --all-extras
+uv run uvicorn example.main:app --host 0.0.0.0 --port 8082 --reload
+```
+
+Docs:
+- `http://0.0.0.0:8082/docs`
+- `http://0.0.0.0:8082/redoc`
+- `http://0.0.0.0:8082/scalar`
+
+Tests:
+``` shell
+uv run pytest
+```
+
+## Docker
+
+``` shell
+docker compose -f .configs/docker/docker-compose.yml build
+docker compose -f .configs/docker/docker-compose.yml up
+docker compose -f .configs/docker/docker-compose.yml run --rm backend /bin/bash -c "uv sync --all-groups --all-extras"
+docker compose -f .configs/docker/docker-compose.yml run --rm backend /bin/bash -c "uv run pytest"
+```
+
+``` shell
+docker exec -it rollyum-backend-1 git config --global --add safe.directory '*'
+docker exec -it rollyum-backend-1 uv run pre-commit run --all-files
+```

brilliance_admin-0.39.0/README.md

@@ -0,0 +1,46 @@
+# Brilliance Admin Backend
+
+Brilliance Admin Backend is a backend framework for building admin panels with Python and FastAPI.
+
+- 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
+
+Features:
+- 
+[Live Demo](https://brilliance-admin.com/)
+
+
+## Development
+
+``` shell
+uv sync --all-groups --all-extras
+uv run uvicorn example.main:app --host 0.0.0.0 --port 8082 --reload
+```
+
+Docs:
+- `http://0.0.0.0:8082/docs`
+- `http://0.0.0.0:8082/redoc`
+- `http://0.0.0.0:8082/scalar`
+
+Tests:
+``` shell
+uv run pytest
+```
+
+## Docker
+
+``` shell
+docker compose -f .configs/docker/docker-compose.yml build
+docker compose -f .configs/docker/docker-compose.yml up
+docker compose -f .configs/docker/docker-compose.yml run --rm backend /bin/bash -c "uv sync --all-groups --all-extras"
+docker compose -f .configs/docker/docker-compose.yml run --rm backend /bin/bash -c "uv run pytest"
+```
+
+``` shell
+docker exec -it rollyum-backend-1 git config --global --add safe.directory '*'
+docker exec -it rollyum-backend-1 uv run pre-commit run --all-files
+```

brilliance_admin-0.39.0/admin_panel/__init__.py

@@ -0,0 +1,4 @@
+# pylint: disable=wildcard-import, unused-wildcard-import, unused-import
+# flake8: noqa: F405
+from admin_panel.integrations import sqlalchemy
+from admin_panel import schema

brilliance_admin-0.39.0/admin_panel/api/routers.py

@@ -0,0 +1,18 @@
+from fastapi import APIRouter
+
+from .views.schema import router as schema_router
+from .views.table import router as schema_table
+from .views.auth import router as schema_auth
+from .views.autocomplete import router as schema_autocomplete
+from .views.graphs import router as schema_graphs
+from .views.settings import router as schema_settings
+from .views.index import router as schema_index
+
+admin_panel_router = APIRouter()
+admin_panel_router.include_router(schema_router)
+admin_panel_router.include_router(schema_table)
+admin_panel_router.include_router(schema_auth)
+admin_panel_router.include_router(schema_autocomplete)
+admin_panel_router.include_router(schema_graphs)
+admin_panel_router.include_router(schema_settings)
+admin_panel_router.include_router(schema_index)

brilliance_admin-0.39.0/admin_panel/api/utils.py

@@ -0,0 +1,28 @@
+from fastapi import HTTPException
+
+from admin_panel.auth import AdminAuthentication
+
+
+async def get_user(request):
+    auth: AdminAuthentication = request.app.state.schema.auth
+    user = await auth.authenticate(request.headers)
+    return user
+
+
+async def get_category(request, group: str, category: str, check_type=None):
+    user = await get_user(request)
+
+    schema_group = request.app.state.schema.get_group(group)
+    if not schema_group:
+        raise HTTPException(status_code=404, detail="Group not found")
+
+    schema_category = schema_group.get_category(category)
+    if not schema_category:
+        raise HTTPException(status_code=404, detail="Category not found")
+
+    if check_type:
+        schema_category, user = await get_category(request, group, category)
+        if not issubclass(schema_category.__class__, check_type):
+            raise HTTPException(status_code=404, detail=f"Category {group}.{category} is not a {check_type.__name__}")
+
+    return schema_category, user

brilliance_admin-0.39.0/admin_panel/api/views/auth.py

@@ -0,0 +1,29 @@
+from fastapi import APIRouter, Request
+from fastapi.responses import JSONResponse
+
+from admin_panel.auth import AdminAuthentication, AuthData, AuthResult
+from admin_panel.exceptions import AdminAPIException, APIError
+from admin_panel.schema.admin_schema import AdminSchema
+from admin_panel.translations import LanguageManager
+
+router = APIRouter(prefix="/auth", tags=["Auth"])
+
+
+@router.post(
+    path='/login/',
+    responses={401: {"model": APIError}},
+)
+async def login(request: Request, auth_data: AuthData) -> AuthResult:
+    schema: AdminSchema = request.app.state.schema
+
+    language_slug = request.headers.get('Accept-Language')
+    language_manager: LanguageManager = schema.get_language_manager(language_slug)
+    context = {'language_manager': language_manager}
+
+    auth: AdminAuthentication = schema.auth
+    try:
+        result: AuthResult = await auth.login(auth_data)
+    except AdminAPIException as e:
+        return JSONResponse(e.get_error().model_dump(mode='json', context=context), status_code=e.status_code)
+
+    return JSONResponse(content=result.model_dump(mode='json', context=context))

brilliance_admin-0.39.0/admin_panel/api/views/autocomplete.py

@@ -0,0 +1,33 @@
+from fastapi import APIRouter, Request
+from fastapi.responses import JSONResponse
+
+from admin_panel.api.utils import get_category
+from admin_panel.exceptions import AdminAPIException
+from admin_panel.schema.admin_schema import AdminSchema
+from admin_panel.schema.table.table_models import AutocompleteData, AutocompleteResult
+from admin_panel.translations import LanguageManager
+from admin_panel.utils import get_logger
+
+router = APIRouter(prefix="/autocomplete", tags=["Autocomplete"])
+
+logger = get_logger()
+
+
+@router.post(path='/{group}/{category}/')
+async def autocomplete(request: Request, group: str, category: str, data: AutocompleteData):
+    schema: AdminSchema = request.app.state.schema
+    schema_category, user = await get_category(request, group, category)
+
+    language_slug = request.headers.get('Accept-Language')
+    language_manager: LanguageManager = schema.get_language_manager(language_slug)
+    context = {'language_manager': language_manager}
+
+    try:
+        result: AutocompleteResult = await schema_category.autocomplete(data, user, language_manager)
+    except AdminAPIException as e:
+        return JSONResponse(e.get_error().model_dump(mode='json', context=context), status_code=e.status_code)
+    except Exception as e:
+        logger.exception('Autocomplete %s.%s exceptoin: %s', e, group, category, extra={'data': data})
+        return JSONResponse({}, status_code=500)
+
+    return JSONResponse(result.model_dump(mode='json', context=context))

brilliance_admin-0.39.0/admin_panel/api/views/graphs.py

@@ -0,0 +1,30 @@
+from fastapi import APIRouter, Request
+from fastapi.responses import JSONResponse
+
+from admin_panel.api.utils import get_category
+from admin_panel.exceptions import AdminAPIException
+from admin_panel.schema.admin_schema import AdminSchema
+from admin_panel.schema.graphs.category_graphs import CategoryGraphs, GraphData, GraphsDataResult
+from admin_panel.translations import LanguageManager
+from admin_panel.utils import get_logger
+
+router = APIRouter(prefix="/graph", tags=["Category - Graph"])
+
+logger = get_logger()
+
+
+@router.post(path='/{group}/{category}/')
+async def graph_data(request: Request, group: str, category: str, data: GraphData) -> GraphsDataResult:
+    schema: AdminSchema = request.app.state.schema
+    schema_category, user = await get_category(request, group, category, check_type=CategoryGraphs)
+
+    result: GraphsDataResult = await schema_category.get_data(data, user)
+
+    language_slug = request.headers.get('Accept-Language')
+    language_manager: LanguageManager = schema.get_language_manager(language_slug)
+    context = {'language_manager': language_manager}
+
+    try:
+        return JSONResponse(result.model_dump(mode='json', context=context))
+    except AdminAPIException as e:
+        return JSONResponse(e.get_error().model_dump(mode='json', context=context), status_code=e.status_code)

brilliance_admin-0.39.0/admin_panel/api/views/index.py

@@ -0,0 +1,38 @@
+from fastapi import APIRouter, HTTPException, Request
+from fastapi.responses import HTMLResponse
+from fastapi.templating import Jinja2Templates
+from jinja2 import Environment, PackageLoader, select_autoescape
+
+from admin_panel.schema import AdminSchema
+
+router = APIRouter()
+
+templates = Jinja2Templates(
+    env=Environment(
+        loader=PackageLoader("admin_panel", "templates"),
+        autoescape=select_autoescape(["html", "xml"]),
+    )
+)
+
+# Всё, что не должно попадать в SPA (можете расширять список)
+EXACT_BLOCK = {"/openapi.json"}
+PREFIX_BLOCK = ("/docs", "/redoc", "/scalar", "/static")
+
+
+@router.get('/{rest_of_path:path}', response_class=HTMLResponse, include_in_schema=False)
+async def admin_index(request: Request, rest_of_path: str):
+    '''
+    The request responds with a pre-rendered SPA served as an HTML page.
+    '''
+
+    path = "/" + rest_of_path
+    if path in EXACT_BLOCK or path.startswith(PREFIX_BLOCK):
+        raise HTTPException(status_code=404)
+
+    schema: AdminSchema = request.app.state.schema
+
+    return templates.TemplateResponse(
+        request=request,
+        name='index.html',
+        context=await schema.get_index_context_data(request),
+    )

brilliance_admin-0.39.0/admin_panel/api/views/schema.py

@@ -0,0 +1,29 @@
+from fastapi import APIRouter, Request
+from fastapi.responses import JSONResponse
+
+from admin_panel.auth import AdminAuthentication
+from admin_panel.exceptions import AdminAPIException, APIError
+from admin_panel.schema import AdminSchema, AdminSchemaData
+
+router = APIRouter(prefix="/schema", tags=["Main admin schema"])
+
+
+@router.get(
+    path='/',
+    responses={400: {"model": APIError}},
+)
+async def schema_handler(request: Request) -> AdminSchemaData:
+    '''
+    Request for retrieving the admin panel schema, including all sections and their contents.
+    '''
+    schema: AdminSchema = request.app.state.schema
+
+    auth: AdminAuthentication = schema.auth
+    try:
+        user = await auth.authenticate(request.headers)
+    except AdminAPIException as e:
+        return JSONResponse(e.get_error().model_dump(mode='json'), status_code=e.status_code)
+
+    language_slug = request.headers.get('Accept-Language')
+    admin_schema = schema.generate_schema(user, language_slug)
+    return admin_schema