Metadata-Version: 2.1
Name: vkwave
Version: 0.2.3
Summary: Framework for building high-performance & easy to scale projects interacting with VK's API.
Home-page: https://github.com/fscdev/vkwave
License: MIT
Keywords: vk,vkontakte,api,framework,wrapper,asyncio,bots
Author: prostomarkeloff
Requires-Python: >=3.7,<4.0
Classifier: Environment :: Console
Classifier: Framework :: AsyncIO
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Classifier: Typing :: Typed
Provides-Extra: all
Provides-Extra: storage-redis
Requires-Dist: aiohttp (>=3.6,<4.0)
Requires-Dist: aioredis (>=1.3,<2.0); extra == "storage-redis" or extra == "all"
Requires-Dist: pydantic (>=1.4,<2.0)
Requires-Dist: typing_extensions (>=3.7.4,<4.0.0)
Project-URL: Bug Tracker, https://github.com/fscdev/vkwave/issues
Project-URL: Repository, https://github.com/fscdev/vkwave
Description-Content-Type: text/markdown

![vkwave](https://user-images.githubusercontent.com/28061158/75329873-7f738200-5891-11ea-9565-fd117ea4fc9e.jpg)

> It's time to carry out vk_api & vkbottle. VKWave is here.

[Русская версия](https://github.com/fscdev/vkwave/blob/master/readme_ru.md)

[Why VKWave?](./why_vkwave.md)

```python
from vkwave.bots import SimpleLongPollBot

bot = SimpleLongPollBot(tokens="MyToken", group_id=123456789)

@bot.message_handler()
def handle(_) -> str:
    return "Hello world!"

bot.run_forever()

```

# What is it?

Framework for building high-performance & easy to scale projects interacting with VK's API.

It's built over asyncio and Python's type hints. Minimal required version is `3.7`.

Our Telegram chat - [let's chat](https://t.me/vkwave)

Current maintainer of this project is [@kesha1225](https://github.com/kesha1225)

## Installation

```
pip install vkwave
```

or with the latest updates
```
pip install https://github.com/fscdev/vkwave/archive/master.zip
```

## VKWave core

This repostitory contains only `core` parts of VKWave. It means that code introduced in this repository is probably `low-level` and shouldn't be used directly unless otherwise specified.

## Performance

VKWave is a most fast library for Python for working with VK's API.

## Parts

- Client - [core part](./vkwave/client)
- API - [use VK's API in the most fancy way](./vkwave/api)
- Bots - [create awesome bots with ease](./vkwave/bots)
- FSM - [FSM implementation for VKWave](./vkwave/bots/fsm)
- Storage - [FSM Storage](./vkwave/bots/storage)
- Bots utils - [keyboards, carousels, ...](./vkwave/bots/utils)
- LongPoll - [acessing VK's longpoll (user/bot)](./vkwave/longpoll)

## Community

VKWave is a young project.

If you want to create addon for VKWave (like `fsm` for bots or something like that) you should name your project like that: `vkwave-bots-fsm`.

