README-ru.md

python-trueconf-bot

Это легкая и мощная обертка для API чат-ботов TrueConf Server, позволяющая быстро интегрировать чат-ботов с API TrueConf.

English / Русский

Tip

При разработке мы вдохновлялись популярной библиотекой aiogram, поэтому разработчикам, знакомым с ней, переход будет простым и безболезненным.

---

⚙️ Устнановка

Вы можете установить python-trueconf-bot с помощью pip:

pip install python-trueconf-bot

или с помощью uv (предпочтительно):

uv add python-trueconf-bot

📦 Совместимость версий

Версия сервера TrueConf	Требуемая версия библиотеки
< 5.5.0	❌ Не поддерживается
5.5.0 — 5.5.2	v1.1.x
>= 5.5.3	v1.2.1 (или выше)

📌 Ключевые возможности

• Простая интеграция с API чат-ботов TrueConf Server;
• Быстрый старт с пакетом python-trueconf-bot;
• Современный и понятный Python API (from trueconf import Bot);
• Поддержка всех основных функций чат-ботов TrueConf Server.

Important

Функционал чат-ботов поддерживается начиная с версии TrueConf Server 5.5, а также в TrueConf Enterprise и TrueConf Server Free.

🚀 Пример бота

import asyncio
from trueconf import Bot, Dispatcher, Router, Message, F, ParseMode
from os import getenv

router = Router()
dp = Dispatcher()
dp.include_router(router)

TOKEN = getenv("TOKEN")

bot = Bot(server="video.example.com", token=TOKEN, dispatcher=dp)


@router.message(F.text)
async def echo(msg: Message):
    await msg.answer(f"You says: **{msg.text}**", parse_mode=ParseMode.MARKDOWN)


async def main():
    await bot.run()


if __name__ == "__main__":
    asyncio.run(main())

📚 Документация и поддержка

1. Документация API чат-ботов TrueConf Server
2. Документация python-trueconf-bot
3. Примеры

Все обновления и релизы доступны в репозитории. Следите за статусом сборок и покрытием тестами.

---

Начните создавать умных и надежных ботов для TrueConf уже сегодня с python-trueconf-bot!