Repository files navigation

We have made you a wrapper you can't refuse

We 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.

This library provides a pure Python, asynchronous interface for theTelegram Bot API.It's compatible with Python versions3.9+.

In addition to the pure API implementation, this library features several convenience methods and shortcuts as well as a number of high-level classes tomake the development of bots easy and straightforward. These classes are contained in thetelegram.ext submodule.

Afterinstalling the library, be sure to check out the section onworking with PTB.

All types and methods of the Telegram Bot API9.0 are natively supported by this library.In addition, Bot API functionality not yet natively included can still be used as describedin our wiki.

• Fully asynchronous
• Convenient shortcut methods, e.g.Message.reply_text
• Fully annotated with static type hints
• Customizable and extendable interface
• Seamless integration withwebhooks andpolling
• Comprehensive documentation and examples

You can install or upgradepython-telegram-bot via

$ pip install python-telegram-bot --upgrade

To install a pre-release, use the--preflag in addition.

You can also installpython-telegram-bot from source, though this is usually not necessary.

$ git clone https://github.com/python-telegram-bot/python-telegram-bot$cd python-telegram-bot$ pip install build$ python -m build

To enable you to verify that a release file that you downloaded was indeed provided by thepython-telegram-bot team, we have taken the following measures.

Starting with v21.4, all releases are signed viasigstore.The corresponding signature files are uploaded to theGitHub releases page.To verify the signature, please install thesigstore Python client and follow the instructions forverifying signatures from GitHub Actions. As input for the--repository parameter, please use the valuepython-telegram-bot/python-telegram-bot.

Earlier releases are signed with a GPG key.The signatures are uploaded to both theGitHub releases page and thePyPI project and end with a suffix.asc.Please find the public keyshere.The keys are named in the format<first_version>-<last_version>.gpg.

In addition, the GitHub release page also contains the sha1 hashes of the release files in the files with the suffix.sha1.

python-telegram-bot tries 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.27 fortelegram.request.HTTPXRequest, the default networking backend.

python-telegram-bot is 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.

PTB can be installed with optional dependencies:

• pip install "python-telegram-bot[passport]" installs thecryptography>=39.0.1 library. 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,<1.3. Use this, if you want to usetelegram.ext.AIORateLimiter.
• pip install "python-telegram-bot[webhooks]" installs thetornado~=6.4 library. 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.3,<5.6.0 library. Use this, if you want to usearbitrary callback_data.
• pip install "python-telegram-bot[job-queue]" installs theAPScheduler>=3.10.4,<3.12.0 library. 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].

Once you have installed the library, you can begin working with it - so let's get started!

Our Wiki contains anIntroduction to the API explaining how the pure Bot API can be accessed viapython-telegram-bot.Moreover, theTutorial: Your first Bot gives an introduction on how chatbots can be easily programmed with the help of thetelegram.ext module.

• Thepackage documentation is the technical reference forpython-telegram-bot.It contains descriptions of all available classes, modules, methods and arguments as well as thechangelog.
• Thewiki is home to number of more elaborate introductions of the different features ofpython-telegram-bot and other useful resources that go beyond the technical documentation.
• Ourexamples section contains 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 documentation is of course always worth a read.

If the resources mentioned above don't answer your questions or simply overwhelm you, there are several ways of getting help.

1. 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.
2. Ask questions by openinga discussion.
3. You can even ask for help on Stack Overflow using thepython-telegram-bot tag.

Since v20.0,python-telegram-bot is built on top of Pythonsasyncio module.Becauseasyncio is in general single-threaded,python-telegram-bot does currently not aim to be thread-safe.Noteworthy parts ofpython-telegram-bots API that are likely to cause issues (e.g. race conditions) when used in a multi-threaded setting include:

• telegram.ext.Application/Updater.update_queue
• telegram.ext.ConversationHandler.check/handle_update
• telegram.ext.CallbackDataCache
• telegram.ext.BasePersistence
• all classes in thetelegram.ext.filters module that allow to add/remove allowed users/chats at runtime

Contributions of all sizes are welcome.Please review ourcontribution guidelines to get started.You can also help byreporting bugs or feature requests.

Occasionally 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.

You may copy, distribute and modify the software provided that modifications are described and licensed for free underLGPL-3.Derivative 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.