README-PyPI.md

python-trueconf-bot

This is a lightweight and powerful wrapper for the TrueConf Server Chatbot API which enables quick integration of chatbots into TrueConf solutions.

💡TIP

We were inspired by the popular aiogram library, so, the transition will be simple for developers already familiar with this library.

---

⚙️ Install

You can install python-trueconf-bot using pip:

pip install python-trueconf-bot

Or with uv (recommended):

uv add python-trueconf-bot

📦 Version Compatibility

TrueConf Server Version	Required Library Version
< 5.5.0	❌ Not supported
5.5.0 — 5.5.2	v1.1.x
>= 5.5.3	v1.2.1 (or higher)

📌 Key Features

• Easy integration with the TrueConf Server Chatbot API
• Quick start with the python-trueconf-bot package
• Modern and intuitive Python API (from trueconf import Bot)
• Support for all major TrueConf Server chatbot features.

☝️IMPORTANT

Chatbot features are supported in TrueConf Server 5.5 or above, TrueConf Enterprise, and TrueConf Server Free.

🚀 Example Bot

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())

📚 Documentation

1. TrueConf Server Chatbot API Documentation
2. python-trueconf-bot Documentation
3. Examples

All updates and releases are available in the repository. Track the build status and test coverage.

---

Start building smart and reliable bots for TrueConf today with python-trueconf-bot!