brilliance-admin 0.43.5__tar.gz

brilliance_admin-0.43.5/.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.43.5/.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.43.5/.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.43.5/.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.43.5/.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.43.5/.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.43.5/.gitignore

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

brilliance_admin-0.43.5/.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,brilliance_admin
+virtual_env=py3

brilliance_admin-0.43.5/.python-version

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

brilliance_admin-0.43.5/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.43.5/PKG-INFO

@@ -0,0 +1,214 @@
+Metadata-Version: 2.4
+Name: brilliance-admin
+Version: 0.43.5
+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
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: asgiref>=3.11
+Requires-Dist: fastapi>=0.115
+Requires-Dist: jinja2>=3.1
+Requires-Dist: PyYAML>=6.0
+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-outline.png?raw=true"
+       alt="Brilliance Admin"
+       width="600">
+
+[![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. \
+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)
+
+  <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**\
+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**\
+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:
+
+* 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
+
+**Integrations:**
+* **SQLAlchemy** - schema autogeneration for tables + CRUD operations + authorization
+
+**Planned:**
+* Role-based access control system
+* Nested data support for creation and detail views
+* Django ORM inegration
+
+## How to use it
+
+Installation:
+``` shell
+pip install brilliance-admin
+```
+
+You need to generate `AdminSchema` instance:
+``` python
+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(),
+    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
+
+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
+
+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),
+    ),
+)
+```
+
+### SQLAlchemy JWT Authentication
+
+``` python
+auth = sqlalchemy.SQLAlchemyJWTAdminAuthentication(
+    secret='auth_secret',
+    db_async_session=async_session,
+    user_model=User,
+)
+```
+
+## Comparison of Similar Projects
+
+| Criterion | Brilliance Admin | Django Admin/Unfold | FastAPI Admin | Starlette Admin |
+|---------|------------------|---------------|---------------|-----------------|
+| Base framework | FastAPI | Django | FastAPI | Starlette / FastAPI |
+| Rendering model | Prebuilt Vue 3 + Vuetify SPA + Jinja2 | Server-side Django templates | Server-side Jinja2 templates + Tabler UI | Server-side Jinja2 templates + Tabler UI |
+| Frontend architecture | Separate frontend (SPA) | Classic server-rendered UI | Server-rendered UI with JS interactivity | Server-rendered UI with JS interactivity |
+| Data source | Any source + SQLAlchemy | Django ORM | Tortoise ORM | Any source + SQLAlchemy, MongoDB |
+| Multiple databases per model | Yes | Database routers | No (global engine) | Yes (session per ModelView) |
+| Schema generation | User-defined format | From Django models | From ORM models | User-defined format |
+| Async support | Yes | No | Yes | Yes |
+| API-first approach | Yes | No | Partially | Partially |