2021-01-30 14:15:39 +01:00
..
2021-12-11 15:21:56 +01:00
Make sure to apply any changes to this file to README_RAW.rst as well!
2021-01-30 14:15:39 +01:00
2022-06-09 17:08:54 +02:00
.. image :: https://raw.githubusercontent.com/python-telegram-bot/logos/master/logo-text/png/ptb-logo-text_768.png
2015-12-13 21:18:59 +01:00
:align: center
2016-07-24 01:21:35 +02:00
:target: https://python-telegram-bot.org
2015-12-13 21:18:59 +01:00
:alt: python-telegram-bot Logo
2015-07-08 00:28:22 +02:00
2015-08-10 23:17:13 +02:00
.. image :: https://img.shields.io/pypi/v/python-telegram-bot.svg
2018-04-17 06:45:05 +02:00
:target: https://pypi.org/project/python-telegram-bot/
2015-08-10 23:17:13 +02:00
:alt: PyPi Package Version
2015-09-04 23:19:05 +02:00
2016-04-24 18:27:24 +02:00
.. image :: https://img.shields.io/pypi/pyversions/python-telegram-bot.svg
2018-04-17 06:45:05 +02:00
:target: https://pypi.org/project/python-telegram-bot/
:alt: Supported Python versions
2016-04-24 18:27:24 +02:00
2022-11-22 10:43:50 +01:00
.. image :: https://img.shields.io/badge/Bot%20API-6.3-blue?logo=telegram
2021-01-30 14:15:39 +01:00
:target: https://core.telegram.org/bots/api-changelog
:alt: Supported Bot API versions
2021-01-16 11:27:06 +01:00
.. image :: https://img.shields.io/pypi/dm/python-telegram-bot
:target: https://pypistats.org/packages/python-telegram-bot
2017-07-23 21:32:12 +02:00
:alt: PyPi Package Monthly Download
2021-02-01 17:59:39 +01:00
.. image :: https://readthedocs.org/projects/python-telegram-bot/badge/?version=stable
2022-06-09 17:08:54 +02:00
:target: https://docs.python-telegram-bot.org/en/stable/
2015-08-11 23:15:45 +02:00
:alt: Documentation Status
2015-09-04 23:19:05 +02:00
2015-11-09 19:06:30 +01:00
.. image :: https://img.shields.io/pypi/l/python-telegram-bot.svg
2016-04-03 00:26:24 +02:00
:target: https://www.gnu.org/licenses/lgpl-3.0.html
2015-08-10 23:15:17 +02:00
:alt: LGPLv3 License
2015-07-08 00:28:22 +02:00
2021-01-16 11:27:06 +01:00
.. image :: https://github.com/python-telegram-bot/python-telegram-bot/workflows/GitHub%20Actions/badge.svg
2020-01-11 19:47:21 +01:00
:target: https://github.com/python-telegram-bot/python-telegram-bot/
:alt: Github Actions workflow
2015-09-04 23:19:05 +02:00
2022-06-27 18:58:51 +02:00
.. image :: https://codecov.io/gh/python-telegram-bot/python-telegram-bot/branch/master/graph/badge.svg
2022-06-09 17:08:54 +02:00
:target: https://app.codecov.io/gh/python-telegram-bot/python-telegram-bot
2017-09-09 23:38:19 +02:00
:alt: Code coverage
2021-01-30 14:15:39 +01:00
2022-06-09 17:08:54 +02:00
.. image :: https://isitmaintained.com/badge/resolution/python-telegram-bot/python-telegram-bot.svg
:target: https://isitmaintained.com/project/python-telegram-bot/python-telegram-bot
2016-10-19 18:00:33 +02:00
:alt: Median time to resolve an issue
2016-02-01 18:14:17 +01:00
2018-10-01 22:16:48 +02:00
.. image :: https://api.codacy.com/project/badge/Grade/99d901eaa09b44b4819aec05c330c968
2022-06-09 17:08:54 +02:00
:target: https://app.codacy.com/gh/python-telegram-bot/python-telegram-bot/dashboard
2021-05-27 09:38:17 +02:00
:alt: Code quality: Codacy
.. image :: https://deepsource.io/gh/python-telegram-bot/python-telegram-bot.svg/?label=active+issues
:target: https://deepsource.io/gh/python-telegram-bot/python-telegram-bot/?ref=repository-badge
:alt: Code quality: DeepSource
2018-10-01 22:16:48 +02:00
2022-05-06 17:15:23 +02:00
.. 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
2016-01-09 14:57:46 +01:00
.. image :: https://img.shields.io/badge/code%20style-black-000000.svg
2021-05-27 09:38:17 +02:00
:target: https://github.com/psf/black
2022-05-06 17:15:23 +02:00
:alt: Code Style: Black
.. image :: https://img.shields.io/badge/Telegram-Channel-blue.svg?logo=telegram
:target: https://t.me/pythontelegrambotchannel
:alt: Telegram Channel
2020-10-09 17:22:07 +02:00
2021-01-30 14:15:39 +01:00
.. image :: https://img.shields.io/badge/Telegram-Group-blue.svg?logo=telegram
2016-03-13 23:23:48 +01:00
:target: https://telegram.me/pythontelegrambotgroup
2016-01-09 14:57:46 +01:00
:alt: Telegram Group
2015-07-21 15:46:32 +02:00
2022-05-06 17:15:23 +02:00
We have made you a wrapper you can't refuse
2015-07-11 16:55:05 +02:00
2022-05-06 17:15:23 +02:00
We have a vibrant community of developers helping each other in our `Telegram group <https://telegram.me/pythontelegrambotgroup> `_ . Join us!
2015-07-11 16:55:05 +02:00
2022-05-06 17:15:23 +02:00
*Stay tuned for library updates and new releases on our* `Telegram Channel <https://telegram.me/pythontelegrambotchannel> `_ .
2016-04-24 18:39:48 +02:00
2016-05-29 12:35:52 +02:00
Introduction
============
2015-07-08 00:28:22 +02:00
2022-05-06 17:15:23 +02:00
This library provides a pure Python, asynchronous interface for the
2016-05-28 21:44:10 +02:00
`Telegram Bot API <https://core.telegram.org/bots/api> `_ .
2022-05-06 17:15:23 +02:00
It's compatible with Python versions **3.7+** .
2016-05-28 21:44:10 +02:00
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.
2015-07-11 03:21:52 +02:00
2021-01-30 14:15:39 +01:00
A pure API implementation *without* `` telegram.ext `` is available as the standalone package `` python-telegram-bot-raw `` . `See here for details. <https://github.com/python-telegram-bot/python-telegram-bot/blob/master/README_RAW.rst> `_
Note
----
Installing both `` python-telegram-bot `` and `` python-telegram-bot-raw `` in conjunction will result in undesired side-effects, so only install *one* of both.
2016-05-29 12:35:52 +02:00
Telegram API support
====================
2015-07-16 13:20:28 +02:00
2022-08-25 19:36:55 +02:00
All types and methods of the Telegram Bot API **6.2** are supported.
2015-07-08 00:28:22 +02:00
2016-05-29 12:35:52 +02:00
Installing
==========
2015-07-08 23:35:05 +02:00
2022-05-06 17:15:23 +02:00
You can install or upgrade `` python-telegram-bot `` via
2016-04-25 10:34:43 +02:00
.. code :: shell
2015-07-21 14:42:22 +02:00
2016-04-27 01:39:34 +02:00
$ pip install python-telegram-bot --upgrade
2015-07-08 23:35:05 +02:00
2022-05-06 17:15:23 +02:00
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.
2016-09-23 17:13:32 +02:00
.. code :: shell
2022-05-06 17:15:23 +02:00
$ git clone https://github.com/python-telegram-bot/python-telegram-bot
2016-09-23 17:13:32 +02:00
$ cd python-telegram-bot
$ python setup.py install
2016-09-24 15:46:02 +02:00
2022-05-03 17:22:30 +02:00
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.
2022-10-31 10:12:18 +01:00
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.
2022-05-03 17:22:30 +02:00
2022-10-31 10:12:18 +01:00
The only required dependency is `httpx ~= 0.23.0 <https://www.python-httpx.org> `_ for `` telegram.request.HTTPXRequest `` , the default networking backend.
2022-05-03 17:22:30 +02:00
`` python-telegram-bot `` is most useful when used along with additional libraries.
2022-10-31 10:12:18 +01:00
To minimize dependency conflicts, we try to be liberal in terms of version requirements on the (optional) dependencies.
2022-05-03 17:22:30 +02:00
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.
2021-02-13 22:07:37 +01:00
Optional Dependencies
2022-10-31 10:12:18 +01:00
#####################
2021-02-13 22:07:37 +01:00
PTB can be installed with optional dependencies:
2022-06-09 17:08:54 +02:00
* `` pip install python-telegram-bot[passport] `` installs the `cryptography>=3.0 <https://cryptography.io/en/stable> `_ library. Use this, if you want to use Telegram Passport related functionality.
2022-05-03 17:22:30 +02:00
* `` pip install python-telegram-bot[socks] `` installs `` httpx[socks] `` . Use this, if you want to work behind a Socks5 server.
2022-08-26 06:50:03 +02:00
* `` pip install python-telegram-bot[rate-limiter] `` installs `` aiolimiter~=1.0.0 `` . Use this, if you want to use `` telegram.ext.AIORateLimiter `` .
2022-10-31 10:12:18 +01:00
* `` pip install python-telegram-bot[webhooks] `` installs the `tornado~=6.2 <https://www.tornadoweb.org/en/stable/> `_ library. Use this, if you want to use `` telegram.ext.Updater.start_webhook `` /`` telegram.ext.Application.start_webhook `` .
* `` pip install python-telegram-bot[callback-data] `` installs the `cachetools~=5.2.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.9.1 <https://apscheduler.readthedocs.io/en/3.x/> `_ library and enforces `pytz>=2018.6 <https://pypi.org/project/pytz/> `_ , 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] `` .
2021-02-13 22:07:37 +01:00
2022-05-06 17:15:23 +02:00
Quick Start
===========
2015-08-09 14:59:41 +02:00
2022-05-06 17:15:23 +02:00
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-%E2%80%93-Your-first-Bot> `_ gives an introduction on how chatbots can be easily programmed with the help of the `` telegram.ext `` module.
2015-11-17 05:34:00 +01:00
2022-05-06 17:15:23 +02:00
Resources
=========
2015-08-11 23:07:32 +02:00
2022-06-09 17:08:54 +02:00
- The `package documentation <https://docs.python-telegram-bot.org/> `_ is the technical reference for `` python-telegram-bot `` .
2022-06-27 18:58:51 +02:00
It contains descriptions of all available classes, modules, methods and arguments as well as the `changelog <https://docs.python-telegram-bot.org/changelog.html> `_ .
2022-05-06 17:15:23 +02:00
- 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.
2022-06-09 17:22:32 +02:00
- 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 `` .
2022-05-06 17:15:23 +02:00
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.
2015-08-11 23:07:32 +02:00
2016-05-29 12:35:52 +02:00
Getting help
============
2015-07-11 06:55:33 +02:00
2022-05-06 17:15:23 +02:00
If the resources mentioned above don't answer your questions or simply overwhelm you, there are several ways of getting help.
2016-04-24 18:27:24 +02:00
2022-05-06 17:15:23 +02:00
1. 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.
2016-05-28 21:44:10 +02:00
2022-05-06 17:15:23 +02:00
2. Ask questions by opening `a discussion <https://github.com/python-telegram-bot/python-telegram-bot/discussions/new> `_ .
2019-10-22 00:04:31 +02:00
2022-05-06 17:15:23 +02:00
3. You can even ask for help on Stack Overflow using the `python-telegram-bot tag <https://stackoverflow.com/questions/tagged/python-telegram-bot> `_ .
Documentation Improvements (#2008)
* Minor doc updates, following official API docs
* Fix spelling in Defaults docstrings
* Clarify Changelog of v12.7 about aware dates
* Fix typo in CHANGES.rst (#2024)
* Fix PicklePersistence.flush() with only bot_data (#2017)
* Update pylint in pre-commit to fix CI (#2018)
* Add Filters.via_bot (#2009)
* feat: via_bot filter
also fixing a small mistake in the empty parameter of the user filter and improve docs slightly
* fix: forgot to set via_bot to None
* fix: redoing subclassing to copy paste solution
* Cosmetic changes
Co-authored-by: Hinrich Mahler <hinrich.mahler@freenet.de>
* Update CHANGES.rst
Fixed Typo
Co-authored-by: Bibo-Joshi <hinrich.mahler@freenet.de>
Co-authored-by: Poolitzer <25934244+Poolitzer@users.noreply.github.com>
* Update downloads badge, add info on IRC Channel to Getting Help section
* Remove RegexHandler from ConversationHandlers Docs (#1973)
Replaced RegexHandler with MessageHandler, since the former is deprecated
* Fix Filters.via_bot docstrings
* Add notes on Markdown v1 being legacy mode
* Fixed typo in the Regex doc.. (#2036)
* Typo: Spelling
* Minor cleanup from #2043
* Document CommandHandler ignoring channel posts
* Doc fixes for a few telegram.ext classes
* Doc fixes for most `telegram` classes.
* pep-8
forgot the hard wrap is at 99 chars, not 100!
fixed a few spelling mistakes too.
* Address review and made rendering of booleans consistent
True, False, None are now rendered with ``bool`` wherever they weren't in telegram and telegram.ext classes.
* Few doc fixes for inline* classes
As usual, docs were cross-checked with official tg api docs.
* Doc fixes for telegram/files classes
As usual, docs were cross-checked with official tg api docs.
* Doc fixes for telegram.Game
Mostly just added hyperlinks. And fixed message length doc.
As usual, docs were cross-checked with official tg api docs.
* Very minor doc fix for passportfile.py and passportelementerrors.py
Didn't bother changing too much since this seems to be a custom implementation.
* Doc fixes for telegram.payments
As usual, cross-checked with official bot api docs.
* Address review 2
Few tiny other fixes too.
* Changed from ``True/False/None`` to :obj:`True/False/None` project-wide.
Few tiny other doc fixes too.
Co-authored-by: Robert Geislinger <mitachundkrach@gmail.com>
Co-authored-by: Poolitzer <25934244+Poolitzer@users.noreply.github.com>
Co-authored-by: GauthamramRavichandran <30320759+GauthamramRavichandran@users.noreply.github.com>
Co-authored-by: Mahesh19 <maheshvagicherla99438@gmail.com>
Co-authored-by: hoppingturtles <ilovebhagwan@gmail.com>
2020-08-24 19:35:57 +02:00
2022-05-06 17:15:23 +02:00
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:
2016-05-28 21:44:10 +02:00
2022-05-06 17:15:23 +02:00
* `` 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
2016-04-24 18:27:24 +02:00
2016-05-29 12:35:52 +02:00
Contributing
============
2015-07-08 22:58:50 +02:00
2022-05-06 17:15:23 +02:00
Contributions of all sizes are welcome.
Please review our `contribution guidelines <https://github.com/python-telegram-bot/python-telegram-bot/blob/master/.github/CONTRIBUTING.rst> `_ to get started.
You can also help by `reporting bugs or feature requests <https://github.com/python-telegram-bot/python-telegram-bot/issues/new> `_ .
2016-04-24 18:39:48 +02:00
2021-03-14 16:46:37 +01:00
Donating
========
2022-05-06 17:15:23 +02:00
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.
2021-03-14 16:46:37 +01:00
2016-05-29 12:35:52 +02:00
License
=======
2016-04-24 18:39:48 +02:00
2022-05-06 17:15:23 +02:00
You may copy, distribute and modify the software provided that modifications are described and licensed for free under `LGPL-3 <https://www.gnu.org/licenses/lgpl-3.0.html> `_ .
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.
