Skip to main content

Lib that helps with telegram bots

Project description

tg_bot_base

tg_bot_base (в pypi - tg_bot_screen) (далее - 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 tg_bot_screen

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

  1. Создайте директорию с вашим проектом
  2. В ней напишите: python -m tg_bot_screen --ptb
  3. Убедитесь, что в вашем окружении есть переменная BOT_TOKEN, в которой записан токен бота из BotFather
  4. Готово! Можете дорабатывать бот

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.34.tar.gz (15.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.34-py3-none-any.whl (28.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: tg_bot_screen-1.4.34.tar.gz
  • Upload date:
  • Size: 15.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.34.tar.gz
Algorithm Hash digest
SHA256 447808a6682d70fe6e0239da494747cd2472c68cd00ad69870baad4cdec13f63
MD5 50dd1b2a077263fd9719356c29d659c1
BLAKE2b-256 83f353059e111e38b51347f7d051110e258d16549656c03167c517d513ac8d2a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: tg_bot_screen-1.4.34-py3-none-any.whl
  • Upload date:
  • Size: 28.6 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.34-py3-none-any.whl
Algorithm Hash digest
SHA256 1cee48d38aac71465f041bb91a58711d421d3b34f540948d5775f69f1194e277
MD5 b190b1335bcfa1d8799f1bf7a6501fed
BLAKE2b-256 53d30539fc918695d9ef80571a9eca7dfd821fbc7b8c15221478cf867009583c

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