https://github.com/neluckoff/vk_queue_bot

Бот Вконтакте (vkbottle) для очередей. Удобное навигационное меню, команды для администрации и пользователей.
https://github.com/neluckoff/vk_queue_bot

vk vk-api vkbot vkbottle vkbottle-example vkontakte

Last synced: 25 days ago
JSON representation

Бот Вконтакте (vkbottle) для очередей. Удобное навигационное меню, команды для администрации и пользователей.

• Host: GitHub
• URL: https://github.com/neluckoff/vk_queue_bot
• Owner: neluckoff
• License: mit
• Created: 2022-04-17T11:10:49.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2022-05-01T16:22:37.000Z (over 2 years ago)
• Last Synced: 2023-03-10T02:26:19.041Z (almost 2 years ago)
• Topics: vk, vk-api, vkbot, vkbottle, vkbottle-example, vkontakte
• Language: Python
• Homepage:
• Size: 49.8 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# [В]контакте бот для очередей

Бот предназначен для групп людей (одноклассников, одногруппников и т.д.), которым необходимо пользоваться электронной очередью для сдачи практических работ.



  

  

  



## УСТАНОВКА

Для написания кода использовалась библиотека [vkbottle](https://github.com/vkbottle/vkbottle).

Для установки всех зависимостей просто пропишите ```python -m pip install -r requirements.txt```

## БЫСТРЫЙ СТАРТ

В файлах [dotenv](https://github.com/neluckoff/vk_queue_bot/blob/master/.env) и [settings.py](https://github.com/neluckoff/vk_queue_bot/blob/master/settings.py) хранится основная информация о вашем боте, а именно ``token``, ``group_id`` и ``admin_list``.

В переменную ``token`` необходимо создать и записать токен сообщества, в которой у Вас будет находиться бот. Для этого нужно открыть настройки группы, перейти в вкладку "Работа с API" и создать или скопировать уже имеющийся токен.

В переменной ``group_id`` хранится ID группы, в которой находится бот, взять его можно в основной информации Вашего сообщества.

В массив переменных ``admin_list`` необходимо вписать ID участников сообщества, у которых будет доступ к командам администрирования очереди.

## ЭКСКУРСИЯ

В боте построена небольшая база данных SQLite, которая создается после регистрации первого пользователя.

Она добавляет в себя новых пользователей после прописывания команды "**Меню**" (только в том случае, если пользователь еще не был добавлен)

Почти весь текст (реакции на команды и т.д.) хранится в файле [strings.py](https://github.com/neluckoff/vk_queue_bot/blob/master/data/strings.py)

Все команды разбиты на две категории: [команды администрации](https://github.com/neluckoff/vk_queue_bot/blob/master/commands/admins/admin_commands.py) и [команды пользователей](https://github.com/neluckoff/vk_queue_bot/blob/master/commands/users/user_commands.py), а также хранятся в отдельных файлах.

Для удобства навигации во время пользования ботом - реализованы [клавиатуры](https://github.com/neluckoff/vk_queue_bot/blob/master/data/keyboards.py), чтобы пользователи не прописывали постоянно команды.



## КОМАНДЫ ПОЛЬЗОВАТЕЛЕЙ

+ **Присоединиться** - команда для присоединения пользователя к существующей очереди.

+ **Посмотреть** - команда для просмотра пользователем существующей очереди.

+ **Регистрация** - команда для добавления пользователя в базу данных (обязательна для рассылки о начале очереди).

+ **Меню** - вызов пользователем меню.

+ **Выйти** - команда для выхода пользователя из очереди.

+ **Ответил** - команда для первого человека в очереди (выход из очереди после ответа).

## КОМАНДЫ АДМИНИСТРАЦИИ

+ **Админ-панель** - вызов администратором панели (меню) для дальнейшей работы.

+ **Создать** - команда администратора для создания очереди. Также можно использовать **Создать ``NAME``** для создания очереди с названием.

+ **Очистить** - команда администратора для полной очистки очереди.

+ **Перемешать** - команда администратора для перемешивания очереди (используется до старта).

+ **Старт** - команда администратора для старта очереди.

+ **Убрать первого** - команда администратора для удаления первого человека в списке.

+ **Удалить ``num``** - команда администратора для удаления ``num`` номера в очереди.

+ **Переместиться на ``num``** - команда администратора для перемешения его на ``num`` место в списке.

+ **Поменять ``num1`` ``num2``** - команда администратора для того, чтобы поменять пользователя ``num1`` и пользователя ``num2`` местами.