Skip to main content

Modern async VK bot framework

Project description

VKFlow

VKFlow

Современный асинхронный фреймворк для создания ботов ВКонтакте

PyPI Python License Docs VK


Установка

pip install vkflow

С дополнениями для производительности:

pip install vkflow[speed]

Быстрый старт

import vkflow as vf

app = vf.App()

@app.command("ping")
async def ping():
    return "Pong!"

@app.command("дата")
async def reg_date(user: vf.User):
    date = await vf.get_user_registration_date(user.id)
    return f"{user:@[first_name]} зарегистрирован {date:%d.%m.%Y}"

app.run("YOUR_TOKEN")

Возможности

Type hints как аргументы - параметры команд парсятся из аннотаций типов

Интерактивный UI - клавиатуры, карусели, View с callback-кнопками

FSM - конечные автоматы для многошаговых диалогов

Cog-система - группировка команд в модули

Проверки и cooldown - декораторы для контроля доступа

Webhook и LongPoll - оба режима из коробки

Система аддонов - расширение функциональности через плагины

Интерактивные View
class ConfirmView(vf.ui.View):
    def __init__(self):
        super().__init__(timeout = 60, inline = True)
        self.result = None

    @vf.ui.button(label = "Да", color = "positive")
    async def yes(self, interaction: vf.Callback):
        self.result = True
        await interaction.answer("Принято!")
        self.stop()

    @vf.ui.button(label = "Нет", color = "negative")
    async def no(self, interaction: vf.Callback):
        self.result = False
        await interaction.answer("Отменено")
        self.stop()
Cog-модули
class Admin(vf.Cog):
    @vf.command("бан")
    @vf.check(...)
    async def ban(self, ctx: vf.Context, user: vf.User):
        ...
        await ctx.reply(f"{user:@[first_name]} забанен")

Требования

  • Python 3.11+
  • VK API 5.199

Credits

Based on vkquick.

Лицензия

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vkflow-1.0.0.tar.gz (163.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

vkflow-1.0.0-py3-none-any.whl (205.2 kB view details)

Uploaded Python 3

File details

Details for the file vkflow-1.0.0.tar.gz.

File metadata

  • Download URL: vkflow-1.0.0.tar.gz
  • Upload date:
  • Size: 163.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.15 {"installer":{"name":"uv","version":"0.9.15","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for vkflow-1.0.0.tar.gz
Algorithm Hash digest
SHA256 f1bba25bc9940ec2dd37113bc5dbdf01299b27f040334fd1b0e0537289e17aa8
MD5 ab099b3061944097de9c20e5b37fa679
BLAKE2b-256 a56b9481bb6609dabe53b7cb01b52a1dbaf9c3b4788552384d8076c0dc01f55f

See more details on using hashes here.

File details

Details for the file vkflow-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: vkflow-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 205.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.15 {"installer":{"name":"uv","version":"0.9.15","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for vkflow-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e4c98b6598fcb5170c93401edef11c8c805d92dfb3f6b37a55481266705deb5c
MD5 bc5d1b6fddae0c2189bffb97eec19430
BLAKE2b-256 95a637b5e3115005dc58801dc75d14b119395c444b3cd06e038c23c6d00d2408

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page