python-trueconf-bot 1.1.3
Lightweight and powerful framework for the TrueConf Server Chatbot API
Requires Python: >=3.10
Keywords: trueconf, chatbot, bot, api, framework, wrapper, asyncio, websocket

<p align="center">
  <a href="https://trueconf.com" target="_blank" rel="noopener noreferrer">
    <picture>
      <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/TrueConf/.github/refs/heads/main/logos/logo-dark.svg">
      <img width="150" alt="trueconf" src="https://raw.githubusercontent.com/TrueConf/.github/refs/heads/main/logos/logo.svg">
    </picture>
  </a>
</p>

<h1 align="center">python-trueconf-bot</h1>

<p align="center">This is a lightweight and powerful wrapper for the <a href="https://trueconf.com/docs/chatbot-connector/en/overview/">TrueConf Server Chatbot API</a> which enables quick integration of chatbots into TrueConf solutions.</p>

<p align="center">
    <a href="https://pypi.org/project/python-trueconf-bot/">
        <img src="https://img.shields.io/pypi/v/python-trueconf-bot">
    </a>
    <a href="https://pypi.org/project/python-trueconf-bot/">
        <img src="https://img.shields.io/pypi/pyversions/python-trueconf-bot">
    </a>
    <a href="https://pypi.org/project/python-trueconf-bot/">
        <img src="https://static.pepy.tech/personalized-badge/python-trueconf-bot?period=total&units=NONE&left_color=GREY&right_color=BRIGHTGREEN&left_text=Downloads" alt="PyPI Downloads">
    </a>
    <a href="https://t.me/trueconf_chat" target="_blank">
        <img src="https://img.shields.io/badge/Telegram-2CA5E0?logo=telegram&logoColor=white" />
    </a>
    <a href="https://discord.gg/2gJ4VUqATZ">
        <img src="https://img.shields.io/badge/Discord-%235865F2.svg?&logo=discord&logoColor=white" />
    </a>
    <a href="#">
        <img src="https://img.shields.io/github/stars/trueconf/python-trueconf-bot?style=social" />
    </a>
</p>

<p align="center">
  <img src="https://raw.githubusercontent.com/TrueConf/python-trueconf-bot/master/assets/head_en.png" alt="Example Bot in TrueConf" width="600" height="auto">
</p>

> 💡TIP
> 
> We were inspired by the popular [aiogram](https://github.com/aiogram/aiogram/) library, so, the transition will be **simple** for developers already familiar with this library.

## 📌 Key Features

* Easy integration with the [TrueConf Server Chatbot API](https://trueconf.com/docs/chatbot-connector/en/overview/)
* 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

```python
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](https://trueconf.com/docs/chatbot-connector/en/overview/)
2. [python-trueconf-bot Documentation](https://trueconf.github.io/python-trueconf-bot/)
3. [Examples](examples/README.md)

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**!