Проект简介

⚠️Внимание Pear Admin Flask синхронизирован с основным проектом Pear Admin Layui 4.0, некоторые страницы значительно изменились. Если вы мигрируете с старой версии, ознакомьтесь с разделом Миграция с старого проекта. Также можно посмотреть Журнал изменений.

Pear Admin Flask — это система управления backend на основе Flask, которая использует широко распространенный язык Python. С помощью этой системы можно быстро создавать функциональные бизнес-приложения. Проект предназначен для предоставления шаблона системы управления backend для разработчиков Python, что позволяет быстро создавать информационные системы.Проект использует flask-sqlalchemy + аутентификацию + сериализацию и проверку данных с помощью marshmallow, что позволяет интегрировать несколько различных функций.

Встроенные функции

• Управление пользователями: пользователи являются операторами системы, эта функция主要用于完成系统用户的配置。
• Управление правами доступа: настройка системного меню, прав доступа, меток прав кнопок и т.д.
• Управление ролями: распределение прав меню ролей.
• Журнал операций: запись и поиск журнала нормальных операций системы; запись и поиск журнала аномальных событий системы.
• Журнал входа: запись и поиск журнала входа в систему, включая аномальные входы.
• Мониторинг службы: мониторинг текущих параметров системы, таких как CPU, память, диск, версия Python, время работы и т.д.
• Загрузка файлов: пример загрузки изображений.

Исправленный перевод:

Встроенные функции

• Управление пользователями: пользователи являются операторами системы, эта функция используется для настройки пользователей системы.
• Управление правами доступа: настройка системного меню, прав доступа, меток прав кнопок и т.д.
• Управление ролями: распределение прав меню ролей.
• Журнал операций: запись и поиск журнала нормальных операций системы; запись и поиск журнала аномальных событий системы.
• Журнал входа: запись и поиск журнала входа в систему, включая аномальные входы.
• Мониторинг службы: мониторинг текущих параметров системы, таких как CPU, память, диск, версия Python, время работы и т.д.
• Загрузка файлов: пример загрузки изображений.

Описание веток проекта> ⚠️ Внимание Pear Admin Flask предоставляет не только одну реализацию для Pear Admin backend, поэтому существует несколько веток, каждая из которых имеет свои преимущества и недостатки, а также поддерживается различными разработчиками.

⚠️ Внимание В связи с потребностями проекта в ветке master временно удалена функциональность Flask-APScheduler для планирования задач.

Поддерживаемые версии

После тестирования, для работы проекта (ветка master) требуется >= Python 3.8, рекомендуется использовать Python 3.11.

💡 Подсказка Из-за обновления модуля Werkzeug, используемого в Flask, официальные разработчики Flask не успели внести соответствующие изменения, что может привести к ошибке ImportError. Такую проблему можно решить путем правильной установки модулей, указанных в requirements.txt (включая их версии).# Структура проекта

Структура приложения

Pear Admin Flask (master)
├─applications  # Ядро проекта
│  ├─common  # Общие модули (инициализация базы данных, общие функции)
│  ├─extensions  # Регистрация плагинов проекта
│  ├─schemas  # Модели сериализации
│  ├─models  # Модели базы данных
│  ├─views  # Часть представлений
│  ├─config.py  # Конфигурация проекта
│  └─__init__.py  # Точка входа для инициализации проекта
├─docs  # Документация
├─static  # Статические ресурсы
├─templates  # Шаблоны статических файлов
└─app.py  # Точка входа программы
```## Структура ресурсов
Pear Admin Flask
├─static    # Проектный ресурсный каталог Flask
│  ├─admin    # Ресурсные файлы backend Pear Admin Flask (синхронизированы с Pear Admin Layui)
│  ├─index    # Ресурсные файлы frontend Pear Admin Flask
│  └─upload     # Каталог для сохранения загруженных пользователем файлов
└─templates # Проектный каталог шаблонов Flask
  ├─admin   # Шаблоны страниц администрирования backend Pear Admin Flask
  │  ├─admin_log    # Шаблон страницы журнала
  │  ├─common       # Базовый шаблон (шапка и подвал)
  │  ├─console      # Шаблон страницы мониторинга системы
  │  ├─dept         # Шаблон страницы управления отделами
  │  ├─dict         # Шаблон страницы автоматического управления данными
  │  ├─mail         # Шаблон страницы управления почтой
  │  ├─photo        # Шаблон страницы загрузки изображений
  │  ├─power        # Шаблон страницы управления правами (меню)
  │  ├─role         # Шаблон страницы управления ролями
  │  ├─task         # Шаблон страницы настройки задач
  │  └─user         # Шаблон страницы управления пользователями
  ├─errors  # Шаблоны страниц ошибок
  └─index   # Шаблон главной страницы
# Установка проекта## Получение из репозитория

```bash
# Клонирование репозитория / ручное скачивание
git clone https://gitee.com/pear-admin/pear-admin-flask
cd pear-admin-flask  # Перейти в директорию проекта

Изменение конфигурации

💡Подсказка Конфигурационный файл находится в applications/config.py. Откройте конфигурационный файл, чтобы увидеть значения по умолчанию, находящиеся в классе BaseConfig. Вы можете создать свой собственный конфигурационный класс, унаследовав его от BaseConfig. При запуске проекта вызывается applications/__init__.py, в котором загружается конфигурация приложения, поэтому не забудьте изменить используемый конфигурационный класс в файле applications/__init__.py.

⚠️Внимание В конфигурационном файле были внесены изменения в настройки базы данных. Просмотрите комментарии в коде и внесите необходимые изменения.

# Часть конфигурационной информации приведена ниже

# Секретный ключ (⚠️ Обязательно измените ⚠️)
SECRET_KEY = "pear-system-flask"

# Настройки базы данных
SQLALCHEMY_DATABASE_URI = 'sqlite:///../pear.db'

# Уровень журналирования по умолчанию
LOG_LEVEL = logging.WARN

# Настройки flask-mail
MAIL_SERVER = 'smtp.qq.com'
MAIL_USE_TLS = False
MAIL_USE_SSL = True
MAIL_PORT = 465
MAIL_USERNAME = '123@qq.com'
MAIL_PASSWORD = 'XXXXX'  # Сгенерированный токен доступа
MAIL_DEFAULT_SENDER = MAIL_USERNAME

Установка проекта в виртуальном окружении (рекомендуется)> 💡Подсказка Для того чтобы зависимости проекта не влияли на другие проекты, развернутые на том же хосте, рекомендуется использовать виртуальное окружение.```bash

python -m venv venv

Активация виртуального окружения

venv\Scripts\activate.bat # Windows командная строка venv\Scripts\Activate.ps1 # Windows PowerShell source venv/bin/activate # Linux

Установка с помощью pip

pip install -r requirements.txt

## Прямая установка проекта

```bash
# Установка с помощью pip
pip install -r requirements.txt
# Также можно использовать pip как модуль
python -m pip install -r requirements.txt

Запуск проекта

• Запуск проекта в обычном режиме

# Инициализация базы данных
flask db init
flask db migrate
flask db upgrade
flask admin init

# Запуск проекта
flask --app app.py run -h 0.0.0.0 -p 8000 --debug

# Или можно напрямую вызвать app.py
python app.py

• Запуск проекта с использованием docker-compose

git clone https://gitee.com/pear-admin/pear-admin-flask

# Установка docker-compose 
curl -L https://github.com/docker/compose/releases/download/1.26.2/docker-compose-`uname -s`-`uname -m` > /usr/local/bin/docker-compose
chmod +x /usr/local/bin/docker-compose
ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose
```# Выполните следующую команду, если есть вывод версии, это означает, что docker-compose готов к использованию
docker-compose --version 

# Для запуска приложения в текущей директории выполните следующую команду
docker-compose -f dockercompose.yaml up

# При успешном запуске вы увидите следующее сообщение. Поскольку установка через pip может занять некоторое время, пожалуйста, наберитесь терпения; если установка завершится с ошибкой, повторно выполните команду выше.

# После запуска откройте браузер и перейдите по адресу 127.0.0.1:5000
```# Для остановки контейнеров выполните следующую команду в текущей директории:
docker-compose -f dockercompose.yaml down

Предварительный просмотр проекта

Дополнительные сведения

Начальные учетные данные пользователя

По умолчанию имя пользователя — admin, пароль — 123456.