python-trueconf-bot 1.0.0__tar.gz

python_trueconf_bot-1.0.0/.github/workflows/docs.yml

@@ -0,0 +1,37 @@
+name: Docs
+
+on:
+  push:
+    tags:
+      - 'docs/*'
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  deploy-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+
+      - name: Install docs deps
+        run: |
+          python -m pip install --upgrade pip
+          pip install mkdocs-material
+          if [ -f requirements-docs.txt ]; then pip install -r requirements-docs.txt; fi
+
+      - name: Configure git (gh-deploy)
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
+
+      - name: Deploy to gh-pages
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: mkdocs gh-deploy --force --remote-branch gh-pages

python_trueconf_bot-1.0.0/.github/workflows/release-test.yml

@@ -0,0 +1,45 @@
+name: Release to TestPyPI
+
+on:
+  workflow_dispatch:
+    inputs:
+      tag:
+        description: "Tag to release (e.g. v1.2.3 or v1.2.3rc1)"
+        required: true
+        type: string
+
+permissions:
+  contents: read
+  id-token: write
+
+jobs:
+  publish-to-testpypi:
+    runs-on: ubuntu-latest
+    environment: testpypi
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          fetch-tags: true
+          ref: ${{ github.event.inputs.tag }}
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+
+      - name: Build package
+        run: |
+          pip install build
+          python -m build
+
+      - name: Check dist metadata
+        run: |
+          pip install twine
+          twine check dist/*
+
+      - name: Publish package to TestPyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+          verbose: true

python_trueconf_bot-1.0.0/.github/workflows/release.yml

@@ -0,0 +1,67 @@
+name: Release to PyPI
+
+on:
+  workflow_dispatch:
+    inputs:
+      tag:
+        description: "Tag to release (e.g. v1.2.3 or v1.2.3rc1)"
+        required: true
+        type: string
+
+permissions:
+  contents: read
+  id-token: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          fetch-tags: true
+          ref: ${{ github.event.inputs.tag }}
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Build package
+        run: |
+          pip install build
+          python -m build
+
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/*
+
+  publish-stable:
+    needs: build
+    runs-on: ubuntu-latest
+    if: ${{ !contains(github.ref, '-') }}
+    environment: pypi
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist
+
+      - name: Publish stable to PyPI (Trusted Publisher)
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+  publish-prerelease:
+    needs: build
+    runs-on: ubuntu-latest
+    if: ${{ contains(github.ref, '-rc') || contains(github.ref, '-a') || contains(github.ref, '-b') }}
+    environment: pypi
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist
+
+      - name: Publish pre-release to PyPI (Trusted Publisher)
+        uses: pypa/gh-action-pypi-publish@release/v1

python_trueconf_bot-1.0.0/.gitignore

@@ -0,0 +1,187 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# PyPI configuration file
+.pypirc
+
+
+#VS Code folder
+.vscode
+
+# Config file
+
+config_models.py
+
+trueconf/_version.py
+
+.idea
+
+*.DS_Store
+
+.venv*
+venv*

python_trueconf_bot-1.0.0/LICENSE

@@ -0,0 +1,32 @@
+The Clear BSD License
+
+Copyright (c) 2025 TrueConf LLC
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted (subject to the limitations in the disclaimer
+below) provided that the following conditions are met:
+
+     * Redistributions of source code must retain the above copyright notice,
+     this list of conditions and the following disclaimer.
+
+     * Redistributions in binary form must reproduce the above copyright
+     notice, this list of conditions and the following disclaimer in the
+     documentation and/or other materials provided with the distribution.
+
+     * Neither the name of the copyright holder nor the names of its
+     contributors may be used to endorse or promote products derived from this
+     software without specific prior written permission.
+
+NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED BY
+THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
+CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
+BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
+IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.

python_trueconf_bot-1.0.0/PKG-INFO

@@ -0,0 +1,115 @@
+Metadata-Version: 2.4
+Name: python-trueconf-bot
+Version: 1.0.0
+Summary: Lightweight and powerful framework for the TrueConf Server Chatbot API
+Author-email: TrueConf LLC <info@trueconf.com>, Anton Baadzhi <baadzhianton@gmail.com>
+License-Expression: BSD-3-Clause-Clear
+Project-URL: Homepage, https://github.com/TrueConf/python-trueconf-bot
+Project-URL: Repository, https://github.com/TrueConf/python-trueconf-bot
+Project-URL: Documentation, https://trueconf.github.io/python-trueconf-bot
+Project-URL: Issues, https://github.com/TrueConf/python-trueconf-bot/issues
+Keywords: trueconf,chatbot,bot,api,framework,wrapper,asyncio,websocket
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Framework :: AsyncIO
+Classifier: Typing :: Typed
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Communications :: Chat
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: websockets
+Requires-Dist: httpx
+Requires-Dist: mashumaro
+Requires-Dist: aiofiles
+Requires-Dist: magic-filter
+Dynamic: license-file
+
+<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/python-trueconf-bot/master/assets/logo.svg" type="image/svg">
+      <img width="150" src="https://raw.githubusercontent.com/TrueConf/python-trueconf-bot/master/assets/logo.svg" type="image/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://t.me/trueconf_chat" target="_blank">
+        <img src="https://img.shields.io/badge/telegram-group-blue?style=flat-square&logo=telegram" />
+    </a>
+    <a href="https://chat.whatsapp.com/GY97WBzSgvD1cJG0dWEiGP">
+        <img src="https://img.shields.io/badge/whatsapp-commiunity-gree?style=flat-square&logo=whatsapp" />
+    </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/)
+
+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**!

python_trueconf_bot-1.0.0/README-PyPI.md

@@ -0,0 +1,83 @@
+<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/python-trueconf-bot/master/assets/logo.svg" type="image/svg">
+      <img width="150" src="https://raw.githubusercontent.com/TrueConf/python-trueconf-bot/master/assets/logo.svg" type="image/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://t.me/trueconf_chat" target="_blank">
+        <img src="https://img.shields.io/badge/telegram-group-blue?style=flat-square&logo=telegram" />
+    </a>
+    <a href="https://chat.whatsapp.com/GY97WBzSgvD1cJG0dWEiGP">
+        <img src="https://img.shields.io/badge/whatsapp-commiunity-gree?style=flat-square&logo=whatsapp" />
+    </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/)
+
+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**!

python_trueconf_bot-1.0.0/README-ru.md

@@ -0,0 +1,87 @@
+<p align="center">
+  <a href="https://trueconf.com" target="_blank" rel="noopener noreferrer">
+    <picture>
+      <source media="(prefers-color-scheme: dark)" srcset="assets/logo-cyrillic.svg" type="image/svg">
+      <img width="150" src="assets/logo-cyrillic.svg" type="image/svg">
+    </picture>
+  </a>
+</p>
+
+<h1 align="center">python-trueconf-bot</h1>
+
+<p align="center">Это легкая и мощная обертка для <a href="hhttps://trueconf.ru/docs/chatbot-connector/ru/overview/">API чат-ботов TrueConf Server</a>, позволяющая быстро интегрировать чат-ботов с API TrueConf.</p>
+
+<p align="center">
+    <a href="https://t.me/trueconf_chat" target="_blank">
+        <img src="https://img.shields.io/badge/telegram-group-blue?style=flat-square&logo=telegram" />
+    </a>
+    <a href="https://chat.whatsapp.com/GY97WBzSgvD1cJG0dWEiGP">
+        <img src="https://img.shields.io/badge/whatsapp-commiunity-gree?style=flat-square&logo=whatsapp" />
+    </a>
+    <a href="#">
+        <img src="https://img.shields.io/github/stars/trueconf/python-trueconf-bot?style=social" />
+    </a>
+</p>
+
+<p align="center">
+  <img src="/assets/head_ru.png" alt="Example Bot in TrueConf" width="600" height="auto">
+</p>
+
+<p align="center">
+  <a href="./README.md">English</a> /
+  <a href="./README-ru.md">Русский</a>
+</p>
+
+> [!TIP]
+> При разработке мы вдохновлялись популярной библиотекой [aiogram](https://github.com/aiogram/aiogram/), поэтому разработчикам,
+> знакомым с ней, переход будет **простым** и **безболезненным**.
+
+## Ключевые возможности
+
+- Простая интеграция с [API чат-ботов TrueConf Server](https://trueconf.ru/docs/chatbot-connector/ru/overview/);
+- Быстрый старт с пакетом `python-trueconf-bot`;
+- Современный и понятный Python API (`from trueconf import Bot`);
+- Поддержка всех основных функций чат-ботов TrueConf Server.
+
+> [!IMPORTANT]
+> Функционал чат-ботов поддерживается начиная с версии TrueConf Server 5.5, а также в TrueConf Enterprise и TrueConf Server Free.
+
+## Пример бота
+
+```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())
+```
+
+## Документация и поддержка
+
+1. [Документация API чат-ботов TrueConf Server](https://trueconf.ru/docs/chatbot-connector/ru/overview/)
+2. [Документация python-trueconf-bot](https://trueconf.github.io/python-trueconf-bot/ru/)
+
+Все обновления и релизы доступны в репозитории. Следите за статусом сборок и покрытием тестами.
+
+---
+
+Начните создавать умных и надежных ботов для TrueConf уже сегодня с **python-trueconf-bot**!