Как установить pytelegrambotapi

Подготовка рабочего места в Windows и Linux. Virtual Environment (venv). Ответы на вопросы

Весь текст ниже появился как попытка дать универсальный ответ на те вопросы, которые дорогие читатели присылали и продолжают присылать раз за разом. Здесь не будет кода, связанного с ботами напрямую, а лишь советы по организации процесса написания. И, конечно же, не нужно воспринимать это как истину в последней инстанции, напротив, выбирайте те инструменты и подходы к разработке, которые лично вам кажутся удобными. Важная деталь: текст написан в конце 2019 года. Достаточно вступительных слов, поехали!

Предположим, вы уже немного знаете язык Python 3 (забудьте про Python 2.7, он мёртв), умеете писать простенькие программы и хотите взяться за разработку ботов. Где это делать? В чём писать код? Как правило, у большинства начинающих программистов основной операционкой используется Microsoft Windows. С неё и начнём, но сперва…

Virtual environment

Вы когда-нибудь пользовались VirtualBox? Например, чтобы «пощупать» другие операционные системы или просто установить какой-нибудь подозрительный софт. Python Virtual environment (далее — venv) чем-то напоминает «виртуалку». При его использовании создаётся копия выбранного интерпретатора Питон, а все устанавливаемые модули хранятся изолированно от общесистемных, тем самым, упрощается их обновление, удаление или изменение. Часто venv позволяет избежать ошибок, связанных с обратной совместимостью некоторых библиотек, а также обойтись без конфликтов с системными модулями. Работа с venv будет подробнее описана ниже в разделе Linux, но использовать его мы будем везде.

Windows

Первым делом, разумеется, нужно скачать сам интерпретатор Python. На момент написания этого текста актуальной версией является Python 3.8.1. В качестве каталога установки я рекомендую использовать что-то простое, вроде C:\Python38. Где писать код — личное дело каждого, конечно, но я всё же рекомендую использовать специальную среду разработки под названием PyCharm Community Edition. Бесплатной версии (та самая Community) более чем достаточно. После установки и первичной настройки выберите пункт File -> New Project. Укажите имя вашего первого проекта, а ниже укажите «New environment using virtualenv», ниже в качестве интерпретатора путь к python.exe каталога с Питоном (например, C:\Python38\python.exe).

Создание нового проекта в PyCharm

После запуска откройте вкладку Terminal в левом нижнем углу и установите библиотеку pytelegrambotapi (не telebot!). Для любителей тыкать мышкой есть более запутанный вариант: File -> Settings -> Project -> Project Interpreter -> кнопка «+» в правой части экрана.

Установка библиотеки через терминал в PyCharm

Прекрасно, теперь начинайте творить! Создайте первый файл с исходником, нажав правой кнопкой мышки по имени проекта в списке файлов, затем New и Python File.

Создание нового файла кода в PyCharm

Запустить код можно, выбрав сверху пункт Run, затем снова Run…, но с многоточием, и затем выбрав созданный ранее файл.

Как залить файлы на сервер?

Для копирования файлов на удалённый сервер (обычно там стоит Linux), я использую замечательную бесплатную программу WinSCP, причём в ней присутствует режим автоматической синхронизации файлов, чтобы при любом изменении в локальном каталоге обновлялось содержимое на удалённой машине, избавляя вас от необходимости копировать всё вручную.

Скриншот программы WinSCP

При помощи WinSCP можно даже просто подключиться к серверу и подправить файл «на лету», не забудьте только потом перезапустить бота!

Linux

Если Linux у вас используется вместо Windows, то работа с PyCharm будет точно такой же, поэтому второй раз писать не имеет смысла. Далее рассмотрен процесс запуска в терминале на удалённом сервере. Прекрасно, вы написали бота и хотите где-то его запустить. Например, арендовали сервер у Scaleway/DigitalOcean/AWS/etc. Запустили сервер, подключились к нему по SSH, а там чёрный экран и терминальная Linux-сессия. Во-первых, давайте посмотрим, какой интерпретатор у нас выбран по умолчанию, введя команду python3 .

Хорошим правилом будет иметь на сервере ровно ту же версию Python, что и на своей локальной машине, во избежание различных неприятностей. Если версия на сервере ниже 3.7 и/или ниже той, что установлена локально, лучше всего будет установить её отдельно. Очень рекомендую вот эту статью, по которой я для себя написал простой скрипт для автоматизации рутинных действий. Итак, интерпретатор установлен, теперь пора создать каталог, куда положим файлы бота. Выполните по очереди следующие команды:

mkdir mybot cd mybot python3.7 -m venv venv source venv/bin/activate pip install pytelegrambotapi deactivate 

В результате должно получиться примерно то же самое, что на скриншоте ниже, с той лишь разницей, что я прервал процесс установки библиотеки для читабельности. Обратите внимание, что после подгрузки файла venv/bin/activate, перед названием пользователя и текущего каталога появится приписка (venv), означающая, что мы «вошли» в виртуальное окружение и устанавливаем библиотеки именно в него.

Создание venv в Linux-терминале

Что произошло выше? Во-первых, мы создали каталог с названием mybot и перешли в него. Во-вторых, мы использовали Python версии 3.7 (в вашем случае это может быть не так), чтобы создать виртуальное окружение в подкаталоге venv. В-третьих, мы «активировали» venv и выполнили в нём нужную нам команду. Внутри venv команды pip и python точно знают, к какому именно интерпретатору они относятся, поэтому путаницы вроде «я установил библиотеку для Python 3.5, а запускаю из-под Python 3.7» попросту не будет. Наконец, в-четвёртых, мы деактивировали venv, поскольку он напрямую нам больше не нужен. Чтобы сделать жизнь ещё приятнее, давайте настроим автозагрузку бота, чтобы при возникновении ошибок или при перезапуске сервера он вновь запускался, избавляя нас от необходимости постоянно проверять всё вручную. Для этого мы воспользуемся подсистемой инициализации systemd, которая всё больше распространена в современных Linux-дистрибутивах. Прежде, чем описать службу systemd, откройте главный файл с ботом, в котором прописан его запуск и добавьте в качестве первой строки следующий код: #!venv/bin/python

Сохраните файл, закройте его и выполните команду chmod +x имяфайласботом.py , чтобы сделать его исполняемым. Теперь создайте файл mybot.service, и скопируйте туда следующий текст:

[Unit] Description=MY BOT After=network.target [Service] Type=simple WorkingDirectory=/home/user/mybot ExecStart=/home/user/mybot/bot.py KillMode=process Restart=always RestartSec=10 [Install] WantedBy=multi-user.target 

Отредактируйте поля Description , WorkingDirectory и ExecStart , сохраните и закройте файл. Далее скопируйте его в каталог /etc/systemd/system , введя свой пароль при необходимости (если сидите не из-под рута, что правильно, то ваш юзер должен иметь возможность выполнять команды от имени sudo). Затем выполните следующие команды для включения автозагрузки и запуска бота (опять-таки, требуются права суперпользователя):

systemctl enable mybot.service systemctl restart mybot 

Наконец, проверьте состояние вашего бота командой systemctl status mybot . Его статус должен быть Active (running) зелёного цвета (если поддерживается разноцветный режим).

Проверка статуса бота через systemd

Как редактировать файлы на сервере?

Если что-то нужно подправить небольшое, то неплохим вариантом остаётся старое доброе подключение по SSH и использование редакторов вроде micro, nano или даже vim с emacs. Но если вдруг у вас в качестве локальной машины применяется Linux, то крайне рекомендую редактор Visual Studio Code (https://code.visualstudio.com) с дополнением Remote-SSH. В этом случае, вы сможете прямо в VS Code открывать каталоги на сервере и редактировать файлы в удобном окружении и с подсветкой синтаксиса. К сожалению, насколько мне известно, расширение Remote-SSH не работает в Windows, но впоследствии этот недочёт будет устранён.

Ответы на часто задаваемые вопросы (FAQ)

Хочу научиться писать ботов. С чего мне начать?
Прежде всего, пожалуйста, изучите хотя бы немного сам язык Python. Он довольно простой, но перед созданием ботов стоит понять азы. Конкретнее: переменные, циклы, функции, классы, обработка исключений, работа с файлами и файловой системой.

Можно ли писать ботов на телефоне?
Да кто ж вам запретит-то? Но лучше от этого никому не будет, поверьте. Будет трудно, неудобно и контрпродуктивно. Используйте нормальный компьютер.

[pyTelegramBotAPI] Ошибка AttributeError: module ‘telebot’ has no attribute ‘TeleBot’!
На 99% уверен, что вы установили библиотеку telebot вместо pytelegrambotapi. С учётом всего вышесказанного проще создать новое окружение venv, перенести туда нужные файлы и установить именно pytelegrambotapi, при этом в исходниках должно остаться import telebot.

Как мне держать бота запущеным в Windows?
Запустите бота в PyCharm, не закрывайте приложение и не выключайте комп. Почти шутка. По-моему, Windows — не самая лучшая операционка для подобных вещей, проще арендовать сервер у европейских провайдеров, заодно не будет геморроя с варварами из Российского Консорциума Неадекватов.

Библиотека pyTelegramBotAPI не поддерживает новые фичи Bot API!
К сожалению, упомянутая библиотека в 2019 году развивалась гораздо медленнее, чем хотелось. Если вы уже чувствуете себя уверенным ботописателем, подумайте о переходе на альтернативы вроде aiogram.

В завершение хочется напомнить, что если у вас возникли замечания, предложения или вопросы, вы всегда можете открыть issue на Github или прийти к нам в чатик.

Как установить pytelegrambotapi

Скачай курс
в приложении

Перейти в приложение
Открыть мобильную версию сайта

© 2013 — 2023. Stepik

Наши условия использования и конфиденциальности

Public user contributions licensed under cc-wiki license with attribution required

pyTelegramBotAPI 4.14.0

A simple, but extensible Python implementation for the Telegram Bot API.

Both synchronous and asynchronous.

Supported Bot API version: 6.9!

Official documentation

Official ru documentation

Contents

• Getting started
• Writing your first bot
  • Prerequisites
  • A simple echo bot
  • Types
  • Methods
  • General use of the API
    • Message handlers
    • Edited Message handler
    • Channel Post handler
    • Edited Channel Post handler
    • Callback Query handlers
    • Shipping Query Handler
    • Pre Checkout Query Handler
    • Poll Handler
    • Poll Answer Handler
    • My Chat Member Handler
    • Chat Member Handler
    • Chat Join request handler
    • Inline handler
    • Chosen Inline handler
    • Answer Inline Query
    • Middleware handlers
    • Custom filters
    • TeleBot
    • Reply markup
    • Using local Bot API Server
    • Asynchronous TeleBot
    • Sending large text messages
    • Controlling the amount of Threads used by TeleBot
    • The listener mechanism
    • Using web hooks
    • Logging
    • Proxy
    • Testing
    • How can I distinguish a User and a GroupChat in message.chat?
    • How can I handle reocurring ConnectionResetErrors?

    Getting started

    This API is tested with Python 3.8-3.11 and Pypy 3. There are two ways to install the library:

    • Installation using pip (a Python package manager):

    $ pip install pyTelegramBotAPI 

    • Installation from source (requires git):

    $ git clone https://github.com/eternnoir/pyTelegramBotAPI.git $ cd pyTelegramBotAPI $ python setup.py install 

    $ pip install git+https://github.com/eternnoir/pyTelegramBotAPI.git 

    It is generally recommended to use the first option.

    While the API is production-ready, it is still under development and it has regular updates, do not forget to update it regularly by calling

    pip install pytelegrambotapi --upgrade 

    Writing your first bot

    Prerequisites

    It is presumed that you have obtained an API token with @BotFather. We will call this token TOKEN . Furthermore, you have basic knowledge of the Python programming language and more importantly the Telegram Bot API.

    A simple echo bot

    The TeleBot class (defined in _init_.py) encapsulates all API calls in a single class. It provides functions such as send_xyz ( send_message , send_document etc.) and several ways to listen for incoming messages.

    Create a file called echo_bot.py . Then, open the file and create an instance of the TeleBot class.

    Note: Make sure to actually replace TOKEN with your own API token.

    After that declaration, we need to register some so-called message handlers. Message handlers define filters which a message must pass. If a message passes the filter, the decorated function is called and the incoming message is passed as an argument.

    Let’s define a message handler which handles incoming /start and /help commands.

    A function which is decorated by a message handler can have an arbitrary name, however, it must have only one parameter (the message).

    Let’s add another handler:

    This one echoes all incoming text messages back to the sender. It uses a lambda function to test a message. If the lambda returns True, the message is handled by the decorated function. Since we want all messages to be handled by this function, we simply always return True.

    Note: all handlers are tested in the order in which they were declared

    We now have a basic bot which replies a static message to «/start» and «/help» commands and which echoes the rest of the sent messages. To start the bot, add the following to our source file:

    Alright, that's it! Our source file now looks like this:

    To start the bot, simply open up a terminal and enter python echo_bot.py to run the bot! Test it by sending commands ('/start' and '/help') and arbitrary text messages.

    General API Documentation

    Types

    All types are defined in types.py. They are all completely in line with the Telegram API’s definition of the types, except for the Message’s from field, which is renamed to from_user (because from is a Python reserved token). Thus, attributes such as message_id can be accessed directly with message.message_id . Note that message.chat can be either an instance of User or GroupChat (see How can I distinguish a User and a GroupChat in message.chat?).

    The Message object also has a content_type attribute, which defines the type of the Message. content_type can be one of the following strings: text , audio , document , photo , sticker , video , video_note , voice , location , contact , new_chat_members , left_chat_member , new_chat_title , new_chat_photo , delete_chat_photo , group_chat_created , supergroup_chat_created , channel_chat_created , migrate_to_chat_id , migrate_from_chat_id , pinned_message , web_app_data .

    You can use some types in one function. Example:

    content_types=[«text», «sticker», «pinned_message», «photo», «audio»]

    Methods

    All API methods are located in the TeleBot class. They are renamed to follow common Python naming conventions. E.g. getMe is renamed to get_me and sendMessage to send_message .

    General use of the API

    Outlined below are some general use cases of the API.

    Message handlers

    A message handler is a function that is decorated with the message_handler decorator of a TeleBot instance. Message handlers consist of one or multiple filters. Each filter must return True for a certain message in order for a message handler to become eligible to handle that message. A message handler is declared in the following way (provided bot is an instance of TeleBot):

     function_name is not bound to any restrictions. Any function name is permitted with message handlers. The function must accept at most one argument, which will be the message that the function must handle. filters is a list of keyword arguments. A filter is declared in the following manner: name=argument . One handler may have multiple filters. TeleBot supports the following filters:

    name	argument(s)	Condition
    content_types	list of strings (default [‘text’] )	True if message.content_type is in the list of strings.
    regexp	a regular expression as a string	True if re.search(regexp_arg) returns True and message.content_type == ‘text’ (See Python Regular Expressions)
    commands	list of strings	True if message.content_type == ‘text’ and message.text starts with a command that is in the list of strings.
    chat_types	list of chat types	True if message.chat.type in your filter
    func	a function (lambda or function reference)	True if the lambda or function reference returns True

    Here are some examples of using the filters and message handlers:

           Important: all handlers are tested in the order in which they were declared

    Edited Message handler

    Handle edited messages @bot.edited_message_handler(filters) #

    Channel Post handler

    Handle channel post messages @bot.channel_post_handler(filters) #

    Edited Channel Post handler

    Handle edited channel post messages @bot.edited_channel_post_handler(filters) #

    Callback Query Handler

    Handle callback queries

    Pre Checkout Query Handler

    Handle pre checkoupt queries @bot.pre_checkout_query_handler() #

    Poll Handler

    Poll Answer Handler

    My Chat Member Handler

    Handle updates of a the bot’s member status in a chat @bot.my_chat_member_handler() #

    Chat Member Handler

    Handle updates of a chat member’s status in a chat @bot.chat_member_handler() # Note: «chat_member» updates are not requested by default. If you want to allow all update types, set allowed_updates in bot.polling() / bot.infinity_polling() to util.update_types

    Chat Join Request Handler

    Handle chat join requests using: @bot.chat_join_request_handler() #

    Inline Mode

    More information about Inline mode.

    Inline handler

    Now, you can use inline_handler to get inline queries in telebot.

    Chosen Inline handler

    Use chosen_inline_handler to get chosen_inline_result in telebot. Don’t forgot add the /setinlinefeedback command for @Botfather.

    Answer Inline Query

    Middleware Handlers

    A middleware handler is a function that allows you to modify requests or the bot context as they pass through the Telegram to the bot. You can imagine middleware as a chain of logic connection handled before any other handlers are executed. Middleware processing is disabled by default, enable it by setting apihelper.ENABLE_MIDDLEWARE = True .

      There are other examples using middleware handler in the examples/middleware directory.

    Class-based middlewares

    There are class-based middlewares. Basic class-based middleware looks like this:

       this will skip handler this will cancel update Class-based middleware should have to functions: post and pre process. So, as you can see, class-based middlewares work before and after handler execution. For more, check out in examples

    Custom filters

    Also, you can use built-in custom filters. Or, you can create your own filter.

    Also, we have examples on them. Check this links:

    You can check some built-in filters in source code

    If you want to add some built-in filter, you are welcome to add it in custom_filters.py file.

    Here is example of creating filter-class:

    All send_xyz functions of TeleBot take an optional reply_markup argument. This argument must be an instance of ReplyKeyboardMarkup , ReplyKeyboardRemove or ForceReply , which are defined in types.py.

             The last example yields this result:

        ForceReply:

    Working with entities

    This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc. Attributes:

    Here’s an Example: message.entities[num].
    Here num is the entity number or order of entity in a reply, for if incase there are multiple entities in the reply/message.
    message.entities returns a list of entities object.
    message.entities[0].type would give the type of the first entity
    Refer Bot Api for extra details

    Advanced use of the API

    Using local Bot API Sever

    Since version 5.0 of the Bot API, you have the possibility to run your own Local Bot API Server. pyTelegramBotAPI also supports this feature.

    Important: Like described here, you have to log out your bot from the Telegram server before switching to your local API server. in pyTelegramBotAPI use bot.log_out() 

    Note: 4200 is an example port

    Asynchronous TeleBot

    New: There is an asynchronous implementation of telebot. To enable this behaviour, create an instance of AsyncTeleBot instead of TeleBot.

    Now, every function that calls the Telegram API is executed in a separate asynchronous task. Using AsyncTeleBot allows you to do the following:

    See more in examples

    Sending large text messages

    Sometimes you must send messages that exceed 5000 characters. The Telegram API can not handle that many characters in one request, so we need to split the message in multiples. Here is how to do that using the API:

      Or you can use the new smart_split function to get more meaningful substrings:

    The TeleBot constructor takes the following optional arguments:

    • threaded: True/False (default True). A flag to indicate whether TeleBot should execute message handlers on it’s polling Thread.

    The listener mechanism

    As an alternative to the message handlers, one can also register a function as a listener to TeleBot.

    NOTICE: handlers won’t disappear! Your message will be processed both by handlers and listeners. Also, it’s impossible to predict which will work at first because of threading. If you use threaded=False, custom listeners will work earlier, after them handlers will be called. Example:

    When using webhooks telegram sends one Update per call, for processing it you should call process_new_messages([update.message]) when you recieve it.

    There are some examples using webhooks in the examples/webhook_examples directory.

    Logging

    You can use the Telebot module logger to log debug info about Telebot. Use telebot.logger to get the logger of the TeleBot module. It is possible to add custom logging Handlers to the logger. Refer to the Python logging module page for more info.

    Proxy

    You can use proxy for request. apihelper.proxy object will use by call requests proxies argument.

    If you want to use socket5 proxy you need install dependency pip install requests[socks] and make sure, that you have the latest version of gunicorn , PySocks , pyTelegramBotAPI , requests and urllib3 .

    For async:

    You can disable or change the interaction with real Telegram server by using

    parameter. You can pass there your own function that will be called instead of requests.request.

       >>'Then you can use API and proceed requests in your handler code.

    Result will be:

    custom_sender. method: post, url: https://api.telegram.org/botololo/sendMessage, params:

    API conformance limitations

    • ➕ Bot API 4.5 — No nested MessageEntities and Markdown2 support
    • ➕ Bot API 4.1 — No Passport support
    • ➕ Bot API 4.0 — No Passport support

    AsyncTeleBot

    Asynchronous version of telebot

    We have a fully asynchronous version of TeleBot. This class is not controlled by threads. Asyncio tasks are created to execute all the stuff.

    EchoBot

    Echo Bot example on AsyncTeleBot:

         As you can see here, keywords are await and async.

    Why should I use async?

    Asynchronous tasks depend on processor performance. Many asynchronous tasks can run parallelly, while thread tasks will block each other.

    Differences in AsyncTeleBot

    AsyncTeleBot is asynchronous. It uses aiohttp instead of requests module.

    Examples

    See more examples in our examples folder

    F.A.Q.

    How can I distinguish a User and a GroupChat in message.chat?

    Telegram Bot API support new type Chat for message.chat.

    • Check the type attribute in Chat object:

    How can I handle reocurring ConnectionResetErrors?

    Bot instances that were idle for a long time might be rejected by the server when sending a message due to a timeout of the last used session. Add apihelper.SESSION_TIME_TO_LIVE = 5 * 60 to your initialisation to force recreation after 5 minutes without any activity.

    The Telegram Chat Group

    Get help. Discuss. Chat.

    • Join the pyTelegramBotAPI Telegram Chat Group

    Telegram Channel

    Join the News channel. Here we will post releases and updates.

    More examples

    • Echo Bot
    • Deep Linking
    • next_step_handler Example

    Code Template

    Template is a ready folder that contains architecture of basic project. Here are some examples of template:

    • AsyncTeleBot template
    • TeleBot template

    Bots using this library

    • SiteAlert bot (source) by ilteoood — Monitors websites and sends a notification on changes
    • TelegramLoggingBot by aRandomStranger
    • Telegram LMGTFY_bot by GabrielRF — Let me Google that for you.
    • Telegram Proxy Bot by mrgigabyte
    • RadRetroRobot by Tronikart — Multifunctional Telegram Bot RadRetroRobot.
    • League of Legends bot (source) by i32ropie
    • NeoBot by @NeoRanger
    • ColorCodeBot (source) — Share code snippets as beautifully syntax-highlighted HTML and/or images.
    • ComedoresUGRbot (source) by alejandrocq — Telegram bot to check the menu of Universidad de Granada dining hall.
    • proxybot — Simple Proxy Bot for Telegram. by p-hash
    • DonantesMalagaBot — DonantesMalagaBot facilitates information to Malaga blood donors about the places where they can donate today or in the incoming days. It also records the date of the last donation so that it helps the donors to know when they can donate again. — by vfranch
    • DuttyBot by Dmytryi Striletskyi — Timetable for one university in Kiev.
    • wat-bridge by rmed — Send and receive messages to/from WhatsApp through Telegram
    • filmratingbot(source) by jcolladosp — Telegram bot using the Python API that gets films rating from IMDb and metacritic
    • Send2Kindlebot (source) by GabrielRF — Send to Kindle service.
    • RastreioBot (source) by GabrielRF — Bot used to track packages on the Brazilian Mail Service.
    • Spbu4UBot(link) by EeOneDown — Bot with timetables for SPbU students.
    • SmartySBot(link) by 0xVK — Telegram timetable bot, for Zhytomyr Ivan Franko State University students.
    • LearnIt(link) — A Telegram Bot created to help people to memorize other languages’ vocabulary.
    • Bot-Telegram-Shodan by rubenleon
    • VigoBusTelegramBot (GitHub) — Bot that provides buses coming to a certain stop and their remaining time for the city of Vigo (Galicia — Spain)
    • kaishnik-bot (source) by airatk — bot which shows all the necessary information to KNTRU-KAI students.
    • Robbie (source) by @FacuM — Support Telegram bot for developers and maintainers.
    • AsadovBot (source) by @DesExcile — Сatalog of poems by Eduard Asadov.
    • thesaurus_com_bot (source) by @LeoSvalov — words and synonyms from dictionary.com and thesaurus.com in the telegram.
    • InfoBot (source) by @irevenko — An all-round bot that displays some statistics (weather, time, crypto etc. )
    • FoodBot (source) by @Fliego — a simple bot for food ordering
    • Sporty (source) by @0xnu — Telegram bot for displaying the latest news, sports schedules and injury updates.
    • JoinGroup Silencer Bot (source) by @zeph1997 — A Telegram Bot to remove «join group» and «removed from group» notifications.
    • TasksListsBot (source) by @Pablo-Davila — A (tasks) lists manager bot for Telegram.
    • MyElizaPsychologistBot (source) by @Pablo-Davila — An implementation of the famous Eliza psychologist chatbot.
    • Frcstbot (source) by Mrsqd. A Telegram bot that will always be happy to show you the weather forecast.
    • MineGramBot by ModischFabrications. This bot can start, stop and monitor a minecraft server.
    • Tabletop DiceBot by dexpiper. This bot can roll multiple dices for RPG-like games, add positive and negative modifiers and show short descriptions to the rolls.
    • BarnameKon by Anvaari. This Bot make «Add to google calendar» link for your events. It give information about event and return link. It work for Jalali calendar and in Tehran Time. Source code
    • Translator bot by Areeg Fahad. This bot can be used to translate texts.
    • Digital Cryptocurrency bot by Areeg Fahad. With this bot, you can now monitor the prices of more than 12 digital Cryptocurrency.
    • Anti-Tracking Bot by Leon Heess (source). Send any link, and the bot tries its best to remove all tracking from the link you sent.
    • Developer Bot by Vishal Singh(source code) This telegram bot can do tasks like GitHub search & clone,provide c++ learning resources ,Stackoverflow search, Codeforces(profile visualizer,random problems)
    • oneIPO bot by Aadithya & Amol Soans This Telegram bot provides live updates , data and documents on current and upcoming IPOs(Initial Public Offerings)
    • CoronaGraphsBot (source) by TrevorWinstral — Gets live COVID Country data, plots it, and briefs the user
    • ETHLectureBot (source) by TrevorWinstral — Notifies ETH students when their lectures have been uploaded
    • Vlun Finder Bot by Resinprotein2333. This bot can help you to find The information of CVE vulnerabilities.
    • ETHGasFeeTrackerBot (Source by DevAdvik — Get Live Ethereum Gas Fees in GWEI
    • Google Sheet Bot by JoachimStanislaus. This bot can help you to track your expenses by uploading your bot entries to your google sheet.
    • GrandQuiz Bot by Carlosma7. This bot is a trivia game that allows you to play with people from different ages. This project addresses the use of a system through chatbots to carry out a social and intergenerational game as an alternative to traditional game development.
    • Diccionario de la RAE (source) This bot lets you find difinitions of words in Spanish using RAE’s dictionary. It features direct message and inline search.
    • remoteTelegramShell by EnriqueMoran. Control your LinuxOS computer through Telegram.
    • Commerce Telegram Bot. Make purchases of items in a store with an Admin panel for data control and notifications.
    • Pyfram-telegram-bot Query wolframalpha.com and make use of its API through Telegram.
    • TranslateThisVideoBot This Bot can understand spoken text in videos and translate it to English
    • Zyprexa (source) Zyprexa can solve, help you solve any mathematical problem you encounter and convert your regular mathematical expressions into beautiful imagery using LaTeX.
    • Bincode-telegram-bot by tusharhero — Makes bincodes from text provides and also converts them back to text.
    • hydrolib_bot Toolset for Hydrophilia tabletop game (game cards, rules, structure. ).
    • Gugumoe-bot (source) by 咕谷酱 GuXiaoJiang is a multi-functional robot, such as OSU game information query, IP test, animation screenshot search and other functions.
    • Feedback-bot A feedback bot for user-admin communication. Made on AsyncTeleBot, using template.
    • TeleServ by ablakely This is a Telegram to IRC bridge which links as an IRC server and makes Telegram users appear as native IRC users.
    • Simple Store Bot by Anton Glyzin This is a simple telegram-store with an admin panel. Designed according to a template.
    • Media Rating Bot (source)by CommanderCRM. This bot aggregates media (movies, TV series, etc.) ratings from IMDb, Rotten Tomatoes, Metacritic, TheMovieDB, FilmAffinity and also provides number of votes of said media on IMDb.
    • Spot Seek Bot (source) by Arashnm80. This is a free & open source telegram bot for downloading tracks, albums or playlists from spotify.
    • CalendarIT Bot (source)by CodeByZen. A simple, but extensible Python Telegram bot, can post acquainted with what is happening today, tomorrow or what happened 20 years ago to channel.
    • DownloadMusicBOT by Francisco Griman — It is a simple bot that downloads audio from YouTube videos on Telegram.
    • AwesomeChatGPTBot — Simple ChatGTP-3.5 bot. It is FREE and can remember chat history for a while With pre-defined roles!

    Want to have your bot listed here? Just make a pull request. Only bots with public source code are accepted.

    Создаём Telegram-бота на Python с помощью pyTelegramBotAPI (telebot)

    

    Сегодня будем учиться создавать ботов в Telegram с помощью Python.
    Попробуем заставить бота присылать сводку погоды по нашему городу.

    Нам потребуется:

    1. Компьютер или ноутбук (При должном усердии можно попробовать на телефоне).
    2. Python 3 (Мы будем работать на версии 3.10).
    3. Редактор кода (Я использую PyCharm).
    4. Соединение с интернетом.

    У всех на слуху две библиотеки для разработки telegram-ботов, это:
    — telebot (он же pyTelegramBotAPI),
    — aiogram.

    Мы будем использовать telebot как более простой инструмент для личного пользования. Посмотрим как запустить первого бота, что для этого нужно и на что он способен.

    Как и aiogram, telebot является адаптацией API telegram для взаимодействия с ответами от сайта. Со справкой API telegram можно ознакомиться тут https://core.telegram.org/. Там же вы сможете узнать подробнее об ответах API.

    Получение токена для Telegram-бота

    Чтобы создать нашего первого бота на Python надо обратиться к официальному боту от Telegram — BotFather. Там можно создать бота и получить его токен. Токен – это аналог пароля, который позволит нам управлять ботом изнутри и программировать его ответы.

    Переходим в BotFather — https://t.me/BotFather и нажимаем «Запустить»:

    

    Дальше выбираем команду /newbot и следуем всем указанием, и в конце мы получаем токен нашего бота:

    

    Установка библиотеки telebot и знакомство с pyTelegramBotAPI

    После получения токена нужно скачать библиотеку telebot:

    pip install pyTelegramBotAPI 

    если вы на macOS, то:

    pip3 install pyTelegramBotAPI

    Мы не будем раскладывать проект по модулям, поэтому у нас будет один исполнимый файл main.py. После создания файла надо импортировать библиотеку и наш токен:

    import telebot api_token = 'Ваш токен вставлять сюда'

    Первым делом следует инициализировать бота, передав в него токен, полученный от BotFather:

    bot = telebot.TeleBot(api_token)

    Дальше убедимся, что все корректно работает и заставим отправлять полученное сообщение обратно:

    @bot.message_handler(content_types=['text']) def echo(message): bot.send_message(message.chat.id, text=f"")

    Бот работает за cчёт декораторов, которые указывают, что мы хотим от него. Message handler – это обработчик всех сообщений, которые отправляет пользователь. В списке content_types перечисляем типы сообщений, которые хотим принимать. Можно указать text, audio, image и document.

    У объекта bot есть множество методов, частью которых мы будем пользоваться. Основной из них — send message.

    Чтобы заставить бота принимать сообщение, в конце файла пропишем:

    bot.polling(none_stop=True)

    Параметр none_stop указывает, что мы хотим принимать сообщения постоянно.
    В стандартном положении параметр равен False, но мы ставим True.

    После всех манипуляций получаем свое же сообщение:

    

    Работа с API Яндекс Погоды

    Перейдем к добавлению нужных функций — получению данных о погоде.

    Для погоды мы будем пользоваться услугами бесплатного API от Яндекс Погоды:
    https://yandex.ru/dev/weather/. Следует отметить, что бесплатный API от Яндекса ограничен 50 запросам в сутки. Если вас такое количество не устраивает, можно воспользоваться OpenWeather.

    Запрос будет выглядеть так:

    https://api.weather.yandex.ru/v2/informers?lat=55.75222&lon=37.61556

    Запрос состоит из местоположения — в данном случае указаны координаты Москвы. Далее можно просить у пользователя геолокацию и присылать ему погоду по его координатам.

    Для отправки GET-запроса к API Яндекс.Погоды нам поможет библиотека requests, а для обработки ответа — библиотека json.

    pip install requests

    pip3 install requests 

    Библиотека requests предназначена для работы с GET и POST запросами, которые обычный пользователь делает через браузер. Теперь же мы можем общаться с сервером через python оставляя браузер за скобками. Часто используют requests вместе с BS4 (beautiful soup 4), чтобы удобно получать и анализировать информацию из html кода. Но в наш случае другая задача.

    API Яндекс.Погоды отдаёт данные в формате JSON, поэтому библиотека json подойдёт лучше всего. JSON основан на JavaScript объекте и часто используется при обмене данными. Раньше он использовался только на сайтаx для работы с текстовыми данными. Сейчас его используют почти везде для удобного обмена данными. JSON принимают все языки программирования, что является его большим плюсом. В python библиотека json уже установлена и не требует отдельной команды.

    Добавляем импорт нужных библиотек:

    import requests import json

    До этого мы не затрагивали тему, как именно обрабатывать команды через слеш. Для этого у декоратора есть метод message_handlers, внутрь которого мы передаем название команд:

    @bot.message_handler(commands=['get_weather', 'weather', 'pogoda']): def get_weather(message): pass

    Для удобства выносим токен Яндекс.Погоды и ссылку в отдельные переменные:

    url = "https://api.weather.yandex.ru/v2/informers?lat=55.75222&lon=37.61556" headers =

    Отправим себе в Telegram полный ответ от API Яндекс.Погоды и проверим что все работает:

    @bot.message_handler(commands=['get_weather', 'weather', 'pogoda']) def get_weather(message): r = requests.get(url=url, headers=headers) bot.send_message(message.chat.id, r.text)

    

    После получения ответа сформируем нормальный ответ для пользователя. Сразу сделаем проверку на status_code, чтобы оповестить пользователя, если проблемы на стороне API. После получения ответа от API в текстовом формате, надо перевести его в словарь. Для этого подключаем библиотеку json — в функцию loads мы передаем текст ответа, а на выходе получаем объект типа dict (словарь):

    @bot.message_handler(commands=['get_weather', 'weather', 'pogoda']) def get_weather(message): r = requests.get(url=url, headers=headers) bot.send_message(message.chat.id, r.text) if r.status_code == 200: data = json.loads(r.text) fact = data["fact"] bot.send_message(message.chat.id, text=f'Now in Moscow °, feels like °. Now on the street ') else: bot.send_message(message.chat.id, 'Problems on weather API')

    Теперь бот отправляет температуру, как она ощущается и какая сейчас погода:

    

    Настройка команд для telegram-бота

    Нам осталось сделать реакцию на команду /start. Она будет выводить команду для получения данных о погоде:

    @bot.message_handler(commands=['start']) def get_weather(message): bot.send_message(message.chat.id, text=f'Hello, ! \n\nI can show you the weather with: \n/weather\n/pogoda\n/get_weather')

    Мы обращаемся к информации, которая приходит нам в сообщении пользователя, чтобы получить из нее имя пользователя. Подробнее узнать о сообщениях пользователей можно тут https://core.telegram.org/constructor/message.

    Теперь создадим подсказки для пользователей. Библиотека pyTElegramBotAPI не позволяет из кода редактировать подсказки для написания команды. Чтобы это сделать нам потребуется несколько операций в BotFather:

    

    1. кликаем на меню
    2. выбираем команду /mybots
    3. ищем нашего бота
    4. edit bot
    5. и выбираем edit commands
    6. дальше вводим нашу команду (Пример: команда – описание)

    После всех манипуляций у нас появится всплывающая менюшка с командами:

    

    Финальный код Telegram-бота на Python

    Мы с вами затронули лишь малу часть того, что можно сделать с помощью python и Telegram. Telebot — не самая лучшая библиотека для создания ботов под большую аудитории. Если вы хотите писать бот для магазинов, вам потребуется более сильные инструменты разработки, которые есть в aiogram.

    Если вам хочется потренироваться самостоятельно — попробуйте написать бота со следующими функциями: конвертор валюты, сводка по курсу валюты.

    Весь код из урока:

    import telebot import requests import json api_token = '5347819163:********lZu1qWQc5f55DPk' url = "https://api.weather.yandex.ru/v2/informers?lat=55.75222&lon=37.61556" headers = bot = telebot.TeleBot(api_token) @bot.message_handler(commands=['start']) def get_weather(message): bot.send_message(message.chat.id, text=f'Hello, ! \n\nI can show you the weather with: \n/weather\n/pogoda\n/get_weather') @bot.message_handler(commands=['get_weather', 'weather', 'pogoda']) def get_weather(message): r = requests.get(url=url, headers=headers) bot.send_message(message.chat.id, r.text) if r.status_code == 200: data = json.loads(r.text) fact = data["fact"] bot.send_message(message.chat.id, text=f'Now in Moscow °, feels like °. Now on the street ') else: bot.send_message(message.chat.id, 'Problems on weather API') bot.polling(none_stop=True)

    Похожие публикации:

    1. Как подключить jar к проекту intellij idea
    2. Как узнать длину двумерного массива java
    3. Когда нужно использовать
    4. Кто берет на работу