We have made you a wrapper you can't refuse
We have a vibrant community of developers helping each other in our Telegram group. Join us!
Stay tuned for library updates and new releases on our Telegram Channel.
This library provides a pure Python interface for the Telegram Bot API. It's compatible with Python versions 3.5+. PTB might also work on PyPy, though there have been a lot of issues before. Hence, PyPy is not officially supported.
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 the telegram.ext submodule.
All types and methods of the Telegram Bot API 4.8 are supported.
You can install or upgrade python-telegram-bot with:
$ pip install python-telegram-bot --upgradeOr you can install from source with:
$ git clone https://github.com/python-telegram-bot/python-telegram-bot --recursive
$ cd python-telegram-bot
$ python setup.py installIn case you have a previously cloned local repository already, you should initialize the added urllib3 submodule before installing with:
$ git submodule update --init --recursiveOur Wiki contains a lot of resources to get you started with python-telegram-bot:
- Introduction to the API
- Tutorial: Your first Bot
Other references:
We believe that the best way to learn this package is by example. Here are some examples for you to review. Even if it is not your approach for learning, please take a look at echobot.py, it is the de facto base for most of the bots out there. Best of all, the code for these examples are released to the public domain, so you can start by grabbing the code and building on top of it.
Visit this page to discover the official examples or look at the examples on the wiki to see other bots the community has built.
This library uses the logging module. To set up logging to standard output, put:
import logging
logging.basicConfig(level=logging.DEBUG,
format='%(asctime)s - %(name)s - %(levelname)s - %(message)s')at the beginning of your script.
You can also use logs in your application by calling logging.getLogger() and setting the log level you want:
logger = logging.getLogger()
logger.setLevel(logging.INFO)If you want DEBUG logs instead:
logger.setLevel(logging.DEBUG)python-telegram-bot's documentation lives at readthedocs.io.
You can get help in several ways:
- We have a vibrant community of developers helping each other in our Telegram group. Join us!
- In case you are unable to join our group due to Telegram restrictions, you can use our IRC channel.
- Report bugs, request new features or ask questions by creating an issue.
- Our Wiki pages offer a growing amount of resources.
- You can even ask for help on Stack Overflow using the python-telegram-bot tag.
Contributions of all sizes are welcome. Please review our contribution guidelines to get started. You can also help by reporting bugs.
You may copy, distribute and modify the software provided that modifications are described and licensed for free under LGPL-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.