Шаблон рабочего чат-бота VKBotKit

В данном репозитории описан стандартный вид чат-бота, работающего при помощи vkbotkit. Репозиторий можно использовать как шаблон.

Структура репозитория

• assets - каталог с медиафайлами (доступ к файлам реализуется через toolkit.assets либо tools.upload)
• library - каталог со скриптами обработчиков
• bot.py - корневой скрипт чатбота (для запуска и конфигурации основных настроек)
• requirements.txt - файл с требуемыми библиотеками для работы шаблона
• .env - файл с переменными окружения

Установка и настройка бота в вашем сообществе ВКонтакте

0. Создайте сообщество ВКонтакте

Перейдите во вкладку "Сообщества" на сайте ВКонтакте, или используйте ссылку vk.com/groups

1. Перейдите в раздел для работы с API

Перейдите во вкладку "Управление" при помощи первой ссылки в админ-меню вашего сообщества

Перейдите во вкладку "Работа с API"

2. Создайте токен

В шапке раздела нажмите на "Создать ключ"

Выберите необходимые права для вашего токена, затем нажмите "Создать" и подтвердите свою личность.

3. Настройте Long Poll сервер

В шапке раздела нажмите "Long Poll API".
Во вкладке "Настройки" включите пункт "Long Poll API" и выберите нужную версию API.
Во вкладке "Типы событий" выберите нужные типы, которые будут обрабатываться чат-ботом. Обязательно включите "Входящие сообщения".

4. Клонируйте репозиторий бота к себе на компьютер/сервер

В нашем случае мы будем использовать репозиторий vkbotkit/template в качестве шаблона. В результате получается репозиторий your_name/your_bot, где your_name - ваш никнейм, а your_bot - название созданного репозитория.

git clone https://github.com/your_name/your_bot.git
cd your_bot
pip install -r requirements.txt

5. Настройка бота

Бот готов к использованию, но перед запуском нужно установить полученный в пункте 2 ключ доступа и ID сообщества. Для этого в репозитории нужно создать файл .env

• PUBLIC_TOKEN - ключ доступа от сообщества

• PUBLIC_ID - ID сообщества

• DEBUG_TOKEN - ключ доступа от сообщества в режиме отладки

• DEBUG_ID - ID сообщества в режиме отладки

• DEBUG_MODE - режим отладки (по умолчанию True)

• CONFIG_LOG - конфигурация лога

f - вывод лога в файл,
c - вывод лога в консоль

6. Запуск бота

python3 bot.py [-d]

7. Проверка работы чатбота