- Бот работает на python3.6 и выше. Ниже не работает. Совсем. Это важно.
- Бот использует asyncio, aiohttp и т.д.
- Скачать python версии 3.6 или выше и установить его (с возможностью работать с ним из командной строки)
Можно скачать Python3.6 с оф. сайта: https://www.python.org/downloads/
- Установить модули для python с помощью pip (модуля python). Список модулей находится в requirements.txt
python -m pip install -r requirements.txt
-
Заполнить настройки в settings.py (заменить нужные поля и т.д.).
Как минимум необходимо ввестиapi ключ сообщества
вконтакте. -
Бота можно запустить следующим способом из командной строки (windows) или терминала (linux) и т.д.:
python bot.py
USERS = (
("group", "ТОКЕН СООБЩЕСТВА",),
("user", "ЛОГИН ПОЛЬЗОВАТЕЛЯ", "ПАРОЛЬ ПОЛЬЗОВАТЕЛЯ",),
("user", "ТОКЕН ПОЛЬЗОВАТЕЛЯ",),
)
Пример возможного содержания переменной USERS. Если вам нужно использовать пользователя для бота - замените ("group", "API КЛЮЧ СООБЩЕСТВА",),
на ("user", "ЛОГИН ПОЛЬЗОВАТЕЛЯ", "ПАРОЛЬ ПОЛЬЗОВАТЕЛЯ",),
. Обратите внимание на запятые!
Как таковой документации проект сейчас не имеет. Многие функции, примеры, возможности бота можно найти, изучая исходный код плагинов и файлы бота. Например: tests.py
, vk/helpers.py
, handler/base_plugin.py
и т.д.
- Никакие плагины не должны менять код основных частей бота, чтобы было легко обновляться и менять какие-то базовые вещи (переписывать плагины легче, чем восстанавливать функционал после обновлений).
- При использовании CommandPlugin помните, что команды сортируются в соответствии с количесвом пробелов в команде (от большего к меньшему)
- Многие плагины требуют
PeeweePlugin
(база данных). - Крайне рекомендуется использовать
AdminPlugin
(контроль привилегий).
@michaelkrukov http://michaelkrukov.ru/