Package: python-telegram-bot
We have made you a wrapper you can’t refuseWe have a vibrant community of developers helping each other in ourTelegram group. Join us!Stay tuned for library updates and new releases on ourTelegram Channel.IntroductionThis library provides a pure Python, asynchronous interface for theTelegram Bot API.
It’s compatible with Python versions3.8+.In addition to the pure API implementation, this library features a number of high-level classes to
make the development of bots easy and straightforward. These classes are contained in thetelegram.extsubmodule.A pure API implementationwithouttelegram.extis available as the standalone packagepython-telegram-bot-raw.See here for details.NoteInstalling bothpython-telegram-botandpython-telegram-bot-rawin conjunction will result in undesired side-effects, so only installoneof both.Telegram API supportAll types and methods of the Telegram Bot API7.0are supported.InstallingYou can install or upgradepython-telegram-botvia$pipinstallpython-telegram-bot--upgradeTo install a pre-release, use the--preflagin addition.You can also installpython-telegram-botfrom source, though this is usually not necessary.$gitclonehttps://github.com/python-telegram-bot/python-telegram-bot$cdpython-telegram-bot$pythonsetup.pyinstallVerifying ReleasesWe sign all the releases with a GPG key.
The signatures are uploaded to both theGitHub releases pageand thePyPI projectand end with a suffix.asc.
Please find the public keyshere.
The keys are named in the format<first_version>-<last_version>.gpgor<first_version>-current.gpgif the key is currently being used for new releases.In addition, the GitHub release page also contains the sha1 hashes of the release files in the files with the suffix.sha1.This allows you to verify that a release file that you downloaded was indeed provided by thepython-telegram-botteam.Dependencies & Their Versionspython-telegram-bottries to use as few 3rd party dependencies as possible.
However, for some features using a 3rd party library is more sane than implementing the functionality again.
As these features areoptional, the corresponding 3rd party dependencies are not installed by default.
Instead, they are listed as optional dependencies.
This allows to avoid unnecessary dependency conflicts for users who don’t need the optional features.The only required dependency ishttpx ~= 0.26.0fortelegram.request.HTTPXRequest, the default networking backend.python-telegram-botis most useful when used along with additional libraries.
To minimize dependency conflicts, we try to be liberal in terms of version requirements on the (optional) dependencies.
On the other hand, we have to ensure stability ofpython-telegram-bot, which is why we do apply version bounds.
If you encounter dependency conflicts due to these bounds, feel free to reach out.Optional DependenciesPTB can be installed with optional dependencies:pip install"python-telegram-bot[passport]"installs thecryptography>=39.0.1library. Use this, if you want to use Telegram Passport related functionality.pip install"python-telegram-bot[socks]"installshttpx[socks]. Use this, if you want to work behind a Socks5 server.pip install"python-telegram-bot[http2]"installshttpx[http2]. Use this, if you want to use HTTP/2.pip install"python-telegram-bot[rate-limiter]"installsaiolimiter~=1.1.0. Use this, if you want to usetelegram.ext.AIORateLimiter.pip install"python-telegram-bot[webhooks]"installs thetornado~=6.4library. Use this, if you want to usetelegram.ext.Updater.start_webhook/telegram.ext.Application.run_webhook.pip install"python-telegram-bot[callback-data]"installs thecachetools~=5.3.2library. Use this, if you want to usearbitrary callback_data.pip install"python-telegram-bot[job-queue]"installs theAPScheduler~=3.10.4library and enforcespytz>=2018.6, wherepytzis a dependency ofAPScheduler. Use this, if you want to use thetelegram.ext.JobQueue.To install multiple optional dependencies, separate them by commas, e.g.pip install"python-telegram-bot[socks,webhooks]".Additionally, two shortcuts are provided:pip install"python-telegram-bot[all]"installs all optional dependencies.pip install"python-telegram-bot[ext]"installs all optional dependencies that are related totelegram.ext, i.e.[rate-limiter,webhooks,callback-data,job-queue].Quick StartOur Wiki contains anIntroduction to the APIexplaining how the pure Bot API can be accessed viapython-telegram-bot.
Moreover, theTutorial: Your first Botgives an introduction on how chatbots can be easily programmed with the help of thetelegram.extmodule.ResourcesThepackage documentationis the technical reference forpython-telegram-bot.
It contains descriptions of all available classes, modules, methods and arguments as well as thechangelog.Thewikiis home to number of more elaborate introductions of the different features ofpython-telegram-botand other useful resources that go beyond the technical documentation.Ourexamples sectioncontains several examples that showcase the different features of both the Bot API andpython-telegram-bot.
Even if it is not your approach for learning, please take a look atechobot.py. It is the de facto base for most of the bots out there.
The code for these examples is released to the public domain, so you can start by grabbing the code and building on top of it.Theofficial Telegram Bot API documentationis of course always worth a read.Getting helpIf the resources mentioned above don’t answer your questions or simply overwhelm you, there are several ways of getting help.We have a vibrant community of developers helping each other in ourTelegram group. Join us! Asking a question here is often the quickest way to get a pointer in the right direction.Ask questions by openinga discussion.You can even ask for help on Stack Overflow using thepython-telegram-bot tag.ConcurrencySince v20.0,python-telegram-botis built on top of Pythonsasynciomodule.
Becauseasynciois in general single-threaded,python-telegram-botdoes currently not aim to be thread-safe.
Noteworthy parts ofpython-telegram-botsAPI that are likely to cause issues (e.g. race conditions) when used in a multi-threaded setting include:telegram.ext.Application/Updater.update_queuetelegram.ext.ConversationHandler.check/handle_updatetelegram.ext.CallbackDataCachetelegram.ext.BasePersistenceall classes in thetelegram.ext.filtersmodule that allow to add/remove allowed users/chats at runtimeContributingContributions of all sizes are welcome.
Please review ourcontribution guidelinesto get started.
You can also help byreporting bugs or feature requests.DonatingOccasionally we are asked if we accept donations to support the development.
While we appreciate the thought, maintaining PTB is our hobby, and we have almost no running costs for it. We therefore have nothing set up to accept donations.
If you still want to donate, we kindly ask you to donate to another open source project/initiative of your choice instead.LicenseYou may copy, distribute and modify the software provided that modifications are described and licensed for free underLGPL-3.
Derivatives works (including modifications or anything statically linked to the library) can only be redistributed under LGPL-3, but applications that use the library don’t have to be.