Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/python-telegram-bot/python-telegram-bot

We have made you a wrapper you can't refuse
https://github.com/python-telegram-bot/python-telegram-bot

bot chatbot framework hacktoberfest python telegram

Last synced: 6 days ago
JSON representation

We have made you a wrapper you can't refuse

Awesome Lists containing this project

README 

        
.. image:: https://raw.githubusercontent.com/python-telegram-bot/logos/master/logo-text/png/ptb-logo-text_768.png

   :align: center

   :target: https://python-telegram-bot.org

   :alt: python-telegram-bot Logo



.. image:: https://img.shields.io/pypi/v/python-telegram-bot.svg

   :target: https://pypi.org/project/python-telegram-bot/

   :alt: PyPi Package Version



.. image:: https://img.shields.io/pypi/pyversions/python-telegram-bot.svg

   :target: https://pypi.org/project/python-telegram-bot/

   :alt: Supported Python versions



.. image:: https://img.shields.io/badge/Bot%20API-7.10-blue?logo=telegram

   :target: https://core.telegram.org/bots/api-changelog

   :alt: Supported Bot API version



.. image:: https://img.shields.io/pypi/dm/python-telegram-bot

   :target: https://pypistats.org/packages/python-telegram-bot

   :alt: PyPi Package Monthly Download



.. image:: https://readthedocs.org/projects/python-telegram-bot/badge/?version=stable

   :target: https://docs.python-telegram-bot.org/en/stable/

   :alt: Documentation Status



.. image:: https://img.shields.io/pypi/l/python-telegram-bot.svg

   :target: https://www.gnu.org/licenses/lgpl-3.0.html

   :alt: LGPLv3 License



.. image:: https://github.com/python-telegram-bot/python-telegram-bot/actions/workflows/unit_tests.yml/badge.svg?branch=master

   :target: https://github.com/python-telegram-bot/python-telegram-bot/

   :alt: Github Actions workflow



.. image:: https://codecov.io/gh/python-telegram-bot/python-telegram-bot/branch/master/graph/badge.svg

   :target: https://app.codecov.io/gh/python-telegram-bot/python-telegram-bot

   :alt: Code coverage



.. image:: https://isitmaintained.com/badge/resolution/python-telegram-bot/python-telegram-bot.svg

   :target: https://isitmaintained.com/project/python-telegram-bot/python-telegram-bot

   :alt: Median time to resolve an issue



.. image:: https://api.codacy.com/project/badge/Grade/99d901eaa09b44b4819aec05c330c968

   :target: https://app.codacy.com/gh/python-telegram-bot/python-telegram-bot/dashboard

   :alt: Code quality: Codacy



.. image:: https://results.pre-commit.ci/badge/github/python-telegram-bot/python-telegram-bot/master.svg

   :target: https://results.pre-commit.ci/latest/github/python-telegram-bot/python-telegram-bot/master

   :alt: pre-commit.ci status



.. image:: https://img.shields.io/badge/code%20style-black-000000.svg

   :target: https://github.com/psf/black

   :alt: Code Style: Black



.. image:: https://img.shields.io/badge/Telegram-Channel-blue.svg?logo=telegram

   :target: https://t.me/pythontelegrambotchannel

   :alt: Telegram Channel



.. image:: https://img.shields.io/badge/Telegram-Group-blue.svg?logo=telegram

   :target: https://telegram.me/pythontelegrambotgroup

   :alt: Telegram Group



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 `_.



Introduction

------------



This library provides a pure Python, asynchronous interface for the

`Telegram Bot API `_.

It's compatible with Python versions **3.9+**.



In addition to the pure API implementation, this library features several convenience methods and shortcuts as well as a number of high-level classes to

make the development of bots easy and straightforward. These classes are contained in the

``telegram.ext`` submodule.



After installing_ the library, be sure to check out the section on `working with PTB`_.



Telegram API support

~~~~~~~~~~~~~~~~~~~~



All types and methods of the Telegram Bot API **7.10** are natively supported by this library.

In addition, Bot API functionality not yet natively included can still be used as described `in our wiki `_.



Notable Features

~~~~~~~~~~~~~~~~



- `Fully asynchronous `_

- Convenient shortcut methods, e.g. `Message.reply_text `_

- `Fully annotated with static type hints `_

- `Customizable and extendable interface `_

- Seamless integration with `webhooks `_ and `polling `_

- `Comprehensive documentation and examples <#working-with-ptb>`_



Installing

----------



You can install or upgrade ``python-telegram-bot`` via



.. code:: shell



    $ pip install python-telegram-bot --upgrade



To install a pre-release, use the ``--pre`` `flag `_ in addition.



You can also install ``python-telegram-bot`` from source, though this is usually not necessary.



.. code:: shell



    $ git clone https://github.com/python-telegram-bot/python-telegram-bot

    $ cd python-telegram-bot

    $ pip install build

    $ python -m build



Verifying Releases

~~~~~~~~~~~~~~~~~~



To enable you to verify that a release file that you downloaded was indeed provided by the ``python-telegram-bot`` team, we have taken the following measures.



Starting with v21.4, all releases are signed via `sigstore `_.

The corresponding signature files are uploaded to the `GitHub releases page`_.

To verify the signature, please install the `sigstore Python client `_ and follow the instructions for `verifying signatures from GitHub Actions `_. As input for the ``--repository`` parameter, please use the value ``python-telegram-bot/python-telegram-bot``.



Earlier releases are signed with a GPG key.

The signatures are uploaded to both the `GitHub releases page`_ and the `PyPI project `_ and end with a suffix ``.asc``.

Please find the public keys `here `_.

The keys are named in the format ``-.gpg``.



In addition, the GitHub release page also contains the sha1 hashes of the release files in the files with the suffix ``.sha1``.



Dependencies & Their Versions

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~



``python-telegram-bot`` tries to use as few 3rd party dependencies as possible.

However, for some features using a 3rd party library is more sane than implementing the functionality again.

As these features are *optional*, the corresponding 3rd party dependencies are not installed by default.

Instead, they are listed as optional dependencies.

This allows to avoid unnecessary dependency conflicts for users who don't need the optional features.



The only required dependency is `httpx ~= 0.27 `_ for

``telegram.request.HTTPXRequest``, the default networking backend.



``python-telegram-bot`` is most useful when used along with additional libraries.

To minimize dependency conflicts, we try to be liberal in terms of version requirements on the (optional) dependencies.

On the other hand, we have to ensure stability of ``python-telegram-bot``, which is why we do apply version bounds.

If you encounter dependency conflicts due to these bounds, feel free to reach out.



Optional Dependencies

#####################



PTB can be installed with optional dependencies:



* ``pip install "python-telegram-bot[passport]"`` installs the `cryptography>=39.0.1 `_ library. Use this, if you want to use Telegram Passport related functionality.

* ``pip install "python-telegram-bot[socks]"`` installs `httpx[socks] `_. Use this, if you want to work behind a Socks5 server.

* ``pip install "python-telegram-bot[http2]"`` installs `httpx[http2] `_. Use this, if you want to use HTTP/2.

* ``pip install "python-telegram-bot[rate-limiter]"`` installs `aiolimiter~=1.1.0 `_. Use this, if you want to use ``telegram.ext.AIORateLimiter``.

* ``pip install "python-telegram-bot[webhooks]"`` installs the `tornado~=6.4 `_ library. Use this, if you want to use ``telegram.ext.Updater.start_webhook``/``telegram.ext.Application.run_webhook``.

* ``pip install "python-telegram-bot[callback-data]"`` installs the `cachetools>=5.3.3,<5.6.0 `_ library. Use this, if you want to use `arbitrary callback_data `_.

* ``pip install "python-telegram-bot[job-queue]"`` installs the `APScheduler~=3.10.4 `_ library and enforces `pytz>=2018.6 `_, where ``pytz`` is a dependency of ``APScheduler``. Use this, if you want to use the ``telegram.ext.JobQueue``.



To install multiple optional dependencies, separate them by commas, e.g. ``pip install "python-telegram-bot[socks,webhooks]"``.



Additionally, two shortcuts are provided:



* ``pip install "python-telegram-bot[all]"`` installs all optional dependencies.

* ``pip install "python-telegram-bot[ext]"`` installs all optional dependencies that are related to ``telegram.ext``, i.e. ``[rate-limiter, webhooks, callback-data, job-queue]``.



Working with PTB

----------------



Once you have installed the library, you can begin working with it - so let's get started!



Quick Start

~~~~~~~~~~~



Our Wiki contains an `Introduction to the API `_ explaining how the pure Bot API can be accessed via ``python-telegram-bot``.

Moreover, the `Tutorial: Your first Bot `_ gives an introduction on how chatbots can be easily programmed with the help of the ``telegram.ext`` module.



Resources

~~~~~~~~~



- The `package documentation `_ is the technical reference for ``python-telegram-bot``.

  It contains descriptions of all available classes, modules, methods and arguments as well as the `changelog `_.

- The `wiki `_ is home to number of more elaborate introductions of the different features of ``python-telegram-bot`` and other useful resources that go beyond the technical documentation.

- Our `examples section `_ contains several examples that showcase the different features of both the Bot API and ``python-telegram-bot``.

  Even if it is not your approach for learning, please take a look at ``echobot.py``. It is the de facto base for most of the bots out there.

  The code for these examples is released to the public domain, so you can start by grabbing the code and building on top of it.

- The `official Telegram Bot API documentation `_ is of course always worth a read.



Getting help

~~~~~~~~~~~~



If the resources mentioned above don't answer your questions or simply overwhelm you, there are several ways of getting help.



1. We have a vibrant community of developers helping each other in our `Telegram group `_. Join us! Asking a question here is often the quickest way to get a pointer in the right direction.



2. Ask questions by opening `a discussion `_.



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



Concurrency

~~~~~~~~~~~



Since v20.0, ``python-telegram-bot`` is built on top of Pythons ``asyncio`` module.

Because ``asyncio`` is in general single-threaded, ``python-telegram-bot`` does currently not aim to be thread-safe.

Noteworthy parts of ``python-telegram-bots`` API that are likely to cause issues (e.g. race conditions) when used in a multi-threaded setting include:



* ``telegram.ext.Application/Updater.update_queue``

* ``telegram.ext.ConversationHandler.check/handle_update``

* ``telegram.ext.CallbackDataCache``

* ``telegram.ext.BasePersistence``

* all classes in the ``telegram.ext.filters`` module that allow to add/remove allowed users/chats at runtime



Contributing

------------



Contributions of all sizes are welcome.

Please review our `contribution guidelines `_ to get started.

You can also help by `reporting bugs or feature requests `_.



Donating

--------

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.



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.



.. _`GitHub releases page`: https://github.com/python-telegram-bot/python-telegram-bot/releases>