Skip to main content

Lib that helps with telegram bots

Project description

tg_bot_base

tg_bot_base (далее - TBB) - это Python библиотека для упрощения создания телеграм ботов на базе Python-Telegram-Bot (далее - PTB). При этом планируется сделать TBB независимым от PTB.

Основные возможности

  1. Экраны - позволяют легко переключаться между заранее известными меню

Например. В вашем боте есть главное меню, из которого кнопки ведут в 3 других меню. Для этого вы можете заранее создать всевозможные меню, и организовать систему переходов между ними.
Не придётся переписывать и дублировать меню несколько раз

  1. Режим пользовательского ввода - позволяет принимать от пользователя сообщение в нужный момент, и выходить из этого режима, когда будет нужно.

Это может пригодиться в очень многих ситуациях, когда после нажатия на кнопку или после ввода сообщения нужно принять от пользователя ввод. Для этого бот переключается в режим ожидания ввода, и после того, как пользователь ввёл что-то, вызвалась пользовательская callback-функция

  1. Наличие подробных типов при создании клавиатур - снижает вероятность ошибки во время создания клавиатур и экранов в целом.

В телеграмме клавиатура представляется как двойной массив кнопок. Когда клавиатуры приходится динамически создавать, добавлять к ним строки, кнопки, многократно увеличивается возможность ошибиться. И только после Runtime Error разработчик узнаёт, что допустил ошибку, но даже в этот момент он может не понять, чем она была вызвана. TBB исключает такую возможность: Клавиатура, строка кнопок, кнопка, меню, экран в нём - это отдельные классы, в некоторых из которых прописаны выкидывание ошибок из-за несоответствия типов.

  1. Динамичность - Экраны, меню, текст, клавиатуры в TBB имеют возможность быть динамическими, и генерироваться в моменте.

Это может пригодиться в любых не самых простых ботах, в которых экраны хоть как-то могут меняться. Экран будет создаваться в моменте под определённую ситуацию. Так же это можно использовать для ботов, переведённых на несколько языков

  1. Лёгкий доступ к компонентам - большинство функций в TBB и в вашем боте будет нуждаться лишь в двух аргументах - bot_manager и user_id.

BotManager - это класс, который призван собрать в себе функционал всего бота. Из него есть ссылки к буквально всему - экранам, пользовательским переменным, базам данных, прочим менеджерам.

Установка и использование

Замените версию на нужную вам.

pip install git+https://github.com/Neveix/tg_bot_base.git@v1.4.3

Использование

Краткий обзор

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tg_bot_screen-1.4.22.tar.gz (10.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

tg_bot_screen-1.4.22-py3-none-any.whl (19.7 kB view details)

Uploaded Python 3

File details

Details for the file tg_bot_screen-1.4.22.tar.gz.

File metadata

  • Download URL: tg_bot_screen-1.4.22.tar.gz
  • Upload date:
  • Size: 10.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for tg_bot_screen-1.4.22.tar.gz
Algorithm Hash digest
SHA256 f5d245ea92eb25d99569d902a66a81b65308eecd7731b588233545052fd86448
MD5 2c425bfdcd1895def7462d6653fda047
BLAKE2b-256 8e343ce1ab702070983e64da1d7aadf511ef33d2719040ff108ae3d373ebb236

See more details on using hashes here.

File details

Details for the file tg_bot_screen-1.4.22-py3-none-any.whl.

File metadata

  • Download URL: tg_bot_screen-1.4.22-py3-none-any.whl
  • Upload date:
  • Size: 19.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for tg_bot_screen-1.4.22-py3-none-any.whl
Algorithm Hash digest
SHA256 8976bc21cac52dfb25e024b1a089002782d35032b0c370495afb6c1cca0032e1
MD5 08ee22b9ff27e956977d7b493985b78d
BLAKE2b-256 f63760701969d249c8cf40f3ea7bf5fa57170eb3da63d90dffa398dc8cdbea18

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page