This library provides a pure Python, asynchronous interface for the Telegram Bot API <https://core.telegram.org/bots/api>_. It's compatible with Python versions 3.10+.

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 **10.0** are natively supported by this library.
In addition, Bot API functionality not yet natively included can still be used as described `in our wiki <https://github.com/python-telegram-bot/python-telegram-bot/wiki/Bot-API-Forward-Compatibility>`_.

Notable Features
~~~~~~~~~~~~~~~~

- `Fully asynchronous <https://github.com/python-telegram-bot/python-telegram-bot/wiki/Concurrency>`_
- Convenient shortcut methods, e.g. `Message.reply_text <https://docs.python-telegram-bot.org/en/stable/telegram.message.html#telegram.Message.reply_text>`_
- `Fully annotated with static type hints <https://github.com/python-telegram-bot/python-telegram-bot/wiki/Type-Checking>`_
- `Customizable and extendable interface <https://github.com/python-telegram-bot/python-telegram-bot/wiki/Architecture>`_
- Seamless integration with `webhooks <https://github.com/python-telegram-bot/python-telegram-bot/wiki/Webhooks>`_ and `polling <https://docs.python-telegram-bot.org/en/stable/telegram.ext.application.html#telegram.ext.Application.run_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 <https://pip.pypa.io/en/stable/cli/pip_install/#cmdoption-pre>`_ 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

You can also use your favored package manager (such as ``uv``, ``hatch``, ``poetry``, etc.) instead of ``pip``.

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 <https://www.sigstore.dev>`_.
The corresponding signature files are uploaded to the `GitHub releases page`_.
To verify the signature, please install the `sigstore Python client <https://pypi.org/project/sigstore/>`_ and follow the instructions for `verifying signatures from GitHub Actions <https://github.com/sigstore/sigstore-python?tab=readme-ov-file>`_. 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 <https://pypi.org/project/python-telegram-bot/>`_ and end with a suffix ``.asc``.
Please find the public keys `here <https://github.com/python-telegram-bot/python-telegram-bot/tree/master/public_keys>`_.
The keys are named in the format ``<first_version>-<last_version>.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,<0.29 <https://www.python-httpx.org>_ 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 <https://cryptography.io/en/stable>_ library. Use this, if you want to use Telegram Passport related functionality.
pip install "python-telegram-bot[socks]" installs httpx[socks] <https://www.python-httpx.org/#dependencies>_. Use this, if you want to work behind a Socks5 server.
pip install "python-telegram-bot[http2]" installs httpx[http2] <https://www.python-httpx.org/#dependencies>_. Use this, if you want to use HTTP/2.
pip install "python-telegram-bot[rate-limiter]" installs aiolimiter~=1.1,<1.3 <https://aiolimiter.readthedocs.io/en/stable/>_. Use this, if you want to use telegram.ext.AIORateLimiter.
pip install "python-telegram-bot[webhooks]" installs the tornado~=6.4 <https://www.tornadoweb.org/en/stable/>_ 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,<6.3.0 <https://cachetools.readthedocs.io/en/latest/>_ library. Use this, if you want to use arbitrary callback_data <https://github.com/python-telegram-bot/python-telegram-bot/wiki/Arbitrary-callback_data>_.
pip install "python-telegram-bot[job-queue]" installs the APScheduler>=3.10.4,<3.12.0 <https://apscheduler.readthedocs.io/en/3.x/>_ library. 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 <https://github.com/python-telegram-bot/python-telegram-bot/wiki/Introduction-to-the-API>`_ explaining how the pure Bot API can be accessed via ``python-telegram-bot``.
Moreover, the `Tutorial: Your first Bot <https://github.com/python-telegram-bot/python-telegram-bot/wiki/Extensions---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 <https://docs.python-telegram-bot.org/>`_ is the technical reference for ``python-telegram-bot``.
  It contains descriptions of all available classes, modules, methods and arguments as well as the `changelog <https://docs.python-telegram-bot.org/changelog.html>`_.
- The `wiki <https://github.com/python-telegram-bot/python-telegram-bot/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 <https://docs.python-telegram-bot.org/examples.html>`_ 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 <https://core.telegram.org/bots/api>`_ 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.

We have a vibrant community of developers helping each other in our Telegram group <https://telegram.me/pythontelegrambotgroup>_. Join us! Asking a question here is often the quickest way to get a pointer in the right direction.
Ask questions by opening a discussion <https://github.com/python-telegram-bot/python-telegram-bot/discussions/new>_.
You can even ask for help on Stack Overflow using the python-telegram-bot tag <https://stackoverflow.com/questions/tagged/python-telegram-bot>

核心特点

•Fully asynchronous <https://github.com/python-telegram-bot/python-telegram-bot/wiki/Concurrency>_
•Convenient shortcut methods, e.g. Message.reply_text <https://docs.python-telegram-bot.org/en/stable/telegram.message.html#telegram.Message.reply_text>_
•Fully annotated with static type hints <https://github.com/python-telegram-bot/python-telegram-bot/wiki/Type-Checking>_
•Customizable and extendable interface <https://github.com/python-telegram-bot/python-telegram-bot/wiki/Architecture>_
•Comprehensive documentation and examples <#working-with-ptb>_
•`pip install "python-telegram-bot[socks]" installs httpx[socks] <https://www.python-httpx.org/#dependencies>`_. Use this, if you want to work behind a Socks5 server.
•`pip install "python-telegram-bot[http2]" installs httpx[http2] <https://www.python-httpx.org/#dependencies>`_. Use this, if you want to use HTTP/2.
•`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]`.
•The package documentation <https://docs.python-telegram-bot.org/>_ is the technical reference for `python-telegram-bot`.

> 标签

Pythonbotchatbotframeworkpython

python-telegram-bot

工具介绍

Introduction

Working with PTB

核心特点

> 标签

> 工具信息

> 相关工具

python-telegram-bot

工具介绍

Introduction

Working with PTB

核心特点

> 标签

> 讨论区

> 工具信息

> 相关工具