Metadata-Version: 2.4
Name: openvkbottle
Version: 0.1.0
Summary: Homogenic! Customizable asynchronous OpenVK API framework implementing comfort and speed.
License: MIT License
         
         Copyright (c) 2019 timoniq
         Copyright (c) 2022-2024 axd1x8a
         Copyright (c) 2024 luwqz1
         Copyright (c) 2026 cynexeso
         
         Permission is hereby granted, free of charge, to any person obtaining a copy
         of this software and associated documentation files (the "Software"), to deal
         in the Software without restriction, including without limitation the rights
         to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
         copies of the Software, and to permit persons to whom the Software is
         furnished to do so, subject to the following conditions:
         
         The above copyright notice and this permission notice shall be included in all
         copies or substantial portions of the Software.
         
         THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
         IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
         FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
         AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
         LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
         SOFTWARE.
License-File: LICENSE
Keywords: openvk,openvk-api,openvkbottle,bot-longpoll,user-longpoll,async,asyncio,bot,longpoll-api,callback,middleware
Author: cynexeso
Author-email: cynexeso@gmail.ru
Maintainer: cynexeso
Maintainer-email: cynexeso@gmail.ru
Requires-Python: >=3.10,<4.0
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: 3.15
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Quality Assurance
Classifier: Typing :: Typed
Requires-Dist: aiofiles (==24.1.0)
Requires-Dist: aiohttp (>=3.14.3,<4.0.0)
Requires-Dist: choicelib (>=0.1.5,<0.2.0)
Requires-Dist: colorama (>=0.4.6,<0.5.0)
Requires-Dist: openvkbottle-types (>=0.1.0,<0.2.0)
Requires-Dist: pydantic (>=2.13.4,<3.0.0)
Requires-Dist: typing-extensions (>=4.16.0,<5.0.0)
Requires-Dist: vbml (>=1.1.post1,<2.0)
Project-URL: Bug Tracker, https://github.com/OpenVKBottle/openvkbottle/issues
Project-URL: Documentation, https://github.com/OpenVKBottle/openvkbottle#readme
Project-URL: Homepage, https://github.com/OpenVKBottle/openvkbottle
Project-URL: Source, https://github.com/OpenVKBottle/openvkbottle
Description-Content-Type: text/markdown

<p align="center">
  <a href="https://github.com/openvkbottle/openvkbottle">
    <img width="150px" height="150px" alt="openvkbottle" src="https://raw.githubusercontent.com/openvkbottle/openvkbottle/master/docs/logo.svg">
  </a>
</p>
<h1 align="center">
  openvkbottle
</h1>
<p align="center">
    <em><b>Кастомизируемый, быстрый и удобный фреймворк для работы с OpenVK API</b></em>
</p>
<p align="center">
  <img alt="GitHub Workflow Status" src="https://img.shields.io/github/actions/workflow/status/cynexeso/openvkbottle/push-build.yml">
  <img alt="PyPI - Downloads" src="https://img.shields.io/pypi/dw/openvkbottle">
  <img alt="GitHub issues by-label" src="https://img.shields.io/github/issues/cynexeso/openvkbottle/bug">
  <img alt="PyPI" src="https://img.shields.io/pypi/v/openvkbottle?color=green&label=PyPI">
</p>

> OpenVKBottle - форк [VKBottle](https://github.com/vkbottle/vkbottle), адаптированный для работы с OpenVK.
> Основная цель проекта - упростить перенос существующих проектов с VKBottle на OpenVK с минимальными изменениями кода.
>
> OpenVKBottle не является официальным проектом VKCOM или оригинальных разработчиков VKBottle.
>
> API OpenVK может отличаться от VK API. Поэтому совместимость с оригинальным VKBottle не гарантируется во всех сценариях.

## Hello World

```python
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.

[Смотреть больше примеров!](https://github.com/vkbottle/vkbottle/tree/master/examples)

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

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

[Туториал для новичков](https://vkbottle.rtfd.io/ru/latest/tutorial/)\
[Техническая документация](https://vkbottle.rtfd.io/ru/latest)

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

## Установка

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

```console
pip install openvkbottle
```

## Отличия от VKBottle

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

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

```python
from vkbottle.user import User
```

на:

```python
from openvkbottle.user import User
```

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

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

OpenVKBottle основан на [VKBottle](https://github.com/vkbottle/vkbottle). Проект сохраняет исходную структуру и подходы там, где они совместимы с OpenVK, и адаптирует необходимые компоненты для работы с OpenVK API.

## Contributing

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

Сообщайте об ошибках и задавайте вопросы в разделе [Issues](https://github.com/openvkbottle/openvkbottle/issues).

[Контрибьютеры](https://github.com/openvkbottle/openvkbottle/graphs/contributors)

## Лицензия

OpenVKBottle распространяется по лицензии [MIT](LICENSE).

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

