Skip to main content

We have made you a wrapper you can't refuse

Project description

python-telegram-bot Logo

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.

PyPi Package Version Supported Python versions PyPi Package Monthly Download Documentation Status LGPLv3 License Travis CI Status AppVeyor CI Status Code coverage Median time to resolve an issue Telegram Group IRC Bridge

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

All types and methods of the Telegram Bot API 3.6 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.

Project details


Release history Release notifications | RSS feed

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-10.1.0.tar.gz (193.6 kB view details)

Uploaded Source

Built Distribution

python_telegram_bot-10.1.0-py2.py3-none-any.whl (298.1 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

File hashes

Hashes for python-telegram-bot-10.1.0.tar.gz
Algorithm Hash digest
SHA256 ca2f8a44ddef7271477e16f4986647fa90ef4df5b55a7953e53b9c9d2672f639
MD5 7dcc514936ce208e8716488bf634d74f
BLAKE2b-256 f2054e2ec273779dbb6dd553e7d638e59211126dd914f7a227d88eb3c10e2ba0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for python_telegram_bot-10.1.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 725a28f77a04d056559015963a21eacf5d2d1f1722192237284828b7cc437465
MD5 42f685f6fc8d13f0583cb5a2884ab4fb
BLAKE2b-256 f151d1bd383522c12b313eddd7b97b8e7d6cd2a8e3b44b8ff3c88e4a7b045cc8

See more details on using hashes here.

Supported by

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