Подключение к своему приложению

Модели и приложение уже есть? Это руководство подключает их к quite-admin.
Если нужен готовый запускаемый пример, начните с первой админки.

Нужны CPython 3.11–3.15, существующее приложение, база и модели.
Установите quite-admin из PyPI в окружение приложения:

pip install 'quite-admin[sqlalchemy,fastapi]'
# Для Litestar: uv add 'quite-admin[sqlalchemy,litestar]'

Для воспроизводимой установки сохраняйте зависимости приложения в lock-файле.
Также поддерживается установка из исходного checkout или архива.

Существующее FastAPI-приложение

Добавьте код рядом с созданием app. Замените импорт на свои существующие
SQLAlchemy/SQLModel base и фабрику сессий:

import os
from quite_admin import Admin, PasswordAuth
from quite_admin.adapters.sqlalchemy import SQLAlchemyAdapter
from myapp.database import Base, SessionFactory

admin = Admin(
    auth=PasswordAuth.single_user('admin', os.environ['QUITE_ADMIN_PASSWORD']),
    secret_key=os.environ['QUITE_ADMIN_SECRET'],
    adapters=[SQLAlchemyAdapter(SessionFactory, base=Base)],
    secure_cookies=False,  # Локальный HTTP; в production с HTTPS используйте True.
)
admin.mount_fastapi(app)

В конфигурации приложения задайте QUITE_ADMIN_PASSWORD и постоянный случайный
QUITE_ADMIN_SECRET длиной не менее 32 байт. Импортируйте модули моделей до startup.
Запустите приложение как обычно и откройте /admin/; логин — admin, пароль из
настройки. Дополнительные схемы и классы admin-моделей не нужны. Lifespan базы
и миграции остаются под управлением приложения.

Существующее Litestar-приложение

Используйте тот же Admin, заменив вызов mount:

admin.mount_litestar(app)

Подключайте до запуска приложения. Для Tortoise выполните инициализацию в lifespan
до обнаружения моделей и выберите TortoiseAdapter. Все адаптеры, вложенные пути
и прокси описаны в подключении.

Любая ORM через её базу

Для обнаружения физических таблиц передайте engine существующей базы:

from quite_admin.adapters.sql import SQLAdapter
adapter = SQLAdapter(engine)

Укажите adapters=[adapter] в Admin. Reflection выполняет правила и триггеры БД;
для Python-хуков и бизнес-правил нужен нативный или сервисный адаптер. Перед
открытием таблиц проверьте защиту секретных и служебных полей
и матрицу СУБД.

Интерфейс

Одна страница содержит поля и редакторы связей. На примере read-only видно ту же
страницу с защищённой датой регистрации.

В обзоре интерфейса показаны вход, календари и журнал действий.

Запуск готового примера

uv sync --locked --python 3.15
QUITE_ADMIN_PASSWORD='local-demo-only' uv run uvicorn examples.fastapi_app:app --reload
# Либо examples.litestar_app:app.

Откройте localhost:8000/admin/, войдите с
admin / local-demo-only. Пример создаёт отдельную SQLite-базу; путь задаётся
через QUITE_ADMIN_DEMO_DB. Для стабильной Python 3.15 нужен uv 0.13.6+.
Самой библиотеке Node.js не нужен — он используется только при сборке документации.

Через Список таблиц на главной или Найти таблицу откройте Schedules, Field samples,
Folders, Regional prices, Price alerts, Reference rates и Demo accounts. Эти вымышленные
таблицы показывают типы полей, все четыре кратности связей, составные ключи, данные
только для чтения, действия и Python-сервисы аккаунтов; Demo accounts не используются
для входа в админку. Пример явно подключает необязательный тур после входа; выберите
Начать тур для запуска или Не сейчас для отказа. В существующей базе добавляются
новые таблицы без замены исходных записей. Сценарии описаны в обзоре интерфейса,
а возможности только для сервера — в покрытии браузерного демо.

Хранилище и развёртывание

При переходе с локальной разработки используйте руководство по развёртыванию.

Админка инициализирует собственное сервисное хранилище .quite-admin/state.sqlite3.
Нужен постоянный доступный для записи каталог. Для контейнеров и реплик настройте
storage / QUITE_ADMIN_STORAGE_URL. По умолчанию в библиотеке история записывает
завершённые изменения (history_level="changes"); "audit" и "all" включают больше
событий, history_enabled=False отключает её. Пример приложения явно использует
"audit", чтобы можно было проверить аутентификацию, экспорт и ошибки записи.
См. хранилище, резервные копии и уровни записи.

При развёртывании с HTTPS сохраняйте secure_cookies=True, общий постоянный секрет
для процессов, проверьте таблицы и права. Приложение управляет запуском и остановкой БД.
Лимиты чтения позволяют оставить часть пула запросам приложения.
Сессии описывают отзыв доступа и cookies,
интеграция — пути монтирования и префиксы reverse proxy.