Skip to content

reportingQ/sketal

 
 

Repository files navigation

vk-sketal logo

sketal

Codacy Badge Build Status

Немного о боте

  • Бот работает на python3.6 и выше. Ниже не работает. Совсем. Это важно.
  • Бот использует asyncio, aiohttp и т.д.

Инструкция

  1. Скачать python версии 3.6 или выше и установить его (с возможностью работать с ним из командной строки)
Можно скачать Python3.6 с оф. сайта: https://www.python.org/downloads/
  1. Установить модули для python с помощью pip (модуля python). Список модулей находится в requirements.txt
python -m pip install -r requirements.txt
  1. Заполнить настройки в settings.py (заменить нужные поля и т.д.).
    Как минимум необходимо ввести api ключ сообщества вконтакте.

  2. Бота можно запустить следующим способом из командной строки (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/

About

Бот для ВКонтакте. Беседы / группы / развлечения.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 99.8%
  • Makefile 0.2%