Python Makefile
jsmnbom Update AUTHORS.rst
Name change, plus adding @eldinnie and I to maintainers.
Latest commit d4b5bd4 Jun 26, 2018
Permalink
Failed to load latest commit information.
.github Switch to pytest + required fixes to code (#788) Aug 11, 2017
docs Revert "Context based callbacks (#1100)" May 31, 2018
examples Revert "Context based callbacks (#1100)" May 31, 2018
telegram Revert "Context based callbacks (#1100)" May 31, 2018
tests Fix ProcessLookupError if process finishes before we kill it (#1126) Jun 1, 2018
.gitignore bot.py: Add shortcut method reply_media_group (#994) Feb 12, 2018
.gitmodules Avoid confusion with user's urllib3 by renaming vendored urllib3 May 24, 2017
.pre-commit-config.yaml flake8 revamp Feb 19, 2018
.readthedocs.yml Updating sphinx to py3 (#1096) May 3, 2018
.travis.yml Add 3.7-dev to travis (#1106) May 8, 2018
AUTHORS.rst Update AUTHORS.rst Jun 26, 2018
CHANGES.rst Revert "Context based callbacks (#1100)" May 31, 2018
CODE_OF_CONDUCT.md Update code of conduct (#980) Jan 20, 2018
LICENSE Moving from GPLv2 to LGPLv3 Aug 10, 2015
LICENSE.lesser Moving from GPLv2 to LGPLv3 Aug 10, 2015
MANIFEST.in Adds requirements.txt to MANIFEST Nov 11, 2015
Makefile Switch to pytest + required fixes to code (#788) Aug 11, 2017
README.rst Update all appveyor links in README Apr 19, 2018
appveyor.yml Remove wheel from yamls May 5, 2018
codecov.yml remove codeclimate (#1014) Feb 19, 2018
requirements-dev.txt requirements-dev.txt: Added missing 'wheel' package May 4, 2018
requirements.txt Fix download of URLs with UTF-8 chars in path Jun 24, 2017
setup.cfg Revert "Context based callbacks (#1100)" May 31, 2018
setup.py Drop 3.3 from support (#930) Dec 8, 2017

README.rst

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.