Lib that helps with telegram bots
Project description
tg_bot_base
tg_bot_base (далее - TBB) - это Python библиотека для упрощения создания телеграм ботов на базе Python-Telegram-Bot (далее - PTB). При этом планируется сделать TBB независимым от PTB.
Основные возможности
- Экраны - позволяют легко переключаться между заранее известными меню
Например. В вашем боте есть главное меню, из которого кнопки ведут в 3 других меню. Для этого вы можете заранее создать всевозможные меню, и организовать систему переходов между ними.
Не придётся переписывать и дублировать меню несколько раз
- Режим пользовательского ввода - позволяет принимать от пользователя сообщение в нужный момент, и выходить из этого режима, когда будет нужно.
Это может пригодиться в очень многих ситуациях, когда после нажатия на кнопку или после ввода сообщения нужно принять от пользователя ввод. Для этого бот переключается в режим ожидания ввода, и после того, как пользователь ввёл что-то, вызвалась пользовательская callback-функция
- Наличие подробных типов при создании клавиатур - снижает вероятность ошибки во время создания клавиатур и экранов в целом.
В телеграмме клавиатура представляется как двойной массив кнопок. Когда клавиатуры приходится динамически создавать, добавлять к ним строки, кнопки, многократно увеличивается возможность ошибиться. И только после Runtime Error разработчик узнаёт, что допустил ошибку, но даже в этот момент он может не понять, чем она была вызвана. TBB исключает такую возможность: Клавиатура, строка кнопок, кнопка, меню, экран в нём - это отдельные классы, в некоторых из которых прописаны выкидывание ошибок из-за несоответствия типов.
- Динамичность - Экраны, меню, текст, клавиатуры в TBB имеют возможность быть динамическими, и генерироваться в моменте.
Это может пригодиться в любых не самых простых ботах, в которых экраны хоть как-то могут меняться. Экран будет создаваться в моменте под определённую ситуацию. Так же это можно использовать для ботов, переведённых на несколько языков
- Лёгкий доступ к компонентам - большинство функций в TBB и в вашем боте будет нуждаться лишь в двух аргументах - bot_manager и user_id.
BotManager - это класс, который призван собрать в себе функционал всего бота. Из него есть ссылки к буквально всему - экранам, пользовательским переменным, базам данных, прочим менеджерам.
Установка и использование
Замените версию на нужную вам.
pip install git+https://github.com/Neveix/tg_bot_base.git@v1.4.3
Использование
Краткий обзор
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file tg_bot_screen-1.4.12.tar.gz.
File metadata
- Download URL: tg_bot_screen-1.4.12.tar.gz
- Upload date:
- Size: 9.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0e5e68846b87c406ffb5c6ee575a879060f579c2afa65705b445b1d49ae1e2fa
|
|
| MD5 |
c4f0feeabf8b5532cdaf99c3171a20df
|
|
| BLAKE2b-256 |
c59dd45e8c7cd7846b99cd5852ac05a73c4d482384509c65ebcd8d80d77648bd
|
File details
Details for the file tg_bot_screen-1.4.12-py3-none-any.whl.
File metadata
- Download URL: tg_bot_screen-1.4.12-py3-none-any.whl
- Upload date:
- Size: 14.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5e30d553cd223e53dc4ccb220879aa1853186ef02e0ecebf9d8facc077dbf942
|
|
| MD5 |
695d262edc6eaca95c81ce021a73c6cd
|
|
| BLAKE2b-256 |
c57639b1405bfc1e7745bf9f5fc211f1f6419a9c43be1005710556af48a512dc
|
