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 Github Actions workflow Code coverage Median time to resolve an issue Code quality 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 3.5+ and PyPy.

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

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. Report bugs, request new features or ask questions by creating an issue.

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

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

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

Uploaded Source

Built Distribution

python_telegram_bot-12.5.1-py2.py3-none-any.whl (367.4 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: python-telegram-bot-12.5.1.tar.gz
  • Upload date:
  • Size: 246.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.44.0 CPython/3.6.9

File hashes

Hashes for python-telegram-bot-12.5.1.tar.gz
Algorithm Hash digest
SHA256 6d69fb04dc8d83e01cb25a0d83aaa2a1a4b7d5b14cd38b9f8922a567b4a4a510
MD5 885322b5d74be6751aa17d0ca3e404f4
BLAKE2b-256 ddb35b91ce4307cb8692227bfc633cdb2e05cfd4055700b531062e395926d361

See more details on using hashes here.

File details

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

File metadata

  • Download URL: python_telegram_bot-12.5.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 367.4 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.44.0 CPython/3.6.9

File hashes

Hashes for python_telegram_bot-12.5.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 af36fbf051415ded8b2633f27b71d292efcd85d58a647a1f138db191380144ff
MD5 2f63434eb8b1ac0b7b04ba38c4ad0950
BLAKE2b-256 e3e5859ab43f1b60963958f6926a22a3726c084b7d384da0d5bb6b5140a98836

See more details on using hashes here.

Supported by

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