Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/deknowny/vkquick
Lightweight modern asynchronous framework for VK bots that can automatically build docs for your bots
https://github.com/deknowny/vkquick
aio async bot cli easy message python vk vkontakte
Last synced: 3 months ago
JSON representation
Lightweight modern asynchronous framework for VK bots that can automatically build docs for your bots
- Host: GitHub
- URL: https://github.com/deknowny/vkquick
- Owner: deknowny
- License: mit
- Created: 2020-05-09T14:34:17.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-05-02T17:01:04.000Z (over 1 year ago)
- Last Synced: 2024-09-26T21:43:27.284Z (4 months ago)
- Topics: aio, async, bot, cli, easy, message, python, vk, vkontakte
- Language: Python
- Homepage: https://vk.com/vkquick
- Size: 16.3 MB
- Stars: 70
- Watchers: 7
- Forks: 6
- Open Issues: 29
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
*__VK Quick__* — __это современный асинхронный фреймворк для создания ботов ВКонтакте, автоматически генерирующий документацию к командам бота в виде сайта__
* [__Официальное сообщество в ВКонтакте__](https://vk.com/vkquick)
* [__Официальная беседа, где отвят на любой вопрос по API и разработке ботов__](https://vk.me/join/AJQ1dzLqwBeU7O0H_oJZYNjD)
* [__Официальный сайт с документацией__](https://vkquick.rtfd.io)
***
## Ключевые особенности:
[](https://pepy.tech/project/vkquick)
* __Скорость__: VK Quick использует конкурентность в одном потоке (asyncio) и является одним из самых быстрых фреймворков для разработки ботов
* __Компактность кода__: Разработка требует меньше времени в несколько раз, код становится короче, вероятность возникновения багов уменьшается. VK Quick _автоматически_ создает документацию к написанному боту, позволяя сконцентрироваться разработчику именно на самом коде
* __Легкое обучение__: Создавать ботов невероятно просто вместе с VK Quick! Обучение проходит быстро и легко
* __Инструменты для упрощения разработки__: Из коробки VK Quick представляет CLI (терминальная утилита) — инструмент, облегающий процесс создания команд, настройки проекта и выстраивания архитектуры
* __Поддержка актуального API__: Множество разных возможностей для ботов перенесены в удобный Python-стиль, любые нововведения в социальной сети незамедлительно отображаются в самом фреймворке
* __Отзывчивое коммьюнити__: Вы всегда можете обратиться с вопросом, на который обязательно ответят наши специалисты по разработке ботов в официальной беседе нашего сообщества
***
## Установка
```shell script
python -m pip install vkquick
```
> До релиза 1.0: `python -m pip install https://github.com/deknowny/vkquick/archive/master.zip`
Вместе с фреймворком устанавливается треминальная утилита — `kwik`:
```shell script
kwik --help
```
***
# Echo-бот
Прежде чем создать своего первого бота, нужно получить специальный __токен__ — ключ, через который можно взаимодействовать с ресурсами ВК. VK Quick позволяет писать ботов как для групп, так и пользователей в одном стиле — достаточно запустить код с нужным токеном.
```python
import vkquick as vq
app = vq.App()
@app.command("пинг", "ping")
async def greeting():
"""
Самая обычная пинг-понг команда
"""
return "Понг!"
@app.command("дата", prefixes=["/"])
async def resolve_user(user: vq.User):
"""
Возвращает дату регистрации указанного пользователя
"""
registration_date = await vq.get_user_registration_date(user.id)
formatted_date = registration_date.strftime("%d.%m.%Y")
return f"Дата регистрации пользователя {user:@[fullname]}: {formatted_date}"
app.run("token")
```
Остается подставить вместо `"token"` свой токен. Теперь у нас есть бот сразу с двумя командами!
И __автоматически__ созданная документация по командам в папке `autodocs`
Хотите больше возможностей? Переходите на наш официальный сайт [https://vkquick.rtfd.io](https://vkquick.rtfd.io) и продолжайте углубляться в разработку ботов вместе с VK Quick!