Процесс разработки модуля
Обновлено: 07 Декабрь 2025
Версия: 2.2
1. Создание Django приложения
Создайте стандартное Django приложение:
python manage.py startapp example_module
2. Разработка функционала
Реализуйте необходимый функционал модуля:
- Модели данных
- Представления
- URL маршруты
- Шаблоны
- Статические файлы
Важно при работе с переводами:
- Используйте
gettext_lazy(_()) для всех строк, которые будут отображаться пользователю - При объединении списков с переведенными строками всегда преобразуйте их в обычные строки:
python
error_strings = [str(error) for error in errors]
message = ', '.join(error_strings)
- В миграциях используйте обычные строки, а не переведенные
3. Создание module.json
Создайте файл module.json в корне приложения с необходимой конфигурацией.
4. Упаковка модуля
Упакуйте приложение в ZIP архив:
cd example_module
zip -r ../example_module.zip .
Важно: В корне ZIP архива должен находиться файл module.json.
5. Установка модуля
Вариант 1: Через каталог модулей (рекомендуется)
- Перейдите в раздел настроек -> "Modules" (
/settings/modules/) - Нажмите кнопку "Add Module"
- Выберите ZIP архив с модулем
- Система автоматически:
- Распакует архив
- Проверит наличие и валидность
module.json - Извлечет все данные модуля из конфигурации
- Создаст запись модуля в каталоге
- Создаст версию модуля с ZIP файлом
- После успешного добавления модуль появится в каталоге
- Нажмите кнопку "Install" для установки модуля
Важно: При загрузке модуля все поля (название, описание, автор и т.д.) автоматически заполняются из файла module.json. Если файл отсутствует или имеет неверный синтаксис, будет показана ошибка.
Вариант 2: Через админ-панель
- Перейдите в раздел "Modules" в админ-панели
- Нажмите "Upload Module"
- Загрузите ZIP архив
- Модуль будет автоматически добавлен в каталог
- Установите модуль через каталог (
/settings/modules/)
Вариант 3: Через API
POST /modules/api/modules/{id}/install/