Repository files navigation

We have made you a wrapper you can't refuse

We have a vibrant community of developers helping each other in ourTelegram group. Join us!

Stay tuned for library updates and new releases on ourTelegram Channel.

• Introduction
• Telegram API support
• Installing
• Getting started
  1. Learning by example
  2. Logging
  3. Documentation
• Getting help
• Contributing
• License

This library provides a pure Python interface for theTelegram Bot API.It's compatible with Python versions 3.7+. PTB might also work onPyPy, though there have been a lot of issues before. Hence, PyPy is not officially supported.

In addition to the pure API implementation, this library features a number of high-level classes tomake the development of bots easy and straightforward. These classes are contained in thetelegram.ext submodule.

A pure API implementationwithouttelegram.ext is available as the standalone packagepython-telegram-bot-raw.See here for details.

Installing bothpython-telegram-bot andpython-telegram-bot-raw in conjunction will result in undesired side-effects, so only installone of both.

All types and methods of the Telegram Bot API6.2 are supported.

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

PTB can be installed with optional dependencies:

• pip install python-telegram-bot[passport] installs thecryptography library. Use this, if you want to use Telegram Passport related functionality.
• pip install python-telegram-bot[ujson] installs theujson library. It will then be used for JSON de- & encoding, which can bring speed up compared to the standardjson library.
• pip install python-telegram-bot[socks] installs thePySocks library. Use this, if you want to work behind a Socks5 server.

Our Wiki contains a lot of resources to get you started withpython-telegram-bot:

• Introduction to the API
• Tutorial:Your first Bot

Other references:

• Telegram API documentation
• python-telegram-bot documentation

We believe that the best way to learn this package is by example. Hereare some examples for you to review. Even if it is not your approach for learning, please take alook atechobot.py, 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 thecode and building on top of it.

Visitthis page to discover the official examples or look at the examples on thewiki to see other bots the community has built.

This library uses thelogging module. To set up logging to standard output, put:

importlogginglogging.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 callinglogging.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)

python-telegram-bot's documentation lives atreadthedocs.io.

You can get help in several ways:

1. We have a vibrant community of developers helping each other in ourTelegram group. Join us!
2. Report bugs, request new features or ask questions bycreating an issue ora discussion.
3. OurWiki pages offer a growing amount of resources.
4. You can even ask for help on Stack Overflow using thepython-telegram-bot tag.

Contributions of all sizes are welcome. Please review ourcontribution guidelines to get started. You can also help byreporting bugs.

Occasionally we are asked if we accept donations to support the development. While we appreciate the thought, maintaining PTB is our hobby and we have almost no running costs for it. We therefore have nothing set up to accept donations. If you still want to donate, we kindly ask you to donate to another open source project/initiative of your choice instead.

You may copy, distribute and modify the software provided that modifications are described and licensed for free underLGPL-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.