We have made you a wrapper you can't refuse
Stay tuned for library updates and new releases on our Telegram Channel.
Table of contents
Introduction
This library provides a pure Python interface for the Telegram Bot API. It's compatible with Python versions 2.7, 3.3+ and PyPy. It also works with Google App Engine.
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.
Telegram API support
As of 3. Oct 2016, all types and methods of the Telegram Bot API are supported.
Installing
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
$ cd python-telegram-bot
$ python setup.py installGetting started
Our Wiki contains a lot of resources to get you started with python-telegram-bot:
- Introduction to the API
- Tutorial: Your first Bot
Other references:
Learning by example
We believe that the best way to learn and understand this simple package is by example. So here
are some examples for you to review. Even if it's not your approach for learning, please take a
look at echobot2, it is de facto the 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.
Logging
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)Documentation
python-telegram-bot's documentation lives at readthedocs.io.
Getting help
You can get help in several ways:
- We have a vibrant community of developers helping each other in our Telegram group. Join us!
- Our Wiki pages offer a growing amount of resources.
- You can ask for help on Stack Overflow using the python-telegram-bot tag.
- As last resort, the developers are ready to help you with serious issues.
Contributing
Contributions of all sizes are welcome. Please review our contribution guidelines to get started. You can also help by reporting bugs.
License
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.