Skip to main content
python-telegram-bot Logo

We have made you a wrapper you can’t refuse

Stay tuned for library updates and new releases on our Telegram Channel.

PyPi Package Version Supported python versions Documentation Status LGPLv3 License Travis CI Status Code Climate Coveralls Median time to resolve an issue Telegram Group

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 18. June 2017, all types and methods of the Telegram Bot API 3.0 are supported.

Installing

You can install or upgrade python-telegram-bot with:

$ pip install python-telegram-bot --upgrade

Or 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 install

In case you have a previously cloned local repository already, you should initialize the added urllib3 submodule before installing with:

$ git submodule update --init --recursive

Getting started

Our Wiki contains a lot of resources to get you started with python-telegram-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:

  1. We have a vibrant community of developers helping each other in our Telegram group. Join us!

  2. Our Wiki pages offer a growing amount of resources.

  3. You can ask for help on Stack Overflow using the python-telegram-bot tag.

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

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

python-telegram-bot-6.1.0.tar.gz (180.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

python_telegram_bot-6.1.0-py2.py3-none-any.whl (364.3 kB view details)

Uploaded Python 2Python 3

File details

Details for the file python-telegram-bot-6.1.0.tar.gz.

File metadata

File hashes

Hashes for python-telegram-bot-6.1.0.tar.gz
Algorithm Hash digest
SHA256 90ac2ff18f6217ad06330af98ba148957c55b92ae473c65b6726e6b17d3674f6
MD5 6c99e4d81b8de82d9864b45b5a6a1c80
BLAKE2b-256 3ff74f0f1f935f356fdd3ceca0282f3d57745c4f26d2bb6152707e3505392894

See more details on using hashes here.

File details

Details for the file python_telegram_bot-6.1.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for python_telegram_bot-6.1.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 f056bee9373b2789786a20366b4c986daa0569baa75c7ca0e32729487ba939d0
MD5 aba3b187e3f470a6b56427914c642dc5
BLAKE2b-256 2bbc7977438845e0c4ecf17f9891383c2c0c2952b2c9fb24472eb4fcb5b0bae9

See more details on using hashes here.

Release history Release notifications | RSS feed

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page