правит документацию

.pre-commit-config.yaml

@@ -29,6 +29,8 @@ repos:
     rev: 7.1.0 # sync:flake8:poetry.lock
     hooks:
       - id: flake8
+        additional_dependencies:
+          - flake8-type-checking
   - repo: https://github.com/PyCQA/bandit
     rev: 1.7.9 # sync:bandit:poetry.lock
     hooks:

src/altlinux/README.md

@@ -2,14 +2,14 @@
 
 ## Описание
 
-Подготовленная версия Karkas Lite для интеграции в чат [Альт Линукс](https://t.me/alt_linux)
+Подготовленная версия Karkas для интеграции в чат [Альт Линукс](https://t.me/alt_linux)
 
 ## Функционал
 Список OCAB-модулей используемых в боте:
 
 * report - Вызов администрации чата одной командой
 * welcome - Автоматическая вариативная проверка пользователей на признаки бота или другой автоматической рекламной системы
-* help - Получение информации об Karkas Lite
+* help - Получение справки о боте
 
 ## Запуск
 
@@ -17,18 +17,18 @@
 
 1. Соберите Docker-образ:
     ```bash
-    docker build -t gnomik .
+    docker build -t altlinux -f Dockerfile ../..
     ```
 2. Запустите контейнер:
     ```bash
-    docker run -p 9000:9000 -v ./config.yaml:/app/config.yaml -v ./database:/app/database gnomik
+    docker run -p 9000:9000 -v ./config.yaml:/app/config.yaml altlinux
     ```
 
-    Замените `./config.yaml` и `./database` на пути к вашим локальным файлам конфигурации и паки для базы данных.
+    Замените `./config.yaml` на путь к вашему локальному файлу конфигурации.
 
 ### Вручную
 
-1. Активируйте виртуальное окружение Gnomика:
+1. Активируйте виртуальное окружение:
     ```bash
     poetry shell
     ```
@@ -39,7 +39,9 @@
 
 ## Конфигурация
 
-Конфигурация бота находится в файле `config.yaml`.
+Конфигурация хранится в файле `config.yaml`.
+
+Пример конфигурации бота находится в файле `config-example.yaml`.
 
 ## Модули
 

src/altlinux/config-example.yaml

@@ -2,6 +2,45 @@ core:
   mode: LONG_POLLING
   token: xxx
 
-filters:
-  approved_chat_id:
-    - -111111
+#
+# filters:
+#   approved_chat_id:
+#     - -100000000000
+#
+
+#
+# welcome:
+#   show_success_message: True
+#   max_attempts: 5
+#   timeout: 60
+#   tasks:
+#     math_buttons:
+#       enabled: False
+#     math_poll:
+#       enabled: True
+#     question_buttons:
+#       enabled: False
+#     question_poll:
+#       enabled: False
+#
+
+#
+# report:
+#   errors:
+#     no_reply_message: "Пожалуйста, используйте команду в ответ на сообщение"
+#   mention:
+#     text: "⚠️ Внимание, жалоба на спам! $mention"
+#     limit: 5
+#     list:
+#       - "@test1"
+#       - "@test2"
+#       - "@test3"
+#       - "@test4"
+#       - "@test5"
+#       - "@test6"
+#
+
+#
+# help:
+#   message: "$commands"
+#

src/altlinux/docker-compose.yml

@@ -1,5 +1,3 @@
-version: '3'
-
 services:
   app:
     build: