Вступление

Это документация для vk-botting - библиотеки, призванной помочь создавать чат-ботов, использующих VK API.

Требования

vk-botting работает с Python 3.6.0 или выше. Более низкие версии не поддерживаются. Python 2.7 и ниже тоже.

Установка

Библиотеку можно скачать прямо с PyPi:

python3 -m pip install -U vk-botting

Если вы используете Windows, то можно сделать так:

py -3 -m pip install -U vk-botting

Виртуальные среды

Иногда необходимо использовать библиотеки с версией отличной от установленных в системе или просто не хочется засорять систему. Или, возможно, у вас нет доступа к установке библиотек в систему. В таком случае, начиная с Python 3.3 в стандартную библиотеку входят так называемые «Virtual Environment»s, которые могут помочь решить подобные проблемы.

Более детальную информацию можно найти на Virtual Environments and Packages.

Но, для тех, кому лень читать:

1. Зайдите в папку своего проекта:

   $ cd your-bot-source
   $ python3 -m venv bot-env
   

2. Активируйте виртуальную среду:

   $ source bot-env/bin/activate
   

   Если вы используете Windows, то так:

   $ bot-env\Scripts\activate.bat
   

3. И можно использовать pip как обычно:

   $ pip install -U vk-botting
   

Поздравляю, у вас есть готовая виртуальная среда.

Базовые концепты

vk-botting основан на событиях. События можно ловить и обрабатывать. Например, когда приходит сообщение, вы узнаете об этом и сможете ответить.

Небольшой пример работы событий:

import vk_botting


class MyBot(vk_botting.Bot):
    async def on_ready(self):
        print(f'Logged on as {self.group.name}!')

    async def on_message_new(self, message):
        author = await message.get_author()
        print(f'Message from {author.first_name}: {message.text}')


bot = MyBot('your-prefix-here')
bot.run('your-token-here')