Skip to main content

Not just a Python wrapper around the Telegram Bot API

Project description

python-telegram-bot Logo

Not just a Python wrapper around the Telegram Bot API

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 Average time to resolve an issue Telegram Group

Table of contents

Introduction

This library provides a pure Python interface for the Telegram Bot API. It works with Python versions from 2.6+ (Note: Support for 2.6 will be dropped at some point this year. 2.7 will still be supported). 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 28. May 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 --upgrade

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 (below), 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.

Examples using only the pure API:

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 pythonhosted.org.

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

Uploaded Source

Built Distribution

python_telegram_bot-4.2.1-py2.py3-none-any.whl (120.9 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for python-telegram-bot-4.2.1.tar.gz
Algorithm Hash digest
SHA256 ff6fe4d158cc94fca1633d50f04cbc407fd2052019de23c0e6d658a91a2b11d0
MD5 5638ee55048caecbce2d42230df8975e
BLAKE2b-256 98bec7f8e0b3887f4ae4433cd963245b9c09fb3825a5ab64a0bd71bb9c972437

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for python_telegram_bot-4.2.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 6866272f364f346a4451ebeebe431ba2685e10f5cff498cb62d79f8cc0f7e9eb
MD5 f071636a8651476bc612ef19a677b679
BLAKE2b-256 794526af7611ed8960273e99dcbc8d02a3ffce24a580b1506891ae47c2676cf3

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