Skip to main content

Not just a Python wrapper around the Telegram Bot API

Project description

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 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’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 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

Or you can install from source with:

$ git clone https://github.com/python-telegram-bot/python-telegram-bot
$ cd python-telegram-bot
$ python setup.py install

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

Uploaded Source

Built Distribution

python_telegram_bot-5.1.0-py2.py3-none-any.whl (134.4 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for python-telegram-bot-5.1.0.tar.gz
Algorithm Hash digest
SHA256 0280493499aa7948a0ed5eff3339e4c12a897c0592abbf4cc1b3ed57b18587ec
MD5 c6b3a719c31e6361a2451b8ed8bac1a8
BLAKE2b-256 73143ddeb9f0c2887e01ddb621fdd3e0a893f023a6325679d73c6f00687ec66e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for python_telegram_bot-5.1.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 194c568845bbcb942954372ef5c0904a21c87ed6cd45c495a8b3fa3610d76ce2
MD5 9a5c68dc4c5c8297a2418bbbd313d01d
BLAKE2b-256 15273856b3388cca4216540c1a69801aac38eb4d161ba5b226c087db6b94c718

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