openvkbottle

Кастомизируемый, быстрый и удобный фреймворк для работы с OpenVK API

OpenVKBottle - форк VKBottle, адаптированный для работы с OpenVK. Основная цель проекта - упростить перенос существующих проектов с VKBottle на OpenVK с минимальными изменениями кода.

OpenVKBottle не является официальным проектом VKCOM или оригинальных разработчиков VKBottle.

API OpenVK может отличаться от VK API. Поэтому совместимость с оригинальным VKBottle не гарантируется во всех сценариях.

Hello World

from openvkbottle.user import User

bot = User("access_token")


@bot.on.message()
async def handler(_) -> str:
    return "Hello, World!"


bot.run()

Обратите внимание: для работы с OpenVK используются подходящие для OpenVK токены и методы API. Возможности авторизации и запуска бота зависят от используемого режима API.

Смотреть больше примеров!

Документация

Поскольку OpenVKBottle сохраняет структуру и подходы оригинального VKBottle, большая часть документации остаётся актуальной.

Туториал для новичков
Техническая документация

Документация написана для оригинального VKBottle. При её использовании учитывайте различия между VK API и OpenVK API, а также возможные отличия в поддерживаемых методах и типах.

Установка

Установить последнюю опубликованную версию можно командой:

pip install openvkbottle

Отличия от VKBottle

OpenVKBottle стремится сохранить знакомый интерфейс VKBottle, чтобы существующие проекты можно было адаптировать с минимальными изменениями.

В простых случаях переход может сводиться к замене импортов:

from vkbottle.user import User

на:

from openvkbottle.user import User

Однако одной замены импортов может быть недостаточно: некоторые методы, типы, параметры запросов и механизмы API могут отличаться в OpenVK.

Происхождение проекта

OpenVKBottle основан на VKBottle. Проект сохраняет исходную структуру и подходы там, где они совместимы с OpenVK, и адаптирует необходимые компоненты для работы с OpenVK API.

Contributing

ПР приветствуются! Перед созданием pull request ознакомьтесь с CONTRIBUTION_GUIDE. Нам приятно видеть ваш вклад в развитие фреймворка.

Сообщайте об ошибках и задавайте вопросы в разделе Issues.

Контрибьютеры

Лицензия

OpenVKBottle распространяется по лицензии MIT.

Проект основан на VKBottle. Уведомления об авторских правах оригинальных авторов сохранены в файле LICENSE.