Bump version to v5.1.1

.codeclimate.yml

@@ -0,0 +1,5 @@
+languages:
+  Python: true
+exclude_paths:
+- "telegram/emoji.py"
+- "tests/*"

.coveragerc

@@ -0,0 +1,5 @@
+[run]
+source = telegram
+
+[report]
+omit = tests/

.git-blame-ignore-revs

@@ -1,7 +0,0 @@
-# .git-blame-ignore-revs
-# Use locally as `git blame file.py --ignore-revs-file .git-blame-ignore-revs`
-# or configure git to always use it: `git config blame.ignoreRevsFile .git-blame-ignore-revs`
-# First migration to code style Black (#2122)
-264b2c9c72691c5937b80e84e061c52dd2d8861a
-# Use Black more extensively (#2972)
-950d9a0751d79b92d78ea44344ce3e3c5b3948f9

.github/CONTRIBUTING.rst

@@ -1,11 +1,10 @@
-=================
 How To Contribute
-=================
+===================
 
 Every open source project lives from the generous help by contributors that sacrifice their time and ``python-telegram-bot`` is no different. To make participation as pleasant as possible, this project adheres to the `Code of Conduct`_ by the Python Software Foundation.
 
 Setting things up
-=================
+-------------------
 
 1. Fork the ``python-telegram-bot`` repository to your GitHub account.
 
@@ -22,41 +21,33 @@ Setting things up
 
       $ git remote add upstream https://github.com/python-telegram-bot/python-telegram-bot
 
-4. Install the package in development mode as well as optional dependencies and development dependencies.
-   Note that the `--group` argument requires `pip` 25.1 or later.
-   
-   Alternatively, you can use your preferred package manager (such as uv, hatch, poetry, etc.) instead of pip.
+4. Install dependencies:
 
    .. code-block:: bash
 
-      $ pip install -e .[all] --group all
+      $ sudo pip install -r requirements.txt -r requirements-dev.txt
 
-   Installing the package itself is necessary because python-telegram-bot uses a src-based layout where the package code is located in the ``src/`` directory.
 
 5. Install pre-commit hooks:
 
    .. code-block:: bash
 
-      $ prek install -f
+      $ pre-commit install
 
 Finding something to do
-=======================
+###################
 
 If you already know what you'd like to work on, you can skip this section.
 
 If you have an idea for something to do, first check if it's already been filed on the `issue tracker`_. If so, add a comment to the issue saying you'd like to work on it, and we'll help you get started! Otherwise, please file a new issue and assign yourself to it.
 
-Another great way to start contributing is by writing tests. Tests are really important because they help prevent developers from accidentally breaking existing code, allowing them to build cool things faster. If you're interested in helping out, let the development team know by posting to the `Telegram group`_, and we'll help you get started.
-
-That being said, we want to mention that we are very hesitant about adding new requirements to our projects. If you intend to do this, please state this in an issue and get a verification from one of the maintainers.
+Another great way to start contributing is by writing tests. Tests are really important because they help prevent developers from accidentally breaking existing code, allowing them to build cool things faster. If you're interested in helping out, let the development team know by posting to the `developers' mailing list`_, and we'll help you get started.
 
 Instructions for making a code change
-=====================================
+####################
 
 The central development branch is ``master``, which should be clean and ready for release at any time. In general, all changes should be done as feature branches based off of ``master``.
 
-If you want to do solely documentation changes, base them and PR to the branch ``doc-fixes``. This branch also has its own `RTD build`_.
-
 Here's how to make a one-off code change.
 
 1. **Choose a descriptive branch name.** It should be lowercase, hyphen-separated, and a noun describing the change (so, ``fuzzy-rules``, but not ``implement-fuzzy-rules``). Also, it shouldn't start with ``hotfix`` or ``release``.
@@ -71,43 +62,41 @@ Here's how to make a one-off code change.
       $ git checkout -b your-branch-name
 
 3. **Make a commit to your feature branch**. Each commit should be self-contained and have a descriptive commit message that helps other developers understand why the changes were made.
-   We also have a check-list for PRs `below`_.
 
    - You can refer to relevant issues in the commit message by writing, e.g., "#105".
 
    - Your code should adhere to the `PEP 8 Style Guide`_, with the exception that we have a maximum line length of 99.
 
-   - Provide static typing with signature annotations. The documentation of `MyPy`_ will be a good start, the cheat sheet is `here`_. We also have some custom type aliases in ``telegram._utils.types``.
-
-   - Document your code. This step is pretty important to us, so it has its own `section`_.
-
-   - For consistency, please conform to `Google Python Style Guide`_ and `Google Python Style Docstrings`_.
+   - For consistency, please conform to `Google Python Style Guide`_ and `Google Python Style Docstrings`_. In addition, code should be formatted consistently with other code around it.
 
    - The following exceptions to the above (Google's) style guides applies:
 
-     - Documenting types of global variables and complex types of class members can be done using the Sphinx docstring convention.
+        - Documenting types of global variables and complex types of class members can be done using the Sphinx docstring convention.
 
-   -  In addition, PTB uses some formatting/styling and linting tools in the pre-commit setup. Some of those tools also have command line tools that can help to run these tools outside of the pre-commit step. If you'd like to leverage that, please have a look at the `pre-commit config file`_ for an overview of which tools (and which versions of them) are used. For example, we use `Ruff`_ for linting and formatting.
+   - Please ensure that the code you write is well-tested.
 
-   - Please ensure that the code you write is well-tested and that all automated tests still pass. We
-     have dedicated an `testing page`_ to help you with that.
-
-   - Don't break backward compatibility.
+   - Don’t break backward compatibility.
 
    - Add yourself to the AUTHORS.rst_ file in an alphabetical fashion.
 
-   - If you want run style & type checks before committing run
+   - Before making a commit ensure that all automated tests still pass:
 
-     .. code-block:: bash
+     .. code-block::
 
-        $ prek run -a
+        $ make test
 
-   - To actually make the commit (this will trigger tests style & type checks automatically):
+   - To actually make the commit (this will trigger tests for yapf, lint and pep8 automatically):
 
      .. code-block:: bash
 
         $ git add your-file-changed.py
 
+   - yapf may change code formatting, make sure to re-add them to your commit.
+
+     .. code-block:: bash
+
+      $ git commit -a -m "your-commit-message-here"
+
    - Finally, push it to your GitHub fork, run:
 
      .. code-block:: bash
@@ -124,25 +113,23 @@ Here's how to make a one-off code change.
 
 5. **Address review comments until all reviewers give LGTM ('looks good to me').**
 
-   - When your reviewer has reviewed the code, you'll get a notification. You'll need to respond in two ways:
+   - When your reviewer has reviewed the code, you'll get an email. You'll need to respond in two ways:
 
-     - Make a new commit addressing the comments you agree with, and push it to the same branch. Ideally, the commit message would explain what the commit does (e.g. "Fix lint error"), but if there are lots of disparate review comments, it's fine to refer to the original commit message and add something like "(address review comments)".
+       - Make a new commit addressing the comments you agree with, and push it to the same branch. Ideally, the commit message would explain what the commit does (e.g. "Fix lint error"), but if there are lots of disparate review comments, it's fine to refer to the original commit message and add something like "(address review comments)".
 
-     - In order to keep the commit history intact, please avoid squashing or amending history and then force-pushing to the PR. Reviewers often want to look at individual commits.
-
-     - In addition, please reply to each comment. Each reply should be either "Done" or a response explaining why the corresponding suggestion wasn't implemented. All comments must be resolved before LGTM can be given.
+       - In addition, please reply to each comment. Each reply should be either "Done" or a response explaining why the corresponding suggestion wasn't implemented. All comments must be resolved before LGTM can be given.
 
    - Resolve any merge conflicts that arise. To resolve conflicts between 'your-branch-name' (in your fork) and 'master' (in the ``python-telegram-bot`` repository), run:
 
      .. code-block:: bash
 
-        $ git checkout your-branch-name
-        $ git fetch upstream
-        $ git merge upstream/master
-        $ ...[fix the conflicts]...
-        $ ...[make sure the tests pass before committing]...
-        $ git commit -a
-        $ git push origin your-branch-name
+      	$ git checkout your-branch-name
+      	$ git fetch upstream
+	$ git merge upstream/master
+      	$ ...[fix the conflicts]...
+      	$ ...[make sure the tests pass before committing]...
+      	$ git commit -a
+      	$ git push origin your-branch-name
 
    - At the end, the reviewer will merge the pull request.
 
@@ -155,111 +142,21 @@ Here's how to make a one-off code change.
 
 7. **Celebrate.** Congratulations, you have contributed to ``python-telegram-bot``!
 
-Check-list for PRs
-------------------
-
-This checklist is a non-exhaustive reminder of things that should be done before a PR is merged, both for you as contributor and for the maintainers.
-Feel free to copy (parts of) the checklist to the PR description to remind you or the maintainers of open points or if you have questions on anything.
-
-.. code-block:: markdown
-
-    ## Check-list for PRs
-
-    - [ ] Added `.. versionadded:: NEXT.VERSION`, ``.. versionchanged:: NEXT.VERSION``, ``.. deprecated:: NEXT.VERSION`` or ``.. versionremoved:: NEXT.VERSION` to the docstrings for user facing changes (for methods/class descriptions, arguments and attributes)
-    - [ ] Created new or adapted existing unit tests
-    - [ ] Documented code changes according to the [CSI standard](https://standards.mousepawmedia.com/en/stable/csi.html)
-    - [ ] Added myself alphabetically to `AUTHORS.rst` (optional)
-    - [ ] Added new classes & modules to the docs and all suitable ``__all__`` s
-    - [ ] Checked the [Stability Policy](https://docs.python-telegram-bot.org/stability_policy.html) in case of deprecations or changes to documented behavior
-
-    **If the PR contains API changes (otherwise, you can ignore this passage)**
-
-    - [ ] Checked the Bot API specific sections of the [Stability Policy](https://docs.python-telegram-bot.org/stability_policy.html)
-    - [ ] Created a PR to remove functionality deprecated in the previous Bot API release ([see here](https://docs.python-telegram-bot.org/en/stable/stability_policy.html#case-2))
-
-    - New Classes
-
-        - [ ] Added `self._id_attrs` and corresponding documentation
-        - [ ] `__init__` accepts `api_kwargs` as keyword-only
-
-    - Added New Shortcuts
-
-        - [ ] In [`telegram.Chat`](https://python-telegram-bot.readthedocs.io/en/stable/telegram.chat.html) \& [`telegram.User`](https://python-telegram-bot.readthedocs.io/en/stable/telegram.user.html) for all methods that accept `chat/user_id`
-        - [ ] In [`telegram.Message`](https://python-telegram-bot.readthedocs.io/en/stable/telegram.message.html) for all methods that accept `chat_id` and `message_id`
-        - [ ] For new `telegram.Message` shortcuts: Added `quote` argument if methods accept `reply_to_message_id`
-        - [ ] In [`telegram.CallbackQuery`](https://python-telegram-bot.readthedocs.io/en/stable/telegram.callbackquery.html) for all methods that accept either `chat_id` and `message_id` or `inline_message_id`
-
-    - If Relevant
-
-        - [ ] Added new constants at `telegram.constants` and shortcuts to them as class variables
-        - [ ] Linked new and existing constants in docstrings instead of hard-coded numbers and strings
-        - [ ] Added new message types to `telegram.Message.effective_attachment`
-        - [ ] Added new handlers for new update types
-            - [ ] Added the handlers to the warning loop in the [`telegram.ext.ConversationHandler`](https://python-telegram-bot.readthedocs.io/en/stable/telegram.ext.conversationhandler.html)
-        - [ ] Added new filters for new message (sub)types
-        - [ ] Added or updated documentation for the changed class(es) and/or method(s)
-        - [ ] Added the new method(s) to `_extbot.py`
-        - [ ] Added or updated `bot_methods.rst`
-        - [ ] Updated the Bot API version number in all places: `README.rst` (including the badge) and `telegram.constants.BOT_API_VERSION_INFO`
-        - [ ] Added logic for arbitrary callback data in `telegram.ext.ExtBot` for new methods that either accept a `reply_markup` in some form or have a return type that is/contains [`telegram.Message`](https://python-telegram-bot.readthedocs.io/en/stable/telegram.message.html)
-
-Documenting
-===========
-
-The documentation of this project is separated in two sections: User facing and dev facing.
-
-User facing docs are hosted at `RTD`_. They are the main way the users of our library are supposed to get information about the objects. They don't care about the internals, they just want to know
-what they have to pass to make it work, what it actually does. You can/should provide examples for non obvious cases (like the Filter module), and notes/warnings.
-
-Dev facing, on the other side, is for the devs/maintainers of this project. These
-doc strings don't have a separate documentation site they generate, instead, they document the actual code.
-
-User facing documentation
--------------------------
-We use `sphinx`_ to generate static HTML docs. To build them, first make sure you're running Python 3.10 or above and have the required dependencies installed as explained above.
-Then, run the following from the PTB root directory:
-
-.. code-block:: bash
-
-   $ make -C docs html
-
-or, if you don't have ``make`` available (e.g. on Windows):
-
-.. code-block:: bash
-
-   $ sphinx-build docs/source docs/build/html
-
-Once the process terminates, you can view the built documentation by opening ``docs/build/html/index.html`` with a browser.
-
-- Add ``.. versionadded:: NEXT.VERSION``, ``.. versionchanged:: NEXT.VERSION`` or ``.. deprecated:: NEXT.VERSION`` to the associated documentation of your changes, depending on what kind of change you made. This only applies if the change you made is visible to an end user. The directives should be added to class/method descriptions if their general behaviour changed and to the description of all arguments & attributes that changed.
-
-Dev facing documentation
-------------------------
-We adhere to the `CSI`_ standard. This documentation is not fully implemented in the project, yet, but new code changes should comply with the `CSI` standard.
-The idea behind this is to make it very easy for you/a random maintainer or even a totally foreign person to drop anywhere into the code and more or less immediately understand what a particular line does. This will make it easier
-for new to make relevant changes if said lines don't do what they are supposed to.
-
-
-
 Style commandments
-==================
+---------------------
 
-Assert comparison order
------------------------
+Specific commandments
+#####################
 
-Assert statements should compare in **actual** == **expected** order.
-For example (assuming ``test_call`` is the thing being tested):
+- Avoid using "double quotes" where you can reasonably use 'single quotes'.
 
-.. code-block:: python
+AssertEqual argument order
+######################
 
-    # GOOD
-    assert test_call() == 5
-
-    # BAD
-    assert 5 == test_call()
+- assertEqual method's arguments should be in ('actual', 'expected') order.
 
 Properly calling callables
---------------------------
+#######################
 
 Methods, functions and classes can specify optional parameters (with default
 values) using Python's keyword arg syntax. When providing a value to such a
@@ -276,22 +173,29 @@ callable we prefer that the call also uses keyword arg syntax. For example:
 This gives us the flexibility to re-order arguments and more importantly
 to add new required arguments. It's also more explicit and easier to read.
 
+Properly defining optional arguments
+########################
 
-.. _`Code of Conduct`: https://policies.python.org/python.org/code-of-conduct/
+It's always good to not initialize optional arguments at class creation,
+instead use ``**kwargs`` to get them. It's well known Telegram API can
+change without notice, in that case if a new argument is added it won't
+break the API classes. For example:
+
+.. code-block:: python
+
+    # GOOD
+    def __init__(self, id, name, **kwargs):
+       self.last_name = kwargs.get('last_name', '')
+
+    # BAD
+    def __init__(self, id, name, last_name=''):
+       self.last_name = last_name
+
+
+.. _`Code of Conduct`: https://www.python.org/psf/codeofconduct/
 .. _`issue tracker`: https://github.com/python-telegram-bot/python-telegram-bot/issues
-.. _`Telegram group`: https://telegram.me/pythontelegrambotgroup
-.. _`PEP 8 Style Guide`: https://peps.python.org/pep-0008/
-.. _`sphinx`: https://www.sphinx-doc.org/en/master
-.. _`Google Python Style Guide`: https://google.github.io/styleguide/pyguide.html
-.. _`Google Python Style Docstrings`: https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html
-.. _AUTHORS.rst: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/AUTHORS.rst
-.. _`MyPy`: https://mypy.readthedocs.io/en/stable/index.html
-.. _`here`: https://mypy.readthedocs.io/en/stable/cheat_sheet_py3.html
-.. _`pre-commit config file`: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/.pre-commit-config.yaml
-.. _`Ruff`: https://docs.astral.sh/ruff/
-.. _`RTD`: https://docs.python-telegram-bot.org/
-.. _`RTD build`: https://docs.python-telegram-bot.org/en/doc-fixes
-.. _`CSI`: https://standards.mousepawmedia.com/en/stable/csi.html
-.. _`section`: #documenting
-.. _`testing page`: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/tests/README.rst
-.. _`below`: #check-list-for-prs
+.. _`developers' mailing list`: mailto:devs@python-telegram-bot.org
+.. _`PEP 8 Style Guide`: https://www.python.org/dev/peps/pep-0008/
+.. _`Google Python Style Guide`: https://google-styleguide.googlecode.com/svn/trunk/pyguide.html
+.. _`Google Python Style Docstrings`: http://sphinx-doc.org/latest/ext/example_google.html
+.. _AUTHORS.rst: ../AUTHORS.rst

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,31 @@
+<!--
+Thanks for reporting issues of python-telegram-bot!
+To make it easier for us to help you please enter detailed information below.
+
+Please note, we only support the latest version of python-telegram-bot and
+master branch. Please make sure to upgrade & recreate the issue on the latest
+version prior to opening an issue.
+-->
+### Steps to reproduce
+1.
+
+2.
+
+3.
+
+### Expected behaviour
+Tell us what should happen
+
+### Actual behaviour
+Tell us what happens instead
+
+### Configuration
+**Operating System:**
+
+
+**Version of Python, python-telegram-bot & dependencies:**
+
+``$ python -m telegram``
+
+### Logs
+Insert logs here (if necessary)

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -1,76 +0,0 @@
-name: Bug Report
-description: Create a report to help us improve
-labels: ["📋 triage"]
-type: '🐛 bug'
-
-body:
-  - type: markdown
-    attributes:
-      value: |
-        Thanks for reporting issues of python-telegram-bot!
-
-        Use this template to notify us if you found a bug.
-
-        To make it easier for us to help you please enter detailed information below.
-
-        Please note, we only support the latest version of python-telegram-bot and master branch. Please make sure to upgrade & recreate the issue on the latest version prior to opening an issue.
-      
-  - type: textarea
-    id: steps-to-reproduce
-    attributes:
-      label: Steps to Reproduce
-      value: |
-        1. 
-        2.
-        3.
-    validations:
-      required: true
-        
-  - type: textarea
-    id: expected-behaviour
-    attributes:
-      label: Expected behaviour
-      description: Tell us what should happen
-    validations:
-      required: true
-      
-  - type: textarea
-    id: actual-behaviour
-    attributes:
-      label: Actual behaviour
-      description: Tell us what happens instead
-    validations:
-      required: true
-      
-  - type: markdown
-    attributes:
-      value: "### Configuration"
-
-  - type: input
-    id: operating-system
-    attributes:
-      label: Operating System
-    validations: 
-      required: true
-
-  - type: textarea
-    id: versions
-    attributes:
-      label: Version of Python, python-telegram-bot & dependencies
-      description: Paste the output of `$ python -m telegram` here. This will be automatically formatted into code, so no need for backticks.
-      render: shell
-    validations: 
-      required: true
-      
-  - type: textarea
-    id: logs
-    attributes:
-      label: Relevant log output
-      description: Insert logs here (if necessary). This will be automatically formatted into code, so no need for backticks.
-      render: python
-
-  - type: textarea
-    id: additional-context
-    attributes:
-      label: Additional Context
-      description: You may provide any other additional context to the bug here.

.github/ISSUE_TEMPLATE/config.yml

@@ -1,8 +0,0 @@
-blank_issues_enabled: false
-contact_links:
-  - name: Telegram Group
-    url: https://telegram.me/pythontelegrambotgroup
-    about: Questions asked on the group usually get answered faster.
-  - name: GitHub Discussions
-    url: https://github.com/python-telegram-bot/python-telegram-bot/discussions
-    about: For getting answers to usage on GitHub, Discussions is even better than this bug tracker :)

.github/ISSUE_TEMPLATE/feature-request.yml

@@ -1,37 +0,0 @@
-name: Feature Request
-description: Suggest an idea for this project
-labels: ["📋 triage"]
-type: '💡 feature'
-
-body:
-  - type: textarea
-    id: related-problem
-    attributes:
-      label: "What kind of feature are you missing? Where do you notice a shortcoming of PTB?"
-      description: "A clear and concise description of what the problem is."
-      placeholder: "Example: I want to do X, but there is no way to do it."
-    validations:
-      required: true
-      
-  - type: textarea
-    id: solution
-    attributes:
-      label: "Describe the solution you'd like"
-      description: "A clear and concise description of what you want to happen."
-      placeholder: "Example: I think it would be nice if you would add feature Y so I can do X."
-    validations:
-      required: true
-        
-  - type: textarea
-    id: alternatives
-    attributes:
-      label: "Describe alternatives you've considered"
-      description: "A clear and concise description of any alternative solutions or features you've considered."
-      placeholder: "Example: I considered Z to be able to do X, but that didn't work because..."
-      
-  - type: textarea
-    id: additional-context
-    attributes:
-      label: "Additional context"
-      description: "Add any other context or screenshots about the feature request here."
-      placeholder: "Example: Here's a photo of my cat!"

.github/ISSUE_TEMPLATE/question.yml

@@ -1,70 +0,0 @@
-name: Question
-description: Get help with errors or general questions
-labels: ["question"]
-type: '❔ question'
-
-body:
-  - type: markdown
-    attributes:
-      value: |
-        Hey there, you have a question? We are happy to answer. Please make sure no similar question was opened already.
-
-        To make it easier for us to help you, please read this [article](https://github.com/python-telegram-bot/python-telegram-bot/wiki/Ask-Right).
-
-        Please mind that there is also a users' [Telegram group](https://t.me/pythontelegrambotgroup) for questions about the library. Questions asked there might be answered quicker than here. Moreover, [GitHub Discussions](https://github.com/python-telegram-bot/python-telegram-bot/discussions) offer a slightly better format to discuss usage questions.
-        
-        If you have asked the same question elsewhere (e.g. the [Telegram group](https://t.me/pythontelegrambotgroup) or [StackOverflow](https://stackoverflow.com/questions/tagged/python-telegram-bot)), provide a link to that thread.
-
-  - type: textarea
-    id: issue-faced
-    attributes:
-      label: "Issue I am facing"
-      description: "Please describe the issue here in as much detail as possible"
-    validations:
-      required: true
-      
-  - type: textarea
-    id: traceback
-    attributes:
-      label: "Traceback to the issue"
-      description: "If you are facing a specific error message, please paste the traceback here. This will be automatically formatted into python code, so no need for backticks."
-      placeholder: |
-        Traceback (most recent call last):
-          File "/home/bot.py", line 1, in main
-            foo = bar()
-          ...
-        telegram.error.BadRequest: Traceback not found
-      render: python
-        
-  - type: textarea
-    id: related-code
-    attributes:
-      label: "Related part of your code"
-      description: "This will be automatically formatted into code (python), so no need for backticks."
-      placeholder: |
-        logging.basicConfig(
-            format="%(asctime)s - %(name)s - %(levelname)s - %(message)s", level=logging.INFO
-        )
-
-        logger = logging.getLogger(__name__)
-      render: python
-
-  - type: markdown
-    attributes:
-      value: "### Configuration"
-
-  - type: input
-    id: operating-system
-    attributes:
-      label: Operating System
-    validations: 
-      required: true
-      
-  - type: textarea
-    id: versions
-    attributes:
-      label: Version of Python, python-telegram-bot & dependencies
-      description: Paste the output of `$ python -m telegram` here. This will be automatically formatted into code, so no need for backticks.
-      render: shell
-    validations: 
-      required: true

.github/copilot-instructions.md

@@ -1,40 +0,0 @@
-This is a python project which is a wrapper for the Telegram Bot API. Please read the contributing
-guidelines mentioned in .github/CONTRIBUTING.rst to know how to contribute to this project. The 
-README.rst file lists the features and usage of the project.
-
-### Development Environment:
-
-Your development environment is set up using `uv`, a tool for managing Python environments and dependencies.
-Your environment has all extra dependencies and groups installed, on Python 3.13. Please continue using `uv` for managing your development environment,
-and for any scripts or tools you need to run.
-
-Some example commands on `uv`:
-- `uv sync --all-extras --all-groups --locked` to install all dependencies and groups required by the project.
-- `uv run -p 3.14 --all-groups --all-extras --locked tests/` to run tests on a specific Python version. Please use the `-p` flag often.
-- `uv pip install <package>` to install a package in the current environment.
-
-If uv is somehow not available, you can install it using `pip install uv`.
-
-### Repository Structure:
-
-The repository follows a standard structure for Python projects. Here are some key directories and files:
-
-- `src/`: This directory contains the main source code for the project.
-- `tests/`: This directory contains test cases for the project.
-- `pyproject.toml`: This file contains the project metadata and dependencies.
-- `.github/`: This directory contains GitHub-specific files, including workflows and issue templates.
-
-
-### Things to keep in mind while coding:
-
-- Ensure that your code is properly and fully typed. All your code should be compatible from
-  Python 3.9 to 3.14. Don't use the `typing_extensions` module.
-- Read the stability guide mentioned at docs/source/stability_policy.rst to understand if your changes
-  are breaking or incompatible.
-- Try to make sure your code is asyncio-friendly and thread-safe.
-- Run `uv run prek` to run pre-commit hooks before committing your changes, but after `git add`ing them.
-- Make sure you always test your changes. Either update or write new tests in the `tests/` directory.
-
-### Pull Requests:
-
-When you create a pull request, please also add the appropriate labels to it.

.github/pull_request_template.md

@@ -1,6 +0,0 @@
-<!--
-Hey! You're PRing? Cool!
-Please be sure to check out our contribution guide (https://github.com/python-telegram-bot/python-telegram-bot/blob/master/.github/CONTRIBUTING.rst).
-Especially, please have a look at the check list for PRs (https://github.com/python-telegram-bot/python-telegram-bot/blob/master/.github/CONTRIBUTING.rst#check-list-for-prs). Feel free to copy (parts of) the checklist to the PR description to remind you or the maintainers of open points or if you have questions on anything.
--->
-

.github/renovate.json5

@@ -1,88 +0,0 @@
-{
-  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
-  "extends": [ // See what config:best-practices does: https://docs.renovatebot.com/presets-config/#configbest-practices
-    "config:best-practices",
-    // Opt-in to updating the pre-commit-config.yaml file too:
-    ":enablePreCommit",
-    ":prConcurrentLimitNone"  // No limits on the number of open PRs.
-  ],
-
-  // Add pull request labels:
-  "labels": ["⚙️ ci-cd"],
-
-  // Bump even patch versions:
-  "bumpVersion": "patch",
-
-  // Let Renovate decide how to update. See docs: https://docs.renovatebot.com/configuration-options/#rangestrategy
-  "rangeStrategy": "auto",
-
-  // Update the lock files:
-  "lockFileMaintenance": {
-    "enabled": true,
-    "schedule": ["* 0-3 1 * *"],  // https://docs.renovatebot.com/presets-schedule/#schedulemonthly
-    "automerge": true
-  },
-
-  // Enable automerge globally:
-  "automerge": true,
-
-  // Group package updates together:
-  "packageRules": [
-    // Linting dependencies in pyproject.toml in sync with the pre-commit-config hooks:
-    // Unfortunately it seems we need to do this for every dependency group (https://github.com/python-telegram-bot/python-telegram-bot/pull/4887#discussion_r2272025832):
-    {
-      "description": "Group Ruff updates together",
-      "matchPackageNames": ["ruff", "astral-sh/ruff-pre-commit"],
-      "groupName": "Ruff"
-    },
-    {
-      "description": "Group mypy updates together",
-      "matchPackageNames": ["mypy", "pre-commit/mirrors-mypy"],
-      "groupName": "Mypy"
-    },
-    {
-      "description": "Group pylint updates together",
-      "matchPackageNames": ["pylint", "PyCQA/pylint"],
-      "groupName": "Pylint"
-    },
-    {
-      "description": "Group chango updates together",
-      "matchPackageNames": ["chango", "Bibo-Joshi/chango"],
-      "groupName": "Chango"
-    },
-
-    // Don't automerge major updates for project dependencies:
-    {
-      "matchUpdateTypes": ["major"],
-      "matchDepTypes": ["project.dependencies", "project.optional-dependencies"],
-      "automerge": false
-    },
-
-    // Apply the "dependencies" label to all updates of optional/required dependencies:
-    {
-      "matchDepTypes": ["project.optional-dependencies", "project.dependencies"],
-      "labels": ["⚙️ dependencies"]
-    },
-
-    // Workflow and dev-dependencies update once a month
-    // https://docs.renovatebot.com/presets-schedule/#schedulemonthly
-    {
-      "matchFileNames": [".github/workflows/**"],
-      "schedule": ["* 0-3 1 * *"]
-    },
-    {
-      "matchDepTypes": ["dependency-groups"],
-      "schedule": ["* 0-3 1 * *"]
-    }
-  ],
-
-  // Increase the number of PR's Renovate can create in a hour. Default is 2.
-  "prHourlyLimit": 5,
-
-  // Temporarily disabled:
-  "ignoreDeps": ["pytest-asyncio"],
-
-  // schedule to allow PR's from Renovate:
-  "schedule": ["* * * * 0"]  // Every Sunday
-
-}

.github/workflows/assets/release_template.html

@@ -1,5 +0,0 @@
-<b>We've just released {tag}</b>.
-Thank you to everyone who contributed to this release.
-As usual, upgrade using <code>pip install -U python-telegram-bot</code>.
-
-The release notes can be found <a href="https://docs.python-telegram-bot.org/en/{tag}/changelog.html">here</a>.

.github/workflows/chango.yml

@@ -1,69 +0,0 @@
-name: Chango
-on:
-  pull_request:
-    types:
-      - opened
-      - reopened
-      - synchronize
-
-permissions: {}
-
-jobs:
-  create-chango-fragment:
-    permissions:
-      # Give the default GITHUB_TOKEN write permission to commit and push the
-      # added or changed files to the repository.
-      contents: write
-    name: Create chango Fragment
-    runs-on: ubuntu-latest
-    outputs:
-      IS_RELEASE_PR: ${{ steps.check_title.outputs.IS_RELEASE_PR }}
-
-    steps:
-      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
-        with:
-          # needed for commit and push step at the end
-          persist-credentials: true
-      - name: Check PR Title
-        id: check_title
-        run: | # zizmor: ignore[template-injection]
-          if [[ "$(echo "${{ github.event.pull_request.title }}" | tr '[:upper:]' '[:lower:]')" =~ ^bump\ version\ to\ .* ]]; then
-            echo "COMMIT_AND_PUSH=false" >> $GITHUB_OUTPUT
-            echo "IS_RELEASE_PR=true" >> $GITHUB_OUTPUT
-          else
-            echo "COMMIT_AND_PUSH=true" >> $GITHUB_OUTPUT
-            echo "IS_RELEASE_PR=false" >> $GITHUB_OUTPUT
-          fi
-
-      # Create the new fragment
-      - uses: Bibo-Joshi/chango@bc58df46ef3ba8f15b8d744929998b7ae8a222d4 # 0.6.1
-        with:
-          # passing this custom token has two purposes
-          # 1. it allows us to fetch info about issue types
-          # 2. it ensures that the push will also re-trigger workflows
-          github-token: ${{ secrets.CHANGO_PAT }}
-          query-issue-types: true
-          commit-and-push: ${{ steps.check_title.outputs.COMMIT_AND_PUSH }}
-
-      # Run `chango release` if applicable - needs some additional setup.
-      - name: Set up Python
-        if: steps.check_title.outputs.IS_RELEASE_PR == 'true'
-        uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
-        with:
-          python-version: "3.x"
-
-      - name: Do Release
-        if: steps.check_title.outputs.IS_RELEASE_PR == 'true'
-        run: |
-          cd ./target-repo
-          git add changes/unreleased/*
-          pip install . --group docs
-          VERSION_TAG=$(python -c "from telegram import __version__; print(f'{__version__}')")
-          chango release --uid $VERSION_TAG
-
-      - name: Commit & Push
-        if: steps.check_title.outputs.IS_RELEASE_PR == 'true'
-        uses: stefanzweifel/git-auto-commit-action@04702edda442b2e678b25b537cec683a1493fcb9 # v7.1.0
-        with:
-          commit_message: "Do chango Release"
-          repository: ./target-repo

.github/workflows/copilot-setup-steps.yml

@@ -1,42 +0,0 @@
-# This file is for the copilot agent on Github. This helps to set up the development environment
-# See the docs here: https://docs.github.com/en/enterprise-cloud@latest/copilot/how-tos/use-copilot-agents/coding-agent/customize-the-agent-environment#preinstalling-tools-or-dependencies-in-copilots-environment
-name: "Copilot Setup Steps"
-
-# Automatically run the setup steps when they are changed to allow for easy validation, and
-# allow manual testing through the repository's "Actions" tab
-on:
-  workflow_dispatch:
-  pull_request:
-    paths:
-      - .github/workflows/copilot-setup-steps.yml
-
-jobs:
-  # The job MUST be called `copilot-setup-steps` or it will not be picked up by Copilot.
-  copilot-setup-steps:
-    runs-on: ubuntu-latest
-
-    # Set the permissions to the lowest permissions possible needed for your steps.
-    # Copilot will be given its own token for its operations.
-    permissions:
-      # If you want to clone the repository as part of your setup steps, for example to install dependencies, you'll need the `contents: read` permission. If you don't clone the repository in your setup steps, Copilot will do this for you automatically after the steps complete.
-      contents: read
-      pull-requests: write  # So copilot can add labels to the PR
-
-    # You can define any steps you want, and they will run before the agent starts.
-    # If you do not check out your code, Copilot will do this for you.
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
-        with:
-          persist-credentials: false
-
-      - name: Install uv
-        uses: astral-sh/setup-uv@e06108dd0aef18192324c70427afc47652e63a82 # v7.5.0
-        with:
-          # Install a specific version of uv.
-          version: "0.10.10"
-          # Install 3.13:
-          python-version: 3.13
-
-      - name: Install the project
-        run: uv sync --all-extras --all-groups --locked

.github/workflows/docs-admonitions.yml

@@ -1,42 +0,0 @@
-name: Test Admonitions Generation
-on:
-  pull_request:
-    types: [synchronize, reopened, ready_for_review]
-    paths:
-      - src/telegram/**
-      - docs/**
-      - .github/workflows/docs-admonitions.yml
-  push:
-    branches:
-      - master
-
-permissions: {}
-
-jobs:
-  test-admonitions:
-    name: Test Admonitions Generation
-    runs-on: ${{matrix.os}}
-    permissions:
-      # for uploading artifacts
-      actions: write
-    strategy:
-      matrix:
-        python-version: ['3.12']
-        os: [ubuntu-latest]
-      fail-fast: False
-    steps:
-      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
-        with:
-          persist-credentials: false
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
-        with:
-          python-version: ${{ matrix.python-version }}
-          cache: 'pip'
-          cache-dependency-path: 'pyproject.toml'
-      - name: Install dependencies
-        run: |
-          python -W ignore -m pip install --upgrade pip
-          python -W ignore -m pip install .[all] --group all
-      - name: Test autogeneration of admonitions
-        run: pytest -v --tb=short tests/docs/admonition_inserter.py

.github/workflows/docs-linkcheck.yml

@@ -1,41 +0,0 @@
-name: Check Links in Documentation
-on:
-  schedule:
-    # First day of month at 05:46 in every 2nd month
-    - cron: '46 5 1 */2 *'
-  pull_request:
-    paths:
-      - .github/workflows/docs-linkcheck.yml
-
-permissions: {}
-
-jobs:
-  test-sphinx-build:
-    name: test-sphinx-linkcheck
-    runs-on: ${{matrix.os}}
-    strategy:
-      matrix:
-        python-version: ['3.12']
-        os: [ubuntu-latest]
-      fail-fast: False
-    steps:
-      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
-        with:
-          persist-credentials: false
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
-        with:
-          python-version: ${{ matrix.python-version }}
-      - name: Install dependencies
-        run: |
-          python -W ignore -m pip install --upgrade pip
-          python -W ignore -m pip install .[all] --group all
-      - name: Check Links
-        run: sphinx-build docs/source docs/build/html --keep-going -j auto -b linkcheck
-      - name: Upload linkcheck output
-        # Run also if the previous steps failed
-        if: always()
-        uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0
-        with:
-          name: linkcheck-output
-          path: docs/build/html/output.*

.github/workflows/gha_security.yml

@@ -1,33 +0,0 @@
-name: GitHub Actions Security Analysis
-
-on:
-  push:
-    branches:
-      - master
-  pull_request:
-
-permissions: {}
-
-jobs:
-  zizmor:
-    name: Security Analysis with zizmor
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-      security-events: write
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
-        with:
-          persist-credentials: false
-      - name: Install the latest version of uv
-        uses: astral-sh/setup-uv@e06108dd0aef18192324c70427afc47652e63a82 # v7.5.0
-      - name: Run zizmor
-        run: uvx zizmor --persona=pedantic --format sarif . > results.sarif
-        env:
-          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      - name: Upload SARIF file
-        uses: github/codeql-action/upload-sarif@fdbfb4d2750291e159f0156def62b853c2798ca2 # v4.31.5
-        with:
-          sarif_file: results.sarif
-          category: zizmor

.github/workflows/lock.yml

@@ -1,25 +0,0 @@
-name: 'Lock Closed Threads'
-
-on:
-  schedule:
-    - cron: '8 4 * * *'
-
-permissions: {}
-
-jobs:
-  lock:
-    runs-on: ubuntu-latest
-    permissions:
-      # For locking the threads
-      issues: write
-      pull-requests: write
-    steps:
-      - uses: dessant/lock-threads@1bf7ec25051fe7c00bdd17e6a7cf3d7bfb7dc771 # v5.0.1
-        with:
-          github-token: ${{ github.token }}
-          issue-inactive-days: '7'
-          issue-lock-reason: ''
-          pr-inactive-days: '7'
-          pr-lock-reason: ''
-          # Don't lock Discussions
-          process-only: 'issues, prs'

.github/workflows/prek.yml

@@ -1,26 +0,0 @@
-name: Prek checks
-permissions:
-  contents: read  # Needed to see what files to run pre-commit on
-
-on:
-  pull_request:
-    branches:
-      - '**'  # Matches all branch names, for PRs
-  push:
-    branches:
-      - 'master'  # Run tests on master branch
-
-# Cancel any in-progress runs of this workflow for the same PR or branch when a new commit is pushed.
-concurrency:
-  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
-  cancel-in-progress: true
-
-jobs:
-  prek:
-    name: prek
-    runs-on: ubuntu-slim
-    steps:
-      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
-        with:
-          persist-credentials: false
-      - uses: j178/prek-action@0bb87d7f00b0c99306c8bcb8b8beba1eb581c037 # v1.1.1

.github/workflows/release_pypi.yml

@@ -1,172 +0,0 @@
-name: Publish to PyPI
-
-on:
-  # manually trigger the workflow
-  workflow_dispatch:
-
-permissions: {}
-
-jobs:
-  build:
-    name: Build Distribution
-    runs-on: ubuntu-latest
-    outputs:
-      TAG: ${{ steps.get_tag.outputs.TAG }}
-    permissions:
-      # for uploading artifacts
-      actions: write
-
-    steps:
-      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
-        with:
-          persist-credentials: false
-      - name: Set up Python
-        uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
-        with:
-          python-version: "3.x"
-      - name: Install pypa/build
-        run: >-
-          python3 -m pip install build --user
-      - name: Build a binary wheel and a source tarball
-        run: python3 -m build
-      - name: Store the distribution packages
-        uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0
-        with:
-          name: python-package-distributions
-          path: dist/
-      - name: Get Tag Name
-        id: get_tag
-        run: |
-          pip install .
-          TAG=$(python -c "from telegram import __version__; print(f'v{__version__}')")
-          echo "TAG=$TAG" >> $GITHUB_OUTPUT
-
-  publish-to-pypi:
-    name: Publish to PyPI
-    needs:
-      - build
-    runs-on: ubuntu-latest
-    environment:
-      name: release_pypi
-      url: https://pypi.org/p/python-telegram-bot
-    permissions:
-      id-token: write  # IMPORTANT: mandatory for trusted publishing
-      actions: read  # for downloading artifacts
-
-    steps:
-      - name: Download all the dists
-        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
-        with:
-          name: python-package-distributions
-          path: dist/
-      - name: Publish to PyPI
-        uses: pypa/gh-action-pypi-publish@ed0c53931b1dc9bd32cbe73a98c7f6766f8a527e # v1.13.0
-
-  compute-signatures:
-    name: Compute SHA1 Sums and Sign with Sigstore
-    runs-on: ubuntu-latest
-    needs:
-      - publish-to-pypi
-
-    permissions:
-      id-token: write  # IMPORTANT: mandatory for sigstore
-      actions: write  # for up/downloading artifacts
-
-    steps:
-      - name: Download all the dists
-        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
-        with:
-          name: python-package-distributions
-          path: dist/
-      - name: Compute SHA1 Sums
-        run: |
-          # Compute SHA1 sum of the distribution packages and save it to a file with the same name,
-          # but with .sha1 extension
-          for file in dist/*; do
-              sha1sum $file > $file.sha1
-          done
-      - name: Sign the dists with Sigstore
-        uses: sigstore/gh-action-sigstore-python@a5caf349bc536fbef3668a10ed7f5cd309a4b53d # v3.2.0
-        with:
-          inputs: >-
-            ./dist/*.tar.gz
-            ./dist/*.whl
-      - name: Store the distribution packages and signatures
-        uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0
-        with:
-          name: python-package-distributions-and-signatures
-          path: dist/
-
-  github-release:
-    name: Upload to GitHub Release
-    needs:
-      - build
-      - compute-signatures
-
-    runs-on: ubuntu-latest
-
-    permissions:
-      contents: write  # IMPORTANT: mandatory for making GitHub Releases
-      actions: read  # for downloading artifacts
-
-    steps:
-      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
-        with:
-          persist-credentials: false
-      - name: Download all the dists
-        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
-        with:
-          name: python-package-distributions-and-signatures
-          path: dist/
-      - name: Create GitHub Release
-        env:
-          GITHUB_TOKEN: ${{ github.token }}
-          TAG: ${{ needs.build.outputs.TAG }}
-        # Create a tag and a GitHub Release. The description is filled by the static template, we
-        # just insert the correct tag in the template.
-        run: >-
-          sed "s/{tag}/$TAG/g" .github/workflows/assets/release_template.html |
-          gh release create
-          "$TAG"
-          --repo '${{ github.repository }}'
-          --notes-file -
-      - name: Upload artifact signatures to GitHub Release
-        env:
-          GITHUB_TOKEN: ${{ github.token }}
-          TAG: ${{ needs.build.outputs.TAG }}
-        # Upload to GitHub Release using the `gh` CLI.
-        # `dist/` contains the built packages, and the
-        # sigstore-produced signatures and certificates.
-        run: >-
-          gh release upload
-          "$TAG" dist/**
-          --repo '${{ github.repository }}'
-
-  telegram-channel:
-    name: Publish to Telegram Channel
-    needs:
-      # required to have the output available for the env var
-      - build
-      - github-release
-
-    runs-on: ubuntu-latest
-    environment:
-      name: release_pypi
-    permissions: {}
-
-    steps:
-      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
-        with:
-          persist-credentials: false
-      - name: Publish to Telegram Channel
-        env:
-          TAG: ${{ needs.build.outputs.TAG }}
-          # This secret is configured only for the `pypi-release` branch
-          BOT_TOKEN: ${{ secrets.CHANNEL_BOT_TOKEN }}
-        run: >-
-          sed "s/{tag}/$TAG/g" .github/workflows/assets/release_template.html |
-          curl
-          -X POST "https://api.telegram.org/bot$BOT_TOKEN/sendMessage"
-          -d "chat_id=@pythontelegrambotchannel"
-          -d "parse_mode=HTML"
-          --data-urlencode "text@-"

.github/workflows/release_test_pypi.yml

@@ -1,146 +0,0 @@
-name: Publish to Test PyPI
-
-on:
-  # manually trigger the workflow
-  workflow_dispatch:
-
-permissions: {}
-
-jobs:
-  build:
-    name: Build Distribution
-    runs-on: ubuntu-latest
-    outputs:
-      TAG: ${{ steps.get_tag.outputs.TAG }}
-    permissions:
-      # for uploading artifacts
-      actions: write
-
-    steps:
-      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
-        with:
-          persist-credentials: false
-      - name: Set up Python
-        uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
-        with:
-          python-version: "3.x"
-      - name: Install pypa/build
-        run: >-
-          python3 -m pip install build --user
-      - name: Build a binary wheel and a source tarball
-        run: python3 -m build
-      - name: Store the distribution packages
-        uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0
-        with:
-          name: python-package-distributions
-          path: dist/
-      - name: Get Tag Name
-        id: get_tag
-        run: |
-          pip install .
-          TAG=$(python -c "from telegram import __version__; print(f'v{__version__}')")
-          echo "TAG=$TAG" >> $GITHUB_OUTPUT
-
-  publish-to-test-pypi:
-    name: Publish to Test PyPI
-    needs:
-      - build
-    runs-on: ubuntu-latest
-    environment:
-      name: release_test_pypi
-      url: https://test.pypi.org/p/python-telegram-bot
-    permissions:
-      id-token: write  # IMPORTANT: mandatory for trusted publishing
-      actions: read  # for downloading artifacts
-
-    steps:
-      - name: Download all the dists
-        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
-        with:
-          name: python-package-distributions
-          path: dist/
-      - name: Publish to Test PyPI
-        uses: pypa/gh-action-pypi-publish@ed0c53931b1dc9bd32cbe73a98c7f6766f8a527e # v1.13.0
-        with:
-          repository-url: https://test.pypi.org/legacy/
-
-  compute-signatures:
-    name: Compute SHA1 Sums and Sign with Sigstore
-    runs-on: ubuntu-latest
-    needs:
-      - publish-to-test-pypi
-
-    permissions:
-      id-token: write  # IMPORTANT: mandatory for sigstore
-      actions: write  # for up/downloading artifacts
-
-    steps:
-      - name: Download all the dists
-        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
-        with:
-          name: python-package-distributions
-          path: dist/
-      - name: Compute SHA1 Sums
-        run: |
-          # Compute SHA1 sum of the distribution packages and save it to a file with the same name,
-          # but with .sha1 extension
-          for file in dist/*; do
-              sha1sum $file > $file.sha1
-          done
-      - name: Sign the dists with Sigstore
-        uses: sigstore/gh-action-sigstore-python@a5caf349bc536fbef3668a10ed7f5cd309a4b53d # v3.2.0
-        with:
-          inputs: >-
-            ./dist/*.tar.gz
-            ./dist/*.whl
-      - name: Store the distribution packages and signatures
-        uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0
-        with:
-          name: python-package-distributions-and-signatures
-          path: dist/
-
-  github-test-release:
-    name: Upload to GitHub Release Draft
-    needs:
-      - build
-      - compute-signatures
-
-    runs-on: ubuntu-latest
-
-    permissions:
-      contents: write  # IMPORTANT: mandatory for making GitHub Releases
-      actions: read  # for downloading artifacts
-
-    steps:
-      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
-        with:
-          persist-credentials: false
-      - name: Download all the dists
-        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
-        with:
-          name: python-package-distributions-and-signatures
-          path: dist/
-      - name: Create GitHub Release
-        env:
-          GITHUB_TOKEN: ${{ github.token }}
-          TAG: ${{ needs.build.outputs.TAG }}
-        # Create a tag and a GitHub Release *draft*. The description is filled by the static
-        # template, we just insert the correct tag in the template.
-        run: >-
-          sed "s/{tag}/$TAG/g" .github/workflows/assets/release_template.html |
-          gh release create
-          "$TAG"
-          --repo '${{ github.repository }}'
-          --draft
-          --notes-file -
-      - name: Upload artifact signatures to GitHub Release
-        env:
-          GITHUB_TOKEN: ${{ github.token }}
-          TAG: ${{ needs.build.outputs.TAG }}
-        # Upload to GitHub Release using the `gh` CLI.
-        # `dist/` contains the built packages, and the
-        # sigstore-produced signatures and certificates.
-        run: >-
-          gh release upload
-          "$TAG" dist/**
-          --repo '${{ github.repository }}'

.github/workflows/stale.yml

@@ -1,24 +0,0 @@
-name: 'Mark & close stale questions'
-on:
-  schedule:
-    - cron: '42 2 * * *'
-
-permissions: {}
-
-jobs:
-  stale:
-    runs-on: ubuntu-latest
-    permissions:
-      # For adding labels and closing
-      issues: write
-    steps:
-      - uses: actions/stale@b5d41d4e1d5dceea10e7104786b73624c18a190f # v10.2.0
-        with:
-          # PRs never get stale
-          days-before-stale: 3
-          days-before-close: 2
-          days-before-pr-stale: -1
-          stale-issue-label: '📋 stale'
-          only-issue-types: '❔ question'
-          stale-issue-message: ''
-          close-issue-message: 'This issue has been automatically closed due to inactivity. Feel free to comment in order to reopen or ask again in our Telegram support group at https://t.me/pythontelegrambotgroup.'

.github/workflows/test_official.yml

@@ -1,51 +0,0 @@
-name: Bot API Tests
-on:
-  pull_request:
-    types: [synchronize, reopened, ready_for_review]
-    paths:
-      - src/telegram/**
-      - tests/**
-  push:
-    branches:
-      - master
-  schedule:
-    # Run monday and friday morning at 03:07 - odd time to spread load on GitHub Actions
-    - cron: '7 3 * * 1,5'
-
-permissions: {}
-
-jobs:
-  check-conformity:
-    name: check-conformity
-    runs-on: ${{matrix.os}}
-    strategy:
-      matrix:
-        python-version: [3.11]
-        os: [ubuntu-latest]
-      fail-fast: False
-    steps:
-      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
-        with:
-          persist-credentials: false
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
-        with:
-          python-version: ${{ matrix.python-version }}
-      - name: Install dependencies
-        run: |
-          python -W ignore -m pip install --upgrade pip
-          python -W ignore -m pip install .[all] --group tests
-      - name: Compare to official api
-        run: |
-          pytest -v tests/test_official/test_official.py --junit-xml=.test_report_official.xml
-          exit $?
-        env:
-          TEST_OFFICIAL: "true"
-        shell: bash --noprofile --norc {0}
-
-      - name: Test Summary
-        id: test_summary
-        uses: test-summary/action@31493c76ec9e7aa675f1585d3ed6f1da69269a86 # v2.4
-        if: always()  # always run, even if tests fail
-        with:
-          paths: .test_report_official.xml

.github/workflows/type_completeness.yml

@@ -1,24 +0,0 @@
-name: Check Type Completeness
-on:
-  pull_request:
-    types: [synchronize, reopened, ready_for_review]
-    paths:
-      - src/telegram/**
-      - pyproject.toml
-      - .github/workflows/type_completeness.yml
-  push:
-    branches:
-      - master
-
-permissions: {}
-
-jobs:
-  test-type-completeness:
-    name:   test-type-completeness
-    runs-on: ubuntu-latest
-    steps:
-      - uses: Bibo-Joshi/pyright-type-completeness@c85a67ff3c66f51dcbb2d06bfcf4fe83a57d69cc # 1.0.1
-        with:
-          package-name: telegram
-          python-version: 3.12
-          pyright-version: ~=1.1.367

.github/workflows/type_completeness_monthly.yml

@@ -1,35 +0,0 @@
-name: Check Type Completeness Monthly Run
-on:
-  schedule:
-    # Run first friday of the month at 03:17 - odd time to spread load on GitHub Actions
-    - cron: '17 3 1-7 * 5'
-
-permissions: {}
-
-jobs:
-  test-type-completeness:
-    name:   test-type-completeness
-    runs-on: ubuntu-latest
-    steps:
-      - uses: Bibo-Joshi/pyright-type-completeness@c85a67ff3c66f51dcbb2d06bfcf4fe83a57d69cc # 1.0.1
-        id: pyright-type-completeness
-        with:
-          package-name: telegram
-          python-version: 3.12
-          pyright-version: ~=1.1.367
-      - name: Check Output
-        uses: jannekem/run-python-script-action@bbfca66c612a28f3eeca0ae40e1f810265e2ea68 # v1.7
-        env:
-          TYPE_COMPLETENESS: ${{ steps.pyright-type-completeness.outputs.base-completeness-score }}
-        with:
-          script: |
-            import os
-            completeness = float(os.getenv("TYPE_COMPLETENESS"))
-            
-            if completeness >= 1:
-                exit(0)
-            
-            text = f"Type Completeness Decreased to {completeness}. ❌"
-            error(text)
-            set_summary(text)
-            exit(1)

.gitignore

@@ -23,11 +23,6 @@ var/
 .installed.cfg
 *.egg
 .env
-.pybuild
-debian/tmp
-debian/python3-telegram
-debian/python3-telegram-doc
-debian/.debhelper
 
 # PyInstaller
 #  Usually these files are written by a python script from a template
@@ -45,14 +40,10 @@ htmlcov/
 .coverage
 .coverage.*
 .cache
-.pytest_cache
-.mypy_cache
 nosetests.xml
 coverage.xml
 *,cover
 .coveralls.yml
-.testmondata
-.testmondata-journal
 
 # Translations
 *.mo
@@ -67,37 +58,13 @@ docs/_build/
 # PyBuilder
 target/
 .idea/
-.run/
 
 # Sublime Text 2
 *.sublime*
 
-# VS Code
-.vscode
-
 # unitests files
-game.gif
 telegram.mp3
 telegram.mp4
-telegram2.mp4
 telegram.ogg
 telegram.png
 telegram.webp
-telegram.jpg
-
-# original files from merges
-*.orig
-
-# Exclude .exrc file for Vim
-.exrc
-
-# virtual env
-venv*
-pyvenv.cfg
-Scripts/
-
-# environment manager:
-.mise.toml
-
-# Support for uv.lock will come in a future PR. See #4796
-uv.lock

.pre-commit-config.yaml

@@ -1,55 +1,18 @@
-repos:
--   repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: 'v0.15.6'
+-   repo: git://github.com/pre-commit/mirrors-yapf
+    sha: v0.11.0
     hooks:
-    # Run the linter:
-    -   id: ruff-check
-        name: ruff check
-    # Run the formatter:
-    -   id: ruff-format
-        name: ruff format
--   repo: https://github.com/PyCQA/pylint
-    rev: v4.0.5
+    -   id: yapf
+        files: ^(telegram|tests)/.*\.py$
+-   repo: git://github.com/pre-commit/pre-commit-hooks
+    sha: 18d7035de5388cc7775be57f529c154bf541aab9
+    hooks:
+    -   id: flake8
+        files: ^telegram/.*\.py$
+-   repo: git://github.com/pre-commit/mirrors-pylint
+    sha: v1.5.5
     hooks:
     -   id: pylint
-        files: ^(?!(tests|docs)).*\.py$
-        language: python
-        additional_dependencies:
-          - httpx~=0.27
-          - tornado~=6.4
-          - APScheduler>=3.10.4,<3.12.0
-          - cachetools>=7.0.0,<8.0.0
-          - aiolimiter~=1.1,<1.3
-          - . # this basically does `pip install -e .`
-        priority: 10
--   repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.19.1
-    hooks:
-    -   id: mypy
-        name: mypy-ptb
-        files: ^(?!(tests|examples|docs)).*\.py$
-        language: python
-        additional_dependencies:
-          - types-pytz
-          - types-cryptography
-          - types-cachetools
-          - httpx~=0.27
-          - tornado~=6.4
-          - APScheduler>=3.10.4,<3.12.0
-          - cachetools>=7.0.0,<8.0.0
-          - aiolimiter~=1.1,<1.3
-          - . # this basically does `pip install -e .`
-        priority: 10
-    - id: mypy
-      name: mypy-examples
-      files: ^examples/.*\.py$
-      language: python
-      args:
-        - --no-strict-optional
-        - --follow-imports=silent
-      additional_dependencies:
-        - tornado~=6.4
-        - APScheduler>=3.10.4,<3.12.0
-        - cachetools>=7.0.0,<8.0.0
-        - . # this basically does `pip install -e .`
-      priority: 10
+        files: ^telegram/.*\.py$
+        args:
+        - --errors-only
+        - --disable=no-name-in-module,import-error

.readthedocs.yml

@@ -1,65 +0,0 @@
-# .readthedocs.yaml
-# Read the Docs configuration file
-# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
-
-# Required
-version: 2
-
-# Build documentation in the docs/ directory with Sphinx
-sphinx:
-  configuration: docs/source/conf.py
-
-# Optionally build your docs in additional formats such as PDF
-formats:
-  - pdf
-
-# Optionally set the version of Python and requirements required to build your docs
-python:
-  install:
-    - method: pip
-      path: .
-
-build:
-  os: ubuntu-24.04
-  tools:
-    python: "3"  # latest stable cpython version
-  jobs:
-    install:
-      - pip install -U pip
-      - pip install .[all] --group 'docs' --group 'tests' # install most dependency groups
-
-    post_build:
-      # Based on https://github.com/readthedocs/readthedocs.org/issues/3242#issuecomment-1410321534
-      # This provides a HTML zip file for download, with the same structure as the hosted website
-      - mkdir --parents $READTHEDOCS_OUTPUT/htmlzip
-      - cp --recursive $READTHEDOCS_OUTPUT/html $READTHEDOCS_OUTPUT/$READTHEDOCS_PROJECT
-      # Hide the "other versions" dropdown. This is a workaround for those versions being shown,
-      # but not being accessible, as they are not built. Also, they hide the actual sidebar menu
-      # that is relevant only on ReadTheDocs.
-      - echo "#furo-readthedocs-versions{display:none}" >> $READTHEDOCS_OUTPUT/$READTHEDOCS_PROJECT/_static/styles/furo-extensions.css
-      - cd $READTHEDOCS_OUTPUT ; zip --recurse-path --symlinks htmlzip/$READTHEDOCS_PROJECT.zip $READTHEDOCS_PROJECT
-
-search:
-  ranking: # bump up rank of commonly searched pages: (default: 0, values range from -10 to 10)
-    telegram.bot.html: 7
-    telegram.message.html: 3
-    telegram.update.html: 3
-    telegram.user.html: 2
-    telegram.chat.html: 2
-    telegram.ext.application.html: 3
-    telegram.ext.filters.html: 3
-    telegram.ext.callbackcontext.html: 2
-    telegram.ext.inlinekeyboardbutton.html: 1
-
-    telegram.passport*.html: -7
-
-  ignore:
-    - changelog.html
-    - coc.html
-    - bot_methods.html#
-    - bot_methods.html
-    # Defaults
-    - search.html
-    - search/index.html
-    - 404.html
-    - 404/index.html'

.travis.yml

@@ -0,0 +1,18 @@
+language: python
+python:
+  - "2.7"
+  - "3.3"
+  - "3.4"
+  - "3.5"
+  - "pypy"
+  - "pypy3"
+install:
+  - pip install coveralls
+  - pip install -r requirements.txt
+  - pip install -r requirements-dev.txt
+  - if [[ $TRAVIS_PYTHON_VERSION != 'pypy'* ]]; then pip install ujson; fi
+script:
+  - nosetests -v --with-flaky --no-flaky-report --with-coverage --cover-package=telegram/
+  - if [ $TRAVIS_PYTHON_VERSION != 3.3 ] && [ $TRAVIS_PYTHON_VERSION != pypy3 ]; then pre-commit run --all-files; fi
+after_success:
+  coveralls

AUTHORS.rst

@@ -1,149 +1,35 @@
 Credits
 =======
 
-``python-telegram-bot`` was originally created by
-`Leandro Toledo <https://github.com/leandrotoledo>`_.
-The current development team includes
-
-- `Poolitzer <https://github.com/Poolitzer>`_ (maintainer)
-- `Harshil <https://github.com/harshil21>`_ (maintainer)
-- `Abdelrahman <https://github.com/aelkheir>`_
-
-Emeritus maintainers include
-`Hinrich Mahler <https://github.com/Bibo-Joshi>`_, `Jannes Höke <https://github.com/jh0ker>`_ (`@jh0ker <https://t.me/jh0ker>`_ on Telegram),
-`Noam Meltzer <https://github.com/tsnoam>`_, `Pieter Schutz <https://github.com/eldinnie>`_ and `Jasmin Bom <https://github.com/jsmnbom>`_.
+``python-telegram-bot`` is written and maintained by `Leandro Toledo <https://github.com/leandrotoledo>`_.
 
 Contributors
 ------------
 
 The following wonderful people contributed directly or indirectly to this project:
 
-- `Aditya <https://github.com/clot27>`_
-- `Abshar <https://github.com/abxhr>`_
-- `Abubakar Alaya <https://github.com/Ecode2>`_
-- `Alateas <https://github.com/alateas>`_
-- `Ales Dokshanin <https://github.com/alesdokshanin>`_
-- `Alexandre <https://github.com/xTudoS>`_
-- `Alizia <https://github.com/thefunkycat>`_
-- `Ambro17 <https://github.com/Ambro17>`_
-- `Andrej Zhilenkov <https://github.com/Andrej730>`_
-- `Anton Tagunov <https://github.com/anton-tagunov>`_
-- `Anya Marcano <https://github.com/AnyaMarcanito>`
 - `Avanatiker <https://github.com/Avanatiker>`_
 - `Balduro <https://github.com/Balduro>`_
-- `Bibo-Joshi <https://github.com/Bibo-Joshi>`_
-- `Biruk Alamirew <https://github.com/BAcode-X>`_
 - `bimmlerd <https://github.com/bimmlerd>`_
-- `cyc8 <https://github.com/cyc8>`_ 
-- `d-qoi <https://github.com/d-qoi>`_
-- `daimajia <https://github.com/daimajia>`_
-- `Daniel Reed <https://github.com/nmlorg>`_
-- `D David Livingston <https://github.com/daviddl9>`_
-- `Dmitry Kolomatskiy <https://github.com/lemontree210>`_
-- `DonalDuck004 <https://github.com/DonalDuck004>`_
-- `Eana Hufwe <https://github.com/blueset>`_
-- `Ehsan Online <https://github.com/ehsanonline>`_
-- `Eldad Carin <https://github.com/eldbud>`_
 - `Eli Gao <https://github.com/eligao>`_
-- `Emilio Molinari <https://github.com/xates>`_
 - `ErgoZ Riftbit Vaper <https://github.com/ergoz>`_
-- `Eugene Lisitsky <https://github.com/lisitsky>`_
-- `Eugenio Panadero <https://github.com/azogue>`_
-- `Evan Haberecht <https://github.com/habereet>`_
-- `Evgeny Denisov <https://github.com/eIGato>`_
-- `evgfilim1 <https://github.com/evgfilim1>`_
-- `ExalFabu <https://github.com/ExalFabu>`_
 - `franciscod <https://github.com/franciscod>`_
-- `gamgi <https://github.com/gamgi>`_
-- `Gauthamram Ravichandran <https://github.com/GauthamramRavichandran>`_
-- `Harshil <https://github.com/harshil21>`_
-- `Henok Tesfamikael <https://github.com/hethon>`
-- `Henry Galue <https://github.com/henryg311>`
-- `Hugo Damer <https://github.com/HakimusGIT>`_
-- `ihoru <https://github.com/ihoru>`_
-- `Iulian Onofrei <https://github.com/revolter>`_
-- `Jainam Oswal <https://github.com/jainamoswal>`_
-- `Jasmin Bom <https://github.com/jsmnbom>`_
+- `Jacob Bom <https://github.com/bomjacob>`_
 - `JASON0916 <https://github.com/JASON0916>`_
-- `Jeamhowards Montiel <https://github.com/Jeam-zx>`
-- `jeffffc <https://github.com/jeffffc>`_
-- `Jelle Besseling <https://github.com/pingiun>`_
 - `jh0ker <https://github.com/jh0ker>`_
-- `jlmadurga <https://github.com/jlmadurga>`_
-- `John Yong <https://github.com/whipermr5>`_
-- `Joscha Götzer <https://github.com/Rostgnom>`_
-- `jossalgon <https://github.com/jossalgon>`_
 - `JRoot3D <https://github.com/JRoot3D>`_
-- `Juan Cuevas <https://github.com/cuevasrja>`
-- `kenjitagawa <https://github.com/kenjitagawa>`_
-- `kennethcheo <https://github.com/kennethcheo>`_
-- `Kirill Vasin <https://github.com/vasinkd>`_
-- `Kjwon15 <https://github.com/kjwon15>`_
+- `jlmadurga <https://github.com/jlmadurga>`_
 - `Li-aung Yip <https://github.com/LiaungYip>`_
-- `locobott <https://github.com/locobott>`_
-- `Loo Zheng Yuan <https://github.com/loozhengyuan>`_
-- `LRezende <https://github.com/lrezende>`_
-- `Luca Bellanti <https://github.com/Trifase>`_
-- `Lucas Molinari <https://github.com/lucasmolinari>`_
-- `Luis Pérez <https://github.com/nemacysts>`_
 - `macrojames <https://github.com/macrojames>`_
-- `Matheus Lemos <https://github.com/mlemosf>`_
-- `Michael Dix <https://github.com/Eisberge>`_
-- `Michael Elovskikh <https://github.com/wronglink>`_
-- `Miguel C. R. <https://github.com/MiguelX413>`_
-- `Miguel Salomon <https://github.com/Migueldsc12>`
-- `miles <https://github.com/miles170>`_
-- `Mischa Krüger <https://github.com/Makman2>`_
-- `Mohd Yusuf <https://github.com/mohdyusuf2312>`_
 - `naveenvhegde <https://github.com/naveenvhegde>`_
-- `neurrone <https://github.com/neurrone>`_
-- `NikitaPirate <https://github.com/NikitaPirate>`_
-- `Nikolai Krivenko <https://github.com/nkrivenko>`_
 - `njittam <https://github.com/njittam>`_
 - `Noam Meltzer <https://github.com/tsnoam>`_
 - `Oleg Shlyazhko <https://github.com/ollmer>`_
-- `Oleg Sushchenko <https://github.com/feuillemorte>`_
-- `Or Bin <https://github.com/OrBin>`_
-- `OuYoung <https://github.com/ouyooung>`_
 - `overquota <https://github.com/overquota>`_
-- `Pablo Martinez <https://github.com/elpekenin>`_
-- `Paradox <https://github.com/paradox70>`_
-- `Patrick Hofmann <https://github.com/PH89>`_
-- `Paul Larsen <https://github.com/PaulSonOfLars>`_
-- `Pawan <https://github.com/pawanrai9999>`_
-- `Philipp Isachenko <https://github.com/Aweryc>`_
-- `Pieter Schutz <https://github.com/eldinnie>`_
-- `Piraty <https://github.com/piraty>`_
-- `Poolitzer <https://github.com/Poolitzer>`_
-- `Pranjalya Tiwari <https://github.com/Pranjalya>`_
 - `Rahiel Kasim <https://github.com/rahiel>`_
-- `Riko Naka <https://github.com/rikonaka>`_
-- `Rizlas <https://github.com/rizlas>`_
-- Snehashish Biswas
-- `Sahil Sharma <https://github.com/sahilsharma811>`_
-- `Sam Mosleh <https://github.com/sam-mosleh>`_
-- `Sascha <https://github.com/saschalalala>`_
 - `Shelomentsev D <https://github.com/shelomentsevd>`_
-- `Shivam <https://github.com/Starry69>`_
-- `Shivam Saini <https://github.com/shivamsn97>`_
-- `Siloé Garcez <https://github.com/roast-lord>`_
-- `Simon Schürrle <https://github.com/SitiSchu>`_
 - `sooyhwang <https://github.com/sooyhwang>`_
-- `syntx <https://github.com/syntx>`_
-- `thodnev <https://github.com/thodnev>`_
-- `Timur Kushukov <https://github.com/timqsh>`_
-- `Trainer Jono <https://github.com/Tr-Jono>`_
 - `Valentijn <https://github.com/Faalentijn>`_
-- `voider1 <https://github.com/voider1>`_
-- `Vorobjev Simon <https://github.com/simonvorobjev>`_
-- `Wagner Macedo <https://github.com/wagnerluis1982>`_
 - `wjt <https://github.com/wjt>`_
-- `Wonseok Oh <https://github.com/marinelay>`_
-- `Yaw Danso <https://github.com/dglitxh>`_
-- `Yao Kuan <https://github.com/thatguylah>`_
-- `zeroone2numeral2 <https://github.com/zeroone2numeral2>`_
-- `zeshuaro <https://github.com/zeshuaro>`_
-- `zpavloudis <https://github.com/zpavloudis>`_
-
 
 Please add yourself here alphabetically when you submit your first pull request.

CHANGES.rst

@@ -0,0 +1,465 @@
+=======
+Changes
+=======
+
+**2016-10-10**
+
+*Released 5.1.1*
+
+- Fix documentation builds on readthedocs
+
+**2016-09-24**
+
+*Released 5.1*
+
+- Drop Python 2.6 support
+- Deprecate ``telegram.Emoji``
+
+- Use ``ujson`` if available
+- Add instance methods to ``Message``, ``Chat``, ``User``, ``InlineQuery`` and ``CallbackQuery``
+- RegEx filtering for ``CallbackQueryHandler`` and ``InlineQueryHandler``
+- New ``MessageHandler`` filters: ``forwarded`` and ``entity``
+- Add ``Message.get_entity`` to correctly handle UTF-16 codepoints and ``MessageEntity`` offsets
+- Fix bug in ``ConversationHandler`` when first handler ends the conversation
+- Allow multiple ``Dispatcher`` instances
+- Add ``ChatMigrated`` Exception
+- Properly split and handle arguments in ``CommandHandler``
+
+**2016-07-15**
+
+*Released 5.0*
+
+- Rework ``JobQueue``
+- Introduce ``ConversationHandler``
+
+**2016-07-12**
+
+*Released 4.3.4*
+
+- Fix proxy support with ``urllib3`` when proxy requires auth
+
+**2016-07-08**
+
+*Released 4.3.3*
+
+- Fix proxy support with ``urllib3``
+
+**2016-07-04**
+
+*Released 4.3.2*
+
+- Fix: Use ``timeout`` parameter in all API methods
+
+**2016-06-29**
+
+*Released 4.3.1*
+
+- Update wrong requirement: ``urllib3>=1.10``
+
+**2016-06-28**
+
+*Released 4.3*
+
+- Use ``urllib3.PoolManager`` for connection re-use
+- Rewrite ``run_async`` decorator to re-use threads
+- New requirements: ``urllib3`` and ``certifi``
+
+**2016-06-10**
+
+*Released 4.2.1*
+
+- Fix ``CallbackQuery.to_dict()`` bug (thanks to @jlmadurga)
+- Fix ``editMessageText`` exception when receiving a ``CallbackQuery``
+
+**2016-05-28**
+
+*Released 4.2*
+
+- Implement Bot API 2.1
+- Move ``botan`` module to ``telegram.contrib``
+- New exception type: ``BadRequest``
+
+**2016-05-22**
+
+*Released 4.1.2*
+
+- Fix ``MessageEntity`` decoding with Bot API 2.1 changes
+
+**2016-05-16**
+
+*Released 4.1.1*
+
+- Fix deprecation warning in ``Dispatcher``
+
+**2016-05-15**
+
+*Released 4.1*
+
+- Implement API changes from May 6, 2016
+- Fix bug when ``start_polling`` with ``clean=True``
+- Methods now have snake_case equivalent, for example ``telegram.Bot.send_message`` is the same as ``telegram.Bot.sendMessage``
+
+**2016-05-01**
+
+*Released 4.0.3*
+
+- Add missing attribute ``location`` to ``InlineQuery``
+
+**2016-04-29**
+
+*Released 4.0.2*
+
+- Bugfixes
+- ``KeyboardReplyMarkup`` now accepts ``str`` again
+
+**2016-04-27**
+
+*Released 4.0.1*
+
+- Implement Bot API 2.0
+- Almost complete recode of ``Dispatcher``
+- Please read the `Transition Guide to 4.0 <https://github.com/python-telegram-bot/python-telegram-bot/wiki/Transition-guide-to-Version-4.0>`_
+- **Changes from 4.0rc1**
+    - The syntax of filters for ``MessageHandler`` (upper/lower cases)
+    - Handler groups are now identified by ``int`` only, and ordered
+- **Note:** v4.0 has been skipped due to a PyPI accident
+
+**2016-04-22**
+
+*Released 4.0rc1*
+
+- Implement Bot API 2.0
+- Almost complete recode of ``Dispatcher``
+- Please read the `Transistion Guide to 4.0 <https://github.com/python-telegram-bot/python-telegram-bot/wiki/Transistion-guide-to-Version-4.0>`_
+
+**2016-03-22**
+
+*Released 3.4*
+
+- Move ``Updater``, ``Dispatcher`` and ``JobQueue`` to new ``telegram.ext`` submodule (thanks to @rahiel)
+- Add ``disable_notification`` parameter (thanks to @aidarbiktimirov)
+- Fix bug where commands sent by Telegram Web would not be recognized (thanks to @shelomentsevd)
+- Add option to skip old updates on bot startup
+- Send files from ``BufferedReader``
+
+**2016-02-28**
+
+*Released 3.3*
+
+- Inline bots
+- Send any file by URL
+- Specialized exceptions: ``Unauthorized``, ``InvalidToken``, ``NetworkError`` and ``TimedOut``
+- Integration for botan.io (thanks to @ollmer)
+- HTML Parsemode (thanks to @jlmadurga)
+- Bugfixes and under-the-hood improvements
+
+**Very special thanks to Noam Meltzer (@tsnoam) for all of his work!**
+
+**2016-01-09**
+
+*Released 3.3b1*
+
+- Implement inline bots (beta)
+
+**2016-01-05**
+
+*Released 3.2.0*
+
+- Introducing ``JobQueue`` (original author: @franciscod)
+- Streamlining all exceptions to ``TelegramError`` (Special thanks to @tsnoam)
+- Proper locking of ``Updater`` and ``Dispatcher`` ``start`` and ``stop`` methods
+- Small bugfixes
+
+**2015-12-29**
+
+*Released 3.1.2*
+
+- Fix custom path for file downloads
+- Don't stop the dispatcher thread on uncaught errors in handlers
+
+**2015-12-21**
+
+*Released 3.1.1*
+
+- Fix a bug where asynchronous handlers could not have additional arguments
+- Add ``groups`` and ``groupdict`` as additional arguments for regex-based handlers
+
+**2015-12-16**
+
+*Released 3.1.0*
+
+- The ``chat``-field in ``Message`` is now of type ``Chat``. (API update Oct 8 2015)
+- ``Message`` now contains the optional fields ``supergroup_chat_created``, ``migrate_to_chat_id``, ``migrate_from_chat_id`` and ``channel_chat_created``. (API update Nov 2015)
+
+**2015-12-08**
+
+*Released 3.0.0*
+
+- Introducing the ``Updater`` and ``Dispatcher`` classes
+
+**2015-11-11**
+
+*Released 2.9.2*
+
+- Error handling on request timeouts has been improved
+
+**2015-11-10**
+
+*Released 2.9.1*
+
+- Add parameter ``network_delay`` to Bot.getUpdates for slow connections
+
+**2015-11-10**
+
+*Released 2.9*
+
+- Emoji class now uses ``bytes_to_native_str`` from ``future`` 3rd party lib
+- Make ``user_from`` optional to work with channels
+- Raise exception if Telegram times out on long-polling
+
+*Special thanks to @jh0ker for all hard work*
+
+
+**2015-10-08**
+
+*Released 2.8.7*
+
+- Type as optional for ``GroupChat`` class
+
+
+**2015-10-08**
+
+*Released 2.8.6*
+
+- Adds type to ``User`` and ``GroupChat`` classes (pre-release Telegram feature)
+
+
+**2015-09-24**
+
+*Released 2.8.5*
+
+- Handles HTTP Bad Gateway (503) errors on request
+- Fixes regression on ``Audio`` and ``Document`` for unicode fields
+
+
+**2015-09-20**
+
+*Released 2.8.4*
+
+- ``getFile`` and ``File.download`` is now fully supported
+
+
+**2015-09-10**
+
+*Released 2.8.3*
+
+- Moved ``Bot._requestURL`` to its own class (``telegram.utils.request``)
+- Much better, such wow, Telegram Objects tests
+- Add consistency for ``str`` properties on Telegram Objects
+- Better design to test if ``chat_id`` is invalid
+- Add ability to set custom filename on ``Bot.sendDocument(..,filename='')``
+- Fix Sticker as ``InputFile``
+- Send JSON requests over urlencoded post data
+- Markdown support for ``Bot.sendMessage(..., parse_mode=ParseMode.MARKDOWN)``
+- Refactor of ``TelegramError`` class (no more handling ``IOError`` or ``URLError``)
+
+
+**2015-09-05**
+
+*Released 2.8.2*
+
+- Fix regression on Telegram ReplyMarkup
+- Add certificate to ``is_inputfile`` method
+
+
+**2015-09-05**
+
+*Released 2.8.1*
+
+- Fix regression on Telegram objects with thumb properties
+
+
+**2015-09-04**
+
+*Released 2.8*
+
+- TelegramError when ``chat_id`` is empty for send* methods
+- ``setWebhook`` now supports sending self-signed certificate
+- Huge redesign of existing Telegram classes
+- Added support for PyPy
+- Added docstring for existing classes
+
+
+**2015-08-19**
+
+*Released 2.7.1*
+
+- Fixed JSON serialization for ``message``
+
+
+**2015-08-17**
+
+*Released 2.7*
+
+- Added support for ``Voice`` object and ``sendVoice`` method
+- Due backward compatibility performer or/and title will be required for ``sendAudio``
+- Fixed JSON serialization when forwarded message
+
+
+**2015-08-15**
+
+*Released 2.6.1*
+
+- Fixed parsing image header issue on < Python 2.7.3
+
+
+**2015-08-14**
+
+*Released 2.6.0*
+
+- Depreciation of ``require_authentication`` and ``clearCredentials`` methods
+- Giving ``AUTHORS`` the proper credits for their contribution for this project
+- ``Message.date`` and ``Message.forward_date`` are now ``datetime`` objects
+
+
+**2015-08-12**
+
+*Released 2.5.3*
+
+- ``telegram.Bot`` now supports to be unpickled
+
+
+**2015-08-11**
+
+*Released 2.5.2*
+
+- New changes from Telegram Bot API have been applied
+- ``telegram.Bot`` now supports to be pickled
+- Return empty ``str`` instead ``None`` when ``message.text`` is empty
+
+
+**2015-08-10**
+
+*Released 2.5.1*
+
+- Moved from GPLv2 to LGPLv3
+
+
+**2015-08-09**
+
+*Released 2.5*
+
+- Fixes logging calls in API
+
+
+**2015-08-08**
+
+*Released 2.4*
+
+- Fixes ``Emoji`` class for Python 3
+- ``PEP8`` improvements
+
+
+**2015-08-08**
+
+*Released 2.3*
+
+- Fixes ``ForceReply`` class
+- Remove ``logging.basicConfig`` from library
+
+
+**2015-07-25**
+
+*Released 2.2*
+
+- Allows ``debug=True`` when initializing ``telegram.Bot``
+
+
+**2015-07-20**
+
+*Released 2.1*
+
+- Fix ``to_dict`` for ``Document`` and ``Video``
+
+
+**2015-07-19**
+
+*Released 2.0*
+
+- Fixes bugs
+- Improves ``__str__`` over ``to_json()``
+- Creates abstract class ``TelegramObject``
+
+
+**2015-07-15**
+
+*Released 1.9*
+
+- Python 3 officially supported
+- ``PEP8`` improvements
+
+
+**2015-07-12**
+
+*Released 1.8*
+
+- Fixes crash when replying an unicode text message (special thanks to JRoot3D)
+
+
+**2015-07-11**
+
+*Released 1.7*
+
+- Fixes crash when ``username`` is not defined on ``chat`` (special thanks to JRoot3D)
+
+
+**2015-07-10**
+
+*Released 1.6*
+
+- Improvements for GAE support
+
+
+**2015-07-10**
+
+*Released 1.5*
+
+- Fixes randomly unicode issues when using ``InputFile``
+
+
+**2015-07-10**
+
+*Released 1.4*
+
+- ``requests`` lib is no longer required
+- Google App Engine (GAE) is supported
+
+
+**2015-07-10**
+
+*Released 1.3*
+
+- Added support to ``setWebhook`` (special thanks to macrojames)
+
+
+**2015-07-09**
+
+*Released 1.2*
+
+- ``CustomKeyboard`` classes now available
+- Emojis available
+- ``PEP8`` improvements
+
+
+**2015-07-08**
+
+*Released 1.1*
+
+- PyPi package now available
+
+
+**2015-07-08**
+
+*Released 1.0*
+
+- Initial checkin of python-telegram-bot

CODE_OF_CONDUCT.rst

@@ -1,52 +0,0 @@
-====================================
-Contributor Covenant Code of Conduct
-====================================
-
-Our Pledge
-==========
-
-In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
-
-Our Standards
-=============
-
-Examples of behavior that contributes to creating a positive environment include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or advances
-* Publication of any content supporting, justifying or otherwise affiliating with terror and/or hate towards others
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a professional setting
-
-Our Responsibilities
-====================
-
-Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
-
-Scope
-=====
-
-This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
-
-Enforcement
-===========
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at devs@python-telegram-bot.org. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
-
-Attribution
-===========
-
-This Code of Conduct is adapted from the `Contributor Covenant <https://www.contributor-covenant.org>`_, version 1.4, available at `https://www.contributor-covenant.org/version/1/4 <https://www.contributor-covenant.org/version/1/4/>`_.

LICENSE.dual

@@ -1,792 +0,0 @@
-  NOTICE: You can find here the GPLv3 license and after the Lesser GPLv3 license.
-You may choose either license.
-
-
-                   GNU LESSER GENERAL PUBLIC LICENSE
-                       Version 3, 29 June 2007
-
- Copyright (C) 2007 Free Software Foundation, Inc. [http://fsf.org/]
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
-
-
-  This version of the GNU Lesser General Public License incorporates
-the terms and conditions of version 3 of the GNU General Public
-License, supplemented by the additional permissions listed below.
-
-  0. Additional Definitions.
-
-  As used herein, "this License" refers to version 3 of the GNU Lesser
-General Public License, and the "GNU GPL" refers to version 3 of the GNU
-General Public License.
-
-  "The Library" refers to a covered work governed by this License,
-other than an Application or a Combined Work as defined below.
-
-  An "Application" is any work that makes use of an interface provided
-by the Library, but which is not otherwise based on the Library.
-Defining a subclass of a class defined by the Library is deemed a mode
-of using an interface provided by the Library.
-
-  A "Combined Work" is a work produced by combining or linking an
-Application with the Library.  The particular version of the Library
-with which the Combined Work was made is also called the "Linked
-Version".
-
-  The "Minimal Corresponding Source" for a Combined Work means the
-Corresponding Source for the Combined Work, excluding any source code
-for portions of the Combined Work that, considered in isolation, are
-based on the Application, and not on the Linked Version.
-
-  The "Corresponding Application Code" for a Combined Work means the
-object code and/or source code for the Application, including any data
-and utility programs needed for reproducing the Combined Work from the
-Application, but excluding the System Libraries of the Combined Work.
-
-  1. Exception to Section 3 of the GNU GPL.
-
-  You may convey a covered work under sections 3 and 4 of this License
-without being bound by section 3 of the GNU GPL.
-
-  2. Conveying Modified Versions.
-
-  If you modify a copy of the Library, and, in your modifications, a
-facility refers to a function or data to be supplied by an Application
-that uses the facility (other than as an argument passed when the
-facility is invoked), then you may convey a copy of the modified
-version:
-
-   a) under this License, provided that you make a good faith effort to
-   ensure that, in the event an Application does not supply the
-   function or data, the facility still operates, and performs
-   whatever part of its purpose remains meaningful, or
-
-   b) under the GNU GPL, with none of the additional permissions of
-   this License applicable to that copy.
-
-  3. Object Code Incorporating Material from Library Header Files.
-
-  The object code form of an Application may incorporate material from
-a header file that is part of the Library.  You may convey such object
-code under terms of your choice, provided that, if the incorporated
-material is not limited to numerical parameters, data structure
-layouts and accessors, or small macros, inline functions and templates
-(ten or fewer lines in length), you do both of the following:
-
-   a) Give prominent notice with each copy of the object code that the
-   Library is used in it and that the Library and its use are
-   covered by this License.
-
-   b) Accompany the object code with a copy of the GNU GPL and this license
-   document.
-
-  4. Combined Works.
-
-  You may convey a Combined Work under terms of your choice that,
-taken together, effectively do not restrict modification of the
-portions of the Library contained in the Combined Work and reverse
-engineering for debugging such modifications, if you also do each of
-the following:
-
-   a) Give prominent notice with each copy of the Combined Work that
-   the Library is used in it and that the Library and its use are
-   covered by this License.
-
-   b) Accompany the Combined Work with a copy of the GNU GPL and this license
-   document.
-
-   c) For a Combined Work that displays copyright notices during
-   execution, include the copyright notice for the Library among
-   these notices, as well as a reference directing the user to the
-   copies of the GNU GPL and this license document.
-
-   d) Do one of the following:
-
-       0) Convey the Minimal Corresponding Source under the terms of this
-       License, and the Corresponding Application Code in a form
-       suitable for, and under terms that permit, the user to
-       recombine or relink the Application with a modified version of
-       the Linked Version to produce a modified Combined Work, in the
-       manner specified by section 6 of the GNU GPL for conveying
-       Corresponding Source.
-
-       1) Use a suitable shared library mechanism for linking with the
-       Library.  A suitable mechanism is one that (a) uses at run time
-       a copy of the Library already present on the user's computer
-       system, and (b) will operate properly with a modified version
-       of the Library that is interface-compatible with the Linked
-       Version.
-
-   e) Provide Installation Information, but only if you would otherwise
-   be required to provide such information under section 6 of the
-   GNU GPL, and only to the extent that such information is
-   necessary to install and execute a modified version of the
-   Combined Work produced by recombining or relinking the
-   Application with a modified version of the Linked Version. (If
-   you use option 4d0, the Installation Information must accompany
-   the Minimal Corresponding Source and Corresponding Application
-   Code. If you use option 4d1, you must provide the Installation
-   Information in the manner specified by section 6 of the GNU GPL
-   for conveying Corresponding Source.)
-
-  5. Combined Libraries.
-
-  You may place library facilities that are a work based on the
-Library side by side in a single library together with other library
-facilities that are not Applications and are not covered by this
-License, and convey such a combined library under terms of your
-choice, if you do both of the following:
-
-   a) Accompany the combined library with a copy of the same work based
-   on the Library, uncombined with any other library facilities,
-   conveyed under the terms of this License.
-
-   b) Give prominent notice with the combined library that part of it
-   is a work based on the Library, and explaining where to find the
-   accompanying uncombined form of the same work.
-
-  6. Revised Versions of the GNU Lesser General Public License.
-
-  The Free Software Foundation may publish revised and/or new versions
-of the GNU Lesser General Public License from time to time. Such new
-versions will be similar in spirit to the present version, but may
-differ in detail to address new problems or concerns.
-
-  Each version is given a distinguishing version number. If the
-Library as you received it specifies that a certain numbered version
-of the GNU Lesser General Public License "or any later version"
-applies to it, you have the option of following the terms and
-conditions either of that published version or of any later version
-published by the Free Software Foundation. If the Library as you
-received it does not specify a version number of the GNU Lesser
-General Public License, you may choose any version of the GNU Lesser
-General Public License ever published by the Free Software Foundation.
-
-  If the Library as you received it specifies that a proxy can decide
-whether future versions of the GNU Lesser General Public License shall
-apply, that proxy's public statement of acceptance of any version is
-permanent authorization for you to choose that version for the
-Library.
-
-
-
-
-                    GNU GENERAL PUBLIC LICENSE
-                       Version 3, 29 June 2007
-
- Copyright (C) 2007 Free Software Foundation, Inc. [http://fsf.org/]
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
-
-                            Preamble
-
-  The GNU General Public License is a free, copyleft license for
-software and other kinds of works.
-
-  The licenses for most software and other practical works are designed
-to take away your freedom to share and change the works.  By contrast,
-the GNU General Public License is intended to guarantee your freedom to
-share and change all versions of a program--to make sure it remains free
-software for all its users.  We, the Free Software Foundation, use the
-GNU General Public License for most of our software; it applies also to
-any other work released this way by its authors.  You can apply it to
-your programs, too.
-
-  When we speak of free software, we are referring to freedom, not
-price.  Our General Public Licenses are designed to make sure that you
-have the freedom to distribute copies of free software (and charge for
-them if you wish), that you receive source code or can get it if you
-want it, that you can change the software or use pieces of it in new
-free programs, and that you know you can do these things.
-
-  To protect your rights, we need to prevent others from denying you
-these rights or asking you to surrender the rights.  Therefore, you have
-certain responsibilities if you distribute copies of the software, or if
-you modify it: responsibilities to respect the freedom of others.
-
-  For example, if you distribute copies of such a program, whether
-gratis or for a fee, you must pass on to the recipients the same
-freedoms that you received.  You must make sure that they, too, receive
-or can get the source code.  And you must show them these terms so they
-know their rights.
-
-  Developers that use the GNU GPL protect your rights with two steps:
-(1) assert copyright on the software, and (2) offer you this License
-giving you legal permission to copy, distribute and/or modify it.
-
-  For the developers' and authors' protection, the GPL clearly explains
-that there is no warranty for this free software.  For both users' and
-authors' sake, the GPL requires that modified versions be marked as
-changed, so that their problems will not be attributed erroneously to
-authors of previous versions.
-
-  Some devices are designed to deny users access to install or run
-modified versions of the software inside them, although the manufacturer
-can do so.  This is fundamentally incompatible with the aim of
-protecting users' freedom to change the software.  The systematic
-pattern of such abuse occurs in the area of products for individuals to
-use, which is precisely where it is most unacceptable.  Therefore, we
-have designed this version of the GPL to prohibit the practice for those
-products.  If such problems arise substantially in other domains, we
-stand ready to extend this provision to those domains in future versions
-of the GPL, as needed to protect the freedom of users.
-
-  Finally, every program is threatened constantly by software patents.
-States should not allow patents to restrict development and use of
-software on general-purpose computers, but in those that do, we wish to
-avoid the special danger that patents applied to a free program could
-make it effectively proprietary.  To prevent this, the GPL assures that
-patents cannot be used to render the program non-free.
-
-  The precise terms and conditions for copying, distribution and
-modification follow.
-
-                       TERMS AND CONDITIONS
-
-  0. Definitions.
-
-  "This License" refers to version 3 of the GNU General Public License.
-
-  "Copyright" also means copyright-like laws that apply to other kinds of
-works, such as semiconductor masks.
-
-  "The Program" refers to any copyrightable work licensed under this
-License.  Each licensee is addressed as "you".  "Licensees" and
-"recipients" may be individuals or organizations.
-
-  To "modify" a work means to copy from or adapt all or part of the work
-in a fashion requiring copyright permission, other than the making of an
-exact copy.  The resulting work is called a "modified version" of the
-earlier work or a work "based on" the earlier work.
-
-  A "covered work" means either the unmodified Program or a work based
-on the Program.
-
-  To "propagate" a work means to do anything with it that, without
-permission, would make you directly or secondarily liable for
-infringement under applicable copyright law, except executing it on a
-computer or modifying a private copy.  Propagation includes copying,
-distribution (with or without modification), making available to the
-public, and in some countries other activities as well.
-
-  To "convey" a work means any kind of propagation that enables other
-parties to make or receive copies.  Mere interaction with a user through
-a computer network, with no transfer of a copy, is not conveying.
-
-  An interactive user interface displays "Appropriate Legal Notices"
-to the extent that it includes a convenient and prominently visible
-feature that (1) displays an appropriate copyright notice, and (2)
-tells the user that there is no warranty for the work (except to the
-extent that warranties are provided), that licensees may convey the
-work under this License, and how to view a copy of this License.  If
-the interface presents a list of user commands or options, such as a
-menu, a prominent item in the list meets this criterion.
-
-  1. Source Code.
-
-  The "source code" for a work means the preferred form of the work
-for making modifications to it.  "Object code" means any non-source
-form of a work.
-
-  A "Standard Interface" means an interface that either is an official
-standard defined by a recognized standards body, or, in the case of
-interfaces specified for a particular programming language, one that
-is widely used among developers working in that language.
-
-  The "System Libraries" of an executable work include anything, other
-than the work as a whole, that (a) is included in the normal form of
-packaging a Major Component, but which is not part of that Major
-Component, and (b) serves only to enable use of the work with that
-Major Component, or to implement a Standard Interface for which an
-implementation is available to the public in source code form.  A
-"Major Component", in this context, means a major essential component
-(kernel, window system, and so on) of the specific operating system
-(if any) on which the executable work runs, or a compiler used to
-produce the work, or an object code interpreter used to run it.
-
-  The "Corresponding Source" for a work in object code form means all
-the source code needed to generate, install, and (for an executable
-work) run the object code and to modify the work, including scripts to
-control those activities.  However, it does not include the work's
-System Libraries, or general-purpose tools or generally available free
-programs which are used unmodified in performing those activities but
-which are not part of the work.  For example, Corresponding Source
-includes interface definition files associated with source files for
-the work, and the source code for shared libraries and dynamically
-linked subprograms that the work is specifically designed to require,
-such as by intimate data communication or control flow between those
-subprograms and other parts of the work.
-
-  The Corresponding Source need not include anything that users
-can regenerate automatically from other parts of the Corresponding
-Source.
-
-  The Corresponding Source for a work in source code form is that
-same work.
-
-  2. Basic Permissions.
-
-  All rights granted under this License are granted for the term of
-copyright on the Program, and are irrevocable provided the stated
-conditions are met.  This License explicitly affirms your unlimited
-permission to run the unmodified Program.  The output from running a
-covered work is covered by this License only if the output, given its
-content, constitutes a covered work.  This License acknowledges your
-rights of fair use or other equivalent, as provided by copyright law.
-
-  You may make, run and propagate covered works that you do not
-convey, without conditions so long as your license otherwise remains
-in force.  You may convey covered works to others for the sole purpose
-of having them make modifications exclusively for you, or provide you
-with facilities for running those works, provided that you comply with
-the terms of this License in conveying all material for which you do
-not control copyright.  Those thus making or running the covered works
-for you must do so exclusively on your behalf, under your direction
-and control, on terms that prohibit them from making any copies of
-your copyrighted material outside their relationship with you.
-
-  Conveying under any other circumstances is permitted solely under
-the conditions stated below.  Sublicensing is not allowed; section 10
-makes it unnecessary.
-
-  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
-
-  No covered work shall be deemed part of an effective technological
-measure under any applicable law fulfilling obligations under article
-11 of the WIPO copyright treaty adopted on 20 December 1996, or
-similar laws prohibiting or restricting circumvention of such
-measures.
-
-  When you convey a covered work, you waive any legal power to forbid
-circumvention of technological measures to the extent such circumvention
-is effected by exercising rights under this License with respect to
-the covered work, and you disclaim any intention to limit operation or
-modification of the work as a means of enforcing, against the work's
-users, your or third parties' legal rights to forbid circumvention of
-technological measures.
-
-  4. Conveying Verbatim Copies.
-
-  You may convey verbatim copies of the Program's source code as you
-receive it, in any medium, provided that you conspicuously and
-appropriately publish on each copy an appropriate copyright notice;
-keep intact all notices stating that this License and any
-non-permissive terms added in accord with section 7 apply to the code;
-keep intact all notices of the absence of any warranty; and give all
-recipients a copy of this License along with the Program.
-
-  You may charge any price or no price for each copy that you convey,
-and you may offer support or warranty protection for a fee.
-
-  5. Conveying Modified Source Versions.
-
-  You may convey a work based on the Program, or the modifications to
-produce it from the Program, in the form of source code under the
-terms of section 4, provided that you also meet all of these conditions:
-
-    a) The work must carry prominent notices stating that you modified
-    it, and giving a relevant date.
-
-    b) The work must carry prominent notices stating that it is
-    released under this License and any conditions added under section
-    7.  This requirement modifies the requirement in section 4 to
-    "keep intact all notices".
-
-    c) You must license the entire work, as a whole, under this
-    License to anyone who comes into possession of a copy.  This
-    License will therefore apply, along with any applicable section 7
-    additional terms, to the whole of the work, and all its parts,
-    regardless of how they are packaged.  This License gives no
-    permission to license the work in any other way, but it does not
-    invalidate such permission if you have separately received it.
-
-    d) If the work has interactive user interfaces, each must display
-    Appropriate Legal Notices; however, if the Program has interactive
-    interfaces that do not display Appropriate Legal Notices, your
-    work need not make them do so.
-
-  A compilation of a covered work with other separate and independent
-works, which are not by their nature extensions of the covered work,
-and which are not combined with it such as to form a larger program,
-in or on a volume of a storage or distribution medium, is called an
-"aggregate" if the compilation and its resulting copyright are not
-used to limit the access or legal rights of the compilation's users
-beyond what the individual works permit.  Inclusion of a covered work
-in an aggregate does not cause this License to apply to the other
-parts of the aggregate.
-
-  6. Conveying Non-Source Forms.
-
-  You may convey a covered work in object code form under the terms
-of sections 4 and 5, provided that you also convey the
-machine-readable Corresponding Source under the terms of this License,
-in one of these ways:
-
-    a) Convey the object code in, or embodied in, a physical product
-    (including a physical distribution medium), accompanied by the
-    Corresponding Source fixed on a durable physical medium
-    customarily used for software interchange.
-
-    b) Convey the object code in, or embodied in, a physical product
-    (including a physical distribution medium), accompanied by a
-    written offer, valid for at least three years and valid for as
-    long as you offer spare parts or customer support for that product
-    model, to give anyone who possesses the object code either (1) a
-    copy of the Corresponding Source for all the software in the
-    product that is covered by this License, on a durable physical
-    medium customarily used for software interchange, for a price no
-    more than your reasonable cost of physically performing this
-    conveying of source, or (2) access to copy the
-    Corresponding Source from a network server at no charge.
-
-    c) Convey individual copies of the object code with a copy of the
-    written offer to provide the Corresponding Source.  This
-    alternative is allowed only occasionally and noncommercially, and
-    only if you received the object code with such an offer, in accord
-    with subsection 6b.
-
-    d) Convey the object code by offering access from a designated
-    place (gratis or for a charge), and offer equivalent access to the
-    Corresponding Source in the same way through the same place at no
-    further charge.  You need not require recipients to copy the
-    Corresponding Source along with the object code.  If the place to
-    copy the object code is a network server, the Corresponding Source
-    may be on a different server (operated by you or a third party)
-    that supports equivalent copying facilities, provided you maintain
-    clear directions next to the object code saying where to find the
-    Corresponding Source.  Regardless of what server hosts the
-    Corresponding Source, you remain obligated to ensure that it is
-    available for as long as needed to satisfy these requirements.
-
-    e) Convey the object code using peer-to-peer transmission, provided
-    you inform other peers where the object code and Corresponding
-    Source of the work are being offered to the general public at no
-    charge under subsection 6d.
-
-  A separable portion of the object code, whose source code is excluded
-from the Corresponding Source as a System Library, need not be
-included in conveying the object code work.
-
-  A "User Product" is either (1) a "consumer product", which means any
-tangible personal property which is normally used for personal, family,
-or household purposes, or (2) anything designed or sold for incorporation
-into a dwelling.  In determining whether a product is a consumer product,
-doubtful cases shall be resolved in favor of coverage.  For a particular
-product received by a particular user, "normally used" refers to a
-typical or common use of that class of product, regardless of the status
-of the particular user or of the way in which the particular user
-actually uses, or expects or is expected to use, the product.  A product
-is a consumer product regardless of whether the product has substantial
-commercial, industrial or non-consumer uses, unless such uses represent
-the only significant mode of use of the product.
-
-  "Installation Information" for a User Product means any methods,
-procedures, authorization keys, or other information required to install
-and execute modified versions of a covered work in that User Product from
-a modified version of its Corresponding Source.  The information must
-suffice to ensure that the continued functioning of the modified object
-code is in no case prevented or interfered with solely because
-modification has been made.
-
-  If you convey an object code work under this section in, or with, or
-specifically for use in, a User Product, and the conveying occurs as
-part of a transaction in which the right of possession and use of the
-User Product is transferred to the recipient in perpetuity or for a
-fixed term (regardless of how the transaction is characterized), the
-Corresponding Source conveyed under this section must be accompanied
-by the Installation Information.  But this requirement does not apply
-if neither you nor any third party retains the ability to install
-modified object code on the User Product (for example, the work has
-been installed in ROM).
-
-  The requirement to provide Installation Information does not include a
-requirement to continue to provide support service, warranty, or updates
-for a work that has been modified or installed by the recipient, or for
-the User Product in which it has been modified or installed.  Access to a
-network may be denied when the modification itself materially and
-adversely affects the operation of the network or violates the rules and
-protocols for communication across the network.
-
-  Corresponding Source conveyed, and Installation Information provided,
-in accord with this section must be in a format that is publicly
-documented (and with an implementation available to the public in
-source code form), and must require no special password or key for
-unpacking, reading or copying.
-
-  7. Additional Terms.
-
-  "Additional permissions" are terms that supplement the terms of this
-License by making exceptions from one or more of its conditions.
-Additional permissions that are applicable to the entire Program shall
-be treated as though they were included in this License, to the extent
-that they are valid under applicable law.  If additional permissions
-apply only to part of the Program, that part may be used separately
-under those permissions, but the entire Program remains governed by
-this License without regard to the additional permissions.
-
-  When you convey a copy of a covered work, you may at your option
-remove any additional permissions from that copy, or from any part of
-it.  (Additional permissions may be written to require their own
-removal in certain cases when you modify the work.)  You may place
-additional permissions on material, added by you to a covered work,
-for which you have or can give appropriate copyright permission.
-
-  Notwithstanding any other provision of this License, for material you
-add to a covered work, you may (if authorized by the copyright holders of
-that material) supplement the terms of this License with terms:
-
-    a) Disclaiming warranty or limiting liability differently from the
-    terms of sections 15 and 16 of this License; or
-
-    b) Requiring preservation of specified reasonable legal notices or
-    author attributions in that material or in the Appropriate Legal
-    Notices displayed by works containing it; or
-
-    c) Prohibiting misrepresentation of the origin of that material, or
-    requiring that modified versions of such material be marked in
-    reasonable ways as different from the original version; or
-
-    d) Limiting the use for publicity purposes of names of licensors or
-    authors of the material; or
-
-    e) Declining to grant rights under trademark law for use of some
-    trade names, trademarks, or service marks; or
-
-    f) Requiring indemnification of licensors and authors of that
-    material by anyone who conveys the material (or modified versions of
-    it) with contractual assumptions of liability to the recipient, for
-    any liability that these contractual assumptions directly impose on
-    those licensors and authors.
-
-  All other non-permissive additional terms are considered "further
-restrictions" within the meaning of section 10.  If the Program as you
-received it, or any part of it, contains a notice stating that it is
-governed by this License along with a term that is a further
-restriction, you may remove that term.  If a license document contains
-a further restriction but permits relicensing or conveying under this
-License, you may add to a covered work material governed by the terms
-of that license document, provided that the further restriction does
-not survive such relicensing or conveying.
-
-  If you add terms to a covered work in accord with this section, you
-must place, in the relevant source files, a statement of the
-additional terms that apply to those files, or a notice indicating
-where to find the applicable terms.
-
-  Additional terms, permissive or non-permissive, may be stated in the
-form of a separately written license, or stated as exceptions;
-the above requirements apply either way.
-
-  8. Termination.
-
-  You may not propagate or modify a covered work except as expressly
-provided under this License.  Any attempt otherwise to propagate or
-modify it is void, and will automatically terminate your rights under
-this License (including any patent licenses granted under the third
-paragraph of section 11).
-
-  However, if you cease all violation of this License, then your
-license from a particular copyright holder is reinstated (a)
-provisionally, unless and until the copyright holder explicitly and
-finally terminates your license, and (b) permanently, if the copyright
-holder fails to notify you of the violation by some reasonable means
-prior to 60 days after the cessation.
-
-  Moreover, your license from a particular copyright holder is
-reinstated permanently if the copyright holder notifies you of the
-violation by some reasonable means, this is the first time you have
-received notice of violation of this License (for any work) from that
-copyright holder, and you cure the violation prior to 30 days after
-your receipt of the notice.
-
-  Termination of your rights under this section does not terminate the
-licenses of parties who have received copies or rights from you under
-this License.  If your rights have been terminated and not permanently
-reinstated, you do not qualify to receive new licenses for the same
-material under section 10.
-
-  9. Acceptance Not Required for Having Copies.
-
-  You are not required to accept this License in order to receive or
-run a copy of the Program.  Ancillary propagation of a covered work
-occurring solely as a consequence of using peer-to-peer transmission
-to receive a copy likewise does not require acceptance.  However,
-nothing other than this License grants you permission to propagate or
-modify any covered work.  These actions infringe copyright if you do
-not accept this License.  Therefore, by modifying or propagating a
-covered work, you indicate your acceptance of this License to do so.
-
-  10. Automatic Licensing of Downstream Recipients.
-
-  Each time you convey a covered work, the recipient automatically
-receives a license from the original licensors, to run, modify and
-propagate that work, subject to this License.  You are not responsible
-for enforcing compliance by third parties with this License.
-
-  An "entity transaction" is a transaction transferring control of an
-organization, or substantially all assets of one, or subdividing an
-organization, or merging organizations.  If propagation of a covered
-work results from an entity transaction, each party to that
-transaction who receives a copy of the work also receives whatever
-licenses to the work the party's predecessor in interest had or could
-give under the previous paragraph, plus a right to possession of the
-Corresponding Source of the work from the predecessor in interest, if
-the predecessor has it or can get it with reasonable efforts.
-
-  You may not impose any further restrictions on the exercise of the
-rights granted or affirmed under this License.  For example, you may
-not impose a license fee, royalty, or other charge for exercise of
-rights granted under this License, and you may not initiate litigation
-(including a cross-claim or counterclaim in a lawsuit) alleging that
-any patent claim is infringed by making, using, selling, offering for
-sale, or importing the Program or any portion of it.
-
-  11. Patents.
-
-  A "contributor" is a copyright holder who authorizes use under this
-License of the Program or a work on which the Program is based.  The
-work thus licensed is called the contributor's "contributor version".
-
-  A contributor's "essential patent claims" are all patent claims
-owned or controlled by the contributor, whether already acquired or
-hereafter acquired, that would be infringed by some manner, permitted
-by this License, of making, using, or selling its contributor version,
-but do not include claims that would be infringed only as a
-consequence of further modification of the contributor version.  For
-purposes of this definition, "control" includes the right to grant
-patent sublicenses in a manner consistent with the requirements of
-this License.
-
-  Each contributor grants you a non-exclusive, worldwide, royalty-free
-patent license under the contributor's essential patent claims, to
-make, use, sell, offer for sale, import and otherwise run, modify and
-propagate the contents of its contributor version.
-
-  In the following three paragraphs, a "patent license" is any express
-agreement or commitment, however denominated, not to enforce a patent
-(such as an express permission to practice a patent or covenant not to
-sue for patent infringement).  To "grant" such a patent license to a
-party means to make such an agreement or commitment not to enforce a
-patent against the party.
-
-  If you convey a covered work, knowingly relying on a patent license,
-and the Corresponding Source of the work is not available for anyone
-to copy, free of charge and under the terms of this License, through a
-publicly available network server or other readily accessible means,
-then you must either (1) cause the Corresponding Source to be so
-available, or (2) arrange to deprive yourself of the benefit of the
-patent license for this particular work, or (3) arrange, in a manner
-consistent with the requirements of this License, to extend the patent
-license to downstream recipients.  "Knowingly relying" means you have
-actual knowledge that, but for the patent license, your conveying the
-covered work in a country, or your recipient's use of the covered work
-in a country, would infringe one or more identifiable patents in that
-country that you have reason to believe are valid.
-
-  If, pursuant to or in connection with a single transaction or
-arrangement, you convey, or propagate by procuring conveyance of, a
-covered work, and grant a patent license to some of the parties
-receiving the covered work authorizing them to use, propagate, modify
-or convey a specific copy of the covered work, then the patent license
-you grant is automatically extended to all recipients of the covered
-work and works based on it.
-
-  A patent license is "discriminatory" if it does not include within
-the scope of its coverage, prohibits the exercise of, or is
-conditioned on the non-exercise of one or more of the rights that are
-specifically granted under this License.  You may not convey a covered
-work if you are a party to an arrangement with a third party that is
-in the business of distributing software, under which you make payment
-to the third party based on the extent of your activity of conveying
-the work, and under which the third party grants, to any of the
-parties who would receive the covered work from you, a discriminatory
-patent license (a) in connection with copies of the covered work
-conveyed by you (or copies made from those copies), or (b) primarily
-for and in connection with specific products or compilations that
-contain the covered work, unless you entered into that arrangement,
-or that patent license was granted, prior to 28 March 2007.
-
-  Nothing in this License shall be construed as excluding or limiting
-any implied license or other defenses to infringement that may
-otherwise be available to you under applicable patent law.
-
-  12. No Surrender of Others' Freedom.
-
-  If conditions are imposed on you (whether by court order, agreement or
-otherwise) that contradict the conditions of this License, they do not
-excuse you from the conditions of this License.  If you cannot convey a
-covered work so as to satisfy simultaneously your obligations under this
-License and any other pertinent obligations, then as a consequence you may
-not convey it at all.  For example, if you agree to terms that obligate you
-to collect a royalty for further conveying from those to whom you convey
-the Program, the only way you could satisfy both those terms and this
-License would be to refrain entirely from conveying the Program.
-
-  13. Use with the GNU Affero General Public License.
-
-  Notwithstanding any other provision of this License, you have
-permission to link or combine any covered work with a work licensed
-under version 3 of the GNU Affero General Public License into a single
-combined work, and to convey the resulting work.  The terms of this
-License will continue to apply to the part which is the covered work,
-but the special requirements of the GNU Affero General Public License,
-section 13, concerning interaction through a network will apply to the
-combination as such.
-
-  14. Revised Versions of this License.
-
-  The Free Software Foundation may publish revised and/or new versions of
-the GNU General Public License from time to time.  Such new versions will
-be similar in spirit to the present version, but may differ in detail to
-address new problems or concerns.
-
-  Each version is given a distinguishing version number.  If the
-Program specifies that a certain numbered version of the GNU General
-Public License "or any later version" applies to it, you have the
-option of following the terms and conditions either of that numbered
-version or of any later version published by the Free Software
-Foundation.  If the Program does not specify a version number of the
-GNU General Public License, you may choose any version ever published
-by the Free Software Foundation.
-
-  If the Program specifies that a proxy can decide which future
-versions of the GNU General Public License can be used, that proxy's
-public statement of acceptance of a version permanently authorizes you
-to choose that version for the Program.
-
-  Later license versions may give you additional or different
-permissions.  However, no additional obligations are imposed on any
-author or copyright holder as a result of your choosing to follow a
-later version.
-
-  15. Disclaimer of Warranty.
-
-  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
-APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
-HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
-OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
-THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
-PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
-IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
-ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
-
-  16. Limitation of Liability.
-
-  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
-WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
-THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
-GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
-USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
-DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
-PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
-EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
-SUCH DAMAGES.
-
-  17. Interpretation of Sections 15 and 16.
-
-  If the disclaimer of warranty and limitation of liability provided
-above cannot be given local legal effect according to their terms,
-reviewing courts shall apply local law that most closely approximates
-an absolute waiver of all civil liability in connection with the
-Program, unless a warranty or assumption of liability accompanies a
-copy of the Program in return for a fee.

MANIFEST.in

@@ -0,0 +1 @@
+include LICENSE LICENSE.lesser Makefile requirements.txt

Makefile

@@ -0,0 +1,52 @@
+.DEFAULT_GOAL := help
+.PHONY: clean pep257 pep8 yapf lint test install
+
+PYLINT          := pylint
+NOSETESTS       := nosetests
+PEP257          := pep257
+PEP8            := flake8
+YAPF            := yapf
+PIP             := pip
+
+clean:
+	rm -fr build
+	rm -fr dist
+	find . -name '*.pyc' -exec rm -f {} \;
+	find . -name '*.pyo' -exec rm -f {} \;
+	find . -name '*~' -exec rm -f {} \;
+	find . -regex "./telegram.\(mp3\|mp4\|ogg\|png\|webp\)" -exec rm {} \;
+
+pep257:
+	$(PEP257) telegram
+
+pep8:
+	$(PEP8) telegram
+
+yapf:
+	$(YAPF) -r telegram
+
+lint:
+	$(PYLINT) -E telegram --disable=no-name-in-module,import-error
+
+test:
+	$(NOSETESTS) -v
+
+install:
+	$(PIP)  install -r requirements.txt -r requirements-dev.txt
+
+help:
+	@echo "Available targets:"
+	@echo "- clean       Clean up the source directory"
+	@echo "- pep257      Check docstring style with pep257"
+	@echo "- pep8        Check style with flake8"
+	@echo "- lint        Check style with pylint"
+	@echo "- yapf        Check style with yapf"
+	@echo "- test        Run tests"
+	@echo
+	@echo "Available variables:"
+	@echo "- PYLINT      default: $(PYLINT)"
+	@echo "- NOSETESTS   default: $(NOSETESTS)"
+	@echo "- PEP257      default: $(PEP257)"
+	@echo "- PEP8        default: $(PEP8)"
+	@echo "- YAPF        default: $(YAPF)"
+	@echo "- PIP         default: $(PIP)"

README.rst

@@ -1,239 +1,192 @@
-.. image:: https://raw.githubusercontent.com/python-telegram-bot/logos/master/logo-text/png/ptb-logo-text_768.png
+.. image:: https://github.com/python-telegram-bot/logos/blob/master/logo-text/png/ptb-logo-text_768.png?raw=true
    :align: center
    :target: https://python-telegram-bot.org
    :alt: python-telegram-bot Logo
 
+We have made you a wrapper you can't refuse
+
+*Stay tuned for library updates and new releases on our* `Telegram Channel <https://telegram.me/pythontelegrambotchannel>`_.
+
 .. image:: https://img.shields.io/pypi/v/python-telegram-bot.svg
-   :target: https://pypi.org/project/python-telegram-bot/
+   :target: https://pypi.python.org/pypi/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
+   :target: https://pypi.python.org/pypi/python-telegram-bot
+   :alt: Supported python versions
 
-.. image:: https://img.shields.io/badge/Bot%20API-9.5-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://app.readthedocs.org/projects/python-telegram-bot/badge/?version=stable
-   :target: https://docs.python-telegram-bot.org/en/stable/
+.. image:: https://img.shields.io/badge/docs-latest-af1a97.svg
+   :target: https://pythonhosted.org/python-telegram-bot/
    :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://travis-ci.org/python-telegram-bot/python-telegram-bot.svg?branch=master
+   :target: https://travis-ci.org/python-telegram-bot/python-telegram-bot
+   :alt: Travis CI Status
 
-.. 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://codeclimate.com/github/python-telegram-bot/python-telegram-bot/badges/gpa.svg
+   :target: https://codeclimate.com/github/python-telegram-bot/python-telegram-bot
+   :alt: Code Climate
 
-.. 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://coveralls.io/repos/python-telegram-bot/python-telegram-bot/badge.svg?branch=master&service=github
+   :target: https://coveralls.io/github/python-telegram-bot/python-telegram-bot?branch=master
+   :alt: Coveralls
+   
+.. image:: http://isitmaintained.com/badge/resolution/python-telegram-bot/python-telegram-bot.svg
+   :target: http://isitmaintained.com/project/python-telegram-bot/python-telegram-bot
+   :alt: Average 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://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
+.. image:: https://img.shields.io/badge/Telegram-Group-blue.svg
    :target: https://telegram.me/pythontelegrambotgroup
    :alt: Telegram Group
 
-We have made you a wrapper you can't refuse
+=================
+Table of contents
+=================
 
-We have a vibrant community of developers helping each other in our `Telegram group <https://telegram.me/pythontelegrambotgroup>`_. Join us!
+- `Introduction`_
 
-*Stay tuned for library updates and new releases on our* `Telegram Channel <https://telegram.me/pythontelegrambotchannel>`_.
+- `Telegram API support`_
 
+- `Installing`_
+
+- `Getting started`_
+
+  #. `Learning by example`_
+
+  #. `Logging`_
+
+  #. `Documentation`_
+
+- `Getting help`_
+
+- `Contributing`_
+
+- `License`_
+
+============
 Introduction
-------------
+============
 
-This library provides a pure Python, asynchronous interface for the
+This library provides a pure Python interface for the
 `Telegram Bot API <https://core.telegram.org/bots/api>`_.
-It's compatible with Python versions **3.10+**.
+It's compatible with Python versions 2.7, 3.3+ and `PyPy <http://pypy.org/>`_.
+It also works with `Google App Engine <https://cloud.google.com/appengine>`_.
 
-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
+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.
 
-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 **9.5** 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>`_
+As of **28. May 2016**, all types and methods of the Telegram Bot API are supported.
 
+==========
 Installing
-----------
+==========
 
-You can install or upgrade ``python-telegram-bot`` via
+You can install or upgrade python-telegram-bot with:
 
 .. 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.
+Or you can install from source with:
 
 .. code:: shell
 
     $ git clone https://github.com/python-telegram-bot/python-telegram-bot
     $ cd python-telegram-bot
-    $ pip install build
-    $ python -m build
+    $ python setup.py install
 
-You can also use your favored package manager (such as ``uv``, ``hatch``, ``poetry``, etc.) instead of ``pip``.
+===============
+Getting started
+===============
 
-Verifying Releases
-~~~~~~~~~~~~~~~~~~
+Our Wiki contains a lot of resources to get you started with ``python-telegram-bot``:
 
-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.
+- `Introduction to the API <https://github.com/python-telegram-bot/python-telegram-bot/wiki/Introduction-to-the-API>`_
+- Tutorial: `Your first Bot <https://github.com/python-telegram-bot/python-telegram-bot/wiki/Extensions-%E2%80%93-Your-first-Bot>`_
 
-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``.
+Other references:
 
-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``.
+- `Telegram API documentation <https://core.telegram.org/bots/api>`_
+- `python-telegram-bot documentation <https://pythonhosted.org/python-telegram-bot/>`_
 
-In addition, the GitHub release page also contains the sha1 hashes of the release files in the files with the suffix ``.sha1``.
+-------------------
+Learning by example
+-------------------
 
-Dependencies & Their Versions
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+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.
 
-``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.
+Visit `this page <https://github.com/python-telegram-bot/python-telegram-bot/blob/master/examples/README.md>`_ to discover the official examples or look at the examples on the `wiki <https://github.com/python-telegram-bot/python-telegram-bot/wiki/Examples>`_ to see other bots the community has built.
 
-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.
-
-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.
-
-2. Ask questions by opening `a discussion <https://github.com/python-telegram-bot/python-telegram-bot/discussions/new>`_.
-
-3. You can even ask for help on Stack Overflow using the `python-telegram-bot tag <https://stackoverflow.com/questions/tagged/python-telegram-bot>`_.
-
-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`` currently does 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
-
-Free threading
-~~~~~~~~~~~~~~
-
-While ``python-telegram-bot`` is tested to work with Python 3.14 free threading, we do not guarantee that
-PTB is thread-safe for all use cases. Please see issue `#4873 <https://github.com/python-telegram-bot/python-telegram-bot/issues/4873>`_ for more information.
-
-Contributing
-------------
-
-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/choose>`_.
-
-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
+-------
+Logging
 -------
 
-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>`_.
-Derivative 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.
+This library uses the ``logging`` module. To set up logging to standard output, put:
 
-.. _`GitHub releases page`: https://github.com/python-telegram-bot/python-telegram-bot/releases
+.. code:: python
+
+    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:
+
+.. code:: python
+
+    logger = logging.getLogger()
+    logger.setLevel(logging.INFO)
+
+If you want DEBUG logs instead:
+
+.. code:: python
+
+    logger.setLevel(logging.DEBUG)
+
+
+=============
+Documentation
+=============
+
+``python-telegram-bot``'s documentation lives at `pythonhosted.org <https://pythonhosted.org/python-telegram-bot/>`_.
+
+============
+Getting help
+============
+
+You can get help in several ways:
+
+1. We have a vibrant community of developers helping each other in our `Telegram group <https://telegram.me/pythontelegrambotgroup>`_. Join us!
+
+2. Our `Wiki pages <https://github.com/python-telegram-bot/python-telegram-bot/wiki/>`_ offer a growing amount of resources.
+
+3. You can ask for help on Stack Overflow using the `python-telegram-bot tag <https://stackoverflow.com/questions/tagged/python-telegram-bot>`_.
+
+4. As last resort, the developers are ready to help you with `serious issues <https://github.com/python-telegram-bot/python-telegram-bot/issues/new>`_.
+
+
+============
+Contributing
+============
+
+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 <https://github.com/python-telegram-bot/python-telegram-bot/issues/new>`_.
+
+=======
+License
+=======
+
+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.

changes/22.0_2025-03-15/4671.7B3boYRvHdGzsrZgkpKp7B.toml

@@ -1,19 +0,0 @@
-breaking = """This release removes all functionality that was deprecated in v20.x. This is in line with our :ref:`stability policy <stability-policy>`.
-This includes the following changes:
-
-- Removed ``filters.CHAT`` (all messages have an associated chat) and ``filters.StatusUpdate.USER_SHARED`` (use ``filters.StatusUpdate.USERS_SHARED`` instead).
-- Removed ``Defaults.disable_web_page_preview`` and ``Defaults.quote``. Use ``Defaults.link_preview_options`` and ``Defaults.do_quote`` instead.
-- Removed ``ApplicationBuilder.(get_updates_)proxy_url`` and ``HTTPXRequest.proxy_url``. Use ``ApplicationBuilder.(get_updates_)proxy`` and ``HTTPXRequest.proxy`` instead.
-- Removed the ``*_timeout`` arguments of ``Application.run_polling`` and ``Updater.start_webhook``. Instead, specify the values via ``ApplicationBuilder.get_updates_*_timeout``.
-- Removed ``constants.InlineQueryLimit.MIN_SWITCH_PM_TEXT_LENGTH``. Use ``constants.InlineQueryResultsButtonLimit.MAX_START_PARAMETER_LENGTH`` instead.
-- Removed the argument ``quote`` of ``Message.reply_*``. Use ``do_quote`` instead.
-- Removed the superfluous ``EncryptedPassportElement.credentials`` without replacement.
-- Changed attribute value of ``PassportFile.file_date`` from :obj:`int` to :class:`datetime.datetime`. Make sure to adjust your code accordingly.
-- Changed the attribute value of ``PassportElementErrors.file_hashes`` from :obj:`list` to :obj:`tuple`. Make sure to adjust your code accordingly.
-- Make ``BaseRequest.read_timeout`` an abstract property. If you subclass ``BaseRequest``, you need to implement this property.
-- The default value for ``write_timeout`` now defaults to ``DEFAULT_NONE`` also for bot methods that send media. Previously, it was ``20``. If you subclass ``BaseRequest``, make sure to use your desired write timeout if ``RequestData.multipart_data`` is set.
-"""
-[[pull_requests]]
-uid = "4671"
-author_uid = "Bibo-Joshi"
-closes_threads = ["4659"]

changes/22.0_2025-03-15/4672.G9szuJ7pRafycByfem2DrT.toml

@@ -1,5 +0,0 @@
-documentation = "Add `chango <https://chango.readthedocs.io/stable/>`_ As Changelog Management Tool"
-[[pull_requests]]
-uid = "4672"
-author_uid = "Bibo-Joshi"
-closes_threads = ["4321"]

changes/22.0_2025-03-15/4697.GzyGCEgj74G6bTEDbuFjUU.toml

@@ -1,5 +0,0 @@
-internal = "Bump github/codeql-action from 3.28.8 to 3.28.10"
-[[pull_requests]]
-uid = "4697"
-author_uid = "dependabot"
-closes_threads = []

changes/22.0_2025-03-15/4698.Fkzr3oU2qcFmFX28xfoja5.toml

@@ -1,5 +0,0 @@
-internal = "Bump srvaroa/labeler from 1.12.0 to 1.13.0"
-[[pull_requests]]
-uid = "4698"
-author_uid = "dependabot"
-closes_threads = []

changes/22.0_2025-03-15/4699.LYAYfKXX7C7wqT54kRPnVy.toml

@@ -1,5 +0,0 @@
-internal = "Bump astral-sh/setup-uv from 5.2.2 to 5.3.1"
-[[pull_requests]]
-uid = "4699"
-author_uid = "dependabot"
-closes_threads = []

changes/22.0_2025-03-15/4700.nm6R6YTnkmCo5evbykz4kz.toml

@@ -1,5 +0,0 @@
-internal = "Bump Bibo-Joshi/chango from 0.3.1 to 0.3.2"
-[[pull_requests]]
-uid = "4700"
-author_uid = "dependabot"
-closes_threads = []

changes/22.0_2025-03-15/4701.ah8Wi4SWc22EbgBc4KQeqH.toml

@@ -1,5 +0,0 @@
-internal = "Bump pypa/gh-action-pypi-publish from 1.12.3 to 1.12.4"
-[[pull_requests]]
-uid = "4701"
-author_uid = "dependabot"
-closes_threads = []

changes/22.0_2025-03-15/4709.dbwPVaU8vSacVkMLhiMjyJ.toml

@@ -1,5 +0,0 @@
-internal = "Bump pytest from 8.3.4 to 8.3.5"
-[[pull_requests]]
-uid = "4709"
-author_uid = "dependabot"
-closes_threads = []

changes/22.0_2025-03-15/4710.CSNixpvxJdLFaM6xSQ39Zf.toml

@@ -1,5 +0,0 @@
-internal = "Bump sphinx from 8.1.3 to 8.2.3"
-[[pull_requests]]
-uid = "4710"
-author_uid = "dependabot"
-closes_threads = []

changes/22.0_2025-03-15/4712.8ckkAPAXGzedityWEyv363.toml

@@ -1,5 +0,0 @@
-internal = "Bump Bibo-Joshi/chango from 0.3.2 to 0.4.0"
-[[pull_requests]]
-uid = "4712"
-author_uid = "Bibo-Joshi"
-closes_threads = []

changes/22.0_2025-03-15/4719.d4xMztC8JjrbVgEscxvMWX.toml

@@ -1,5 +0,0 @@
-internal = "Bump Version to v22.0"
-[[pull_requests]]
-uid = "4719"
-author_uid = "Bibo-Joshi"
-closes_threads = []

changes/22.1_2025-05-15/4692.dVZs28GuwTFnNJdWkvPbNv.toml

@@ -1,5 +0,0 @@
-breaking = "Drop backward compatibility for ``user_id`` in ``send_gift`` by updating the order of parameters. Please adapt your code accordingly or use keyword arguments."
-[[pull_requests]]
-uid = "4692"
-author_uid = "Bibo-Joshi"
-closes_threads = []

changes/22.1_2025-05-15/4730.GsSUQSXzV8TF2Wav4CXRdd.toml

@@ -1,9 +0,0 @@
-documentation = "Documentation Improvements. Among others, add missing ``Returns`` field in ``User.get_profile_photos``"
-[[pull_requests]]
-uid = "4730"
-author_uid = "Bibo-Joshi"
-closes_threads = []
-[[pull_requests]]
-uid = "4740"
-author_uid = "aelkheir"
-closes_threads = []

changes/22.1_2025-05-15/4733.BRLwsEuh76974FPJRuiBjf.toml

@@ -1,5 +0,0 @@
-bugfixes = "Ensure execution of ``Bot.shutdown()`` even if ``Bot.get_me()`` fails in ``Bot.initialize()``"
-[[pull_requests]]
-uid = "4733"
-author_uid = "Poolitzer"
-closes_threads = []

changes/22.1_2025-05-15/4741.nVLBrFX4p8jTCBjMRqaYoQ.toml

@@ -1,5 +0,0 @@
-internal = "Bump codecov/test-results-action from 1.0.2 to 1.1.0"
-[[pull_requests]]
-uid = "4741"
-author_uid = "dependabot"
-closes_threads = []

changes/22.1_2025-05-15/4742.oEA6MjYXMafdbu2akWT5tC.toml

@@ -1,5 +0,0 @@
-internal = "Bump actions/setup-python from 5.4.0 to 5.5.0"
-[[pull_requests]]
-uid = "4742"
-author_uid = "dependabot"
-closes_threads = []

changes/22.1_2025-05-15/4743.SpMm4vvAMjEreykTcGwzcF.toml

@@ -1,5 +0,0 @@
-internal = "Bump github/codeql-action from 3.28.10 to 3.28.13"
-[[pull_requests]]
-uid = "4743"
-author_uid = "dependabot"
-closes_threads = []

changes/22.1_2025-05-15/4744.a4tsF64kZPA2noP7HtTzTX.toml

@@ -1,5 +0,0 @@
-internal = "Bump astral-sh/setup-uv from 5.3.1 to 5.4.1"
-[[pull_requests]]
-uid = "4744"
-author_uid = "dependabot"
-closes_threads = []

changes/22.1_2025-05-15/4745.emNmhxtvtTP9uLNQxpcVSj.toml

@@ -1,5 +0,0 @@
-internal = "Bump actions/download-artifact from 4.1.8 to 4.2.1"
-[[pull_requests]]
-uid = "4745"
-author_uid = "dependabot"
-closes_threads = []

changes/22.1_2025-05-15/4746.gWnX3BCxbvujQ8B2QejtTK.toml

@@ -1,5 +0,0 @@
-internal = "Reenable ``test_official`` Blocked by Debug Remnant"
-[[pull_requests]]
-uid = "4746"
-author_uid = "aelkheir"
-closes_threads = []

changes/22.1_2025-05-15/4747.MLmApvpGdwN7J24j7fXsDU.toml

@@ -1,5 +0,0 @@
-documentation = "Update ``AUTHORS.rst``, Adding `@aelkheir <https://github.com/aelkheir>`_ to Active Development Team"
-[[pull_requests]]
-uid = "4747"
-author_uid = "Bibo-Joshi"
-closes_threads = []

changes/22.1_2025-05-15/4748.j3cKusZZKqTLbc542K4sqJ.toml

@@ -1,5 +0,0 @@
-internal = "Bump `pre-commit` Hooks to Latest Versions"
-[[pull_requests]]
-uid = "4748"
-author_uid = "pre-commit-ci"
-closes_threads = []

changes/22.1_2025-05-15/4756.JT5nmUmGRG6qDEh5ScMn5f.toml

@@ -1,51 +0,0 @@
-features = "Full Support for Bot API 9.0"
-deprecations = """This release comes with several deprecations, in line with our :ref:`stability policy <stability-policy>`.
-This includes the following:
-
-- Deprecated ``telegram.constants.StarTransactionsLimit.NANOSTAR_MIN_AMOUNT`` and ``telegram.constants.StarTransactionsLimit.NANOSTAR_MAX_AMOUNT``. These members will be replaced by ``telegram.constants.NanostarLimit.MIN_AMOUNT`` and ``telegram.constants.NanostarLimit.MAX_AMOUNT``.
-- Deprecated the class ``telegram.constants.StarTransactions``. Its only member ``telegram.constants.StarTransactions.NANOSTAR_VALUE`` will be replaced by ``telegram.constants.Nanostar.VALUE``.
-- Bot API 9.0 deprecated ``BusinessConnection.can_reply`` in favor of ``BusinessConnection.rights``
-- Bot API 9.0 deprecated ``ChatFullInfo.can_send_gift`` in favor of ``ChatFullInfo.accepted_gift_types``.
-- Bot API 9.0 introduced these new required fields to existing classes:
-  - ``TransactionPartnerUser.transaction_type``
-  - ``ChatFullInfo.accepted_gift_types``
-
-  Passing these values as positional arguments is deprecated. We encourage you to use keyword arguments instead, as the the signature will be updated in a future release.
-
-These deprecations are backward compatible, but we strongly recommend to update your code to use the new members.
-"""
-[[pull_requests]]
-uid = "4756"
-author_uid = "Bibo-Joshi"
-closes_threads = ["4754"]
-[[pull_requests]]
-uid = "4757"
-author_uid = "Bibo-Joshi"
-closes_threads = []
-[[pull_requests]]
-uid = "4759"
-author_uid = "Bibo-Joshi"
-closes_threads = []
-[[pull_requests]]
-uid = "4763"
-author_uid = "aelkheir"
-closes_threads = []
-[[pull_requests]]
-uid = "4766"
-author_uid = "Bibo-Joshi"
-[[pull_requests]]
-uid = "4769"
-author_uid = "aelkheir"
-closes_threads = []
-[[pull_requests]]
-uid = "4773"
-author_uid = "aelkheir"
-closes_threads = []
-[[pull_requests]]
-uid = "4781"
-author_uid = "aelkheir"
-closes_threads = []
-[[pull_requests]]
-uid = "4782"
-author_uid = "Bibo-Joshi"
-closes_threads = []

changes/22.1_2025-05-15/4758.dSyCdBJWEJroH2GynR2VaJ.toml

@@ -1,5 +0,0 @@
-internal = "Fine-tune ``chango`` and release workflows"
-[[pull_requests]]
-uid = "4758"
-author_uid = "Bibo-Joshi"
-closes_threads = ["4720"]

changes/22.1_2025-05-15/4761.mmsngFA6b4ccdEzEpFTZS3.toml

@@ -1,6 +0,0 @@
-bugfixes = "Fix Handling of ``Defaults`` for ``InputPaidMedia``"
-
-[[pull_requests]]
-uid = "4761"
-author_uid = "ngrogolev"
-closes_threads = ["4753"]

changes/22.1_2025-05-15/4762.PbcJGM8KPBMbKri3fdHKjh.toml

@@ -1,5 +0,0 @@
-documentation = "Clarify Documentation and Type Hints of ``InputMedia`` and ``InputPaidMedia``. Note that the ``media`` parameter accepts only objects of type ``str`` and ``InputFile``. The respective subclasses of ``Input(Paid)Media`` each accept a broader range of input type for the ``media`` parameter."
-[[pull_requests]]
-uid = "4762"
-author_uid = "Bibo-Joshi"
-closes_threads = []

changes/22.1_2025-05-15/4775.kkLon84t7Vy5REKRe9LwPH.toml

@@ -1,5 +0,0 @@
-internal = "Bump codecov/codecov-action from 5.1.2 to 5.4.2"
-[[pull_requests]]
-uid = "4775"
-author_uid = "dependabot"
-closes_threads = []

changes/22.1_2025-05-15/4776.g83DxRk4WVWCC8rCd6ocFC.toml

@@ -1,5 +0,0 @@
-internal = "Bump actions/upload-artifact from 4.5.0 to 4.6.2"
-[[pull_requests]]
-uid = "4776"
-author_uid = "dependabot"
-closes_threads = []

changes/22.1_2025-05-15/4777.Lhgz8xFtQjgrKM2KvNfxwD.toml

@@ -1,5 +0,0 @@
-internal = "Bump stefanzweifel/git-auto-commit-action from 5.1.0 to 5.2.0"
-[[pull_requests]]
-uid = "4777"
-author_uid = "dependabot"
-closes_threads = []

changes/22.1_2025-05-15/4778.CeUSPNLbGGsqP2Vo4xKkdp.toml

@@ -1,5 +0,0 @@
-internal = "Bump github/codeql-action from 3.28.13 to 3.28.16"
-[[pull_requests]]
-uid = "4778"
-author_uid = "dependabot"
-closes_threads = []

changes/22.1_2025-05-15/4779.UqcbJVKYxwTtrBEGDgb3VS.toml

@@ -1,5 +0,0 @@
-internal = "Bump actions/download-artifact from 4.2.1 to 4.3.0"
-[[pull_requests]]
-uid = "4779"
-author_uid = "dependabot"
-closes_threads = []

changes/22.1_2025-05-15/4791.QycEvQbiaiJKraKDhAfFWM.toml

@@ -1,5 +0,0 @@
-other = "Bump Version to v22.1"
-[[pull_requests]]
-uid = "4791"
-author_uid = "Bibo-Joshi"
-closes_threads = []

changes/22.2_2025-06-29/4750.jJBu7iAgZa96hdqcpHK96W.toml

@@ -1,36 +0,0 @@
-features = "Use `timedelta` to represent time periods in class arguments and attributes"
-deprecations = """In this release, we're migrating attributes of Telegram objects that represent durations/time periods from having :obj:`int` type to Python's native :class:`datetime.timedelta`. This change is opt-in for now to allow for a smooth transition phase. It will become opt-out in future releases.
-
-Set ``PTB_TIMEDELTA=true`` or ``PTB_TIMEDELTA=1`` as an environment variable to make these attributes return :obj:`datetime.timedelta` objects instead of integers. Support for :obj:`int` values is deprecated and will be removed in a future major version.
-
-Affected Attributes:
-- :attr:`telegram.ChatFullInfo.slow_mode_delay` and :attr:`telegram.ChatFullInfo.message_auto_delete_time`
-- :attr:`telegram.Animation.duration`
-- :attr:`telegram.Audio.duration`
-- :attr:`telegram.Video.duration` and :attr:`telegram.Video.start_timestamp`
-- :attr:`telegram.VideoNote.duration`
-- :attr:`telegram.Voice.duration`
-- :attr:`telegram.PaidMediaPreview.duration`
-- :attr:`telegram.VideoChatEnded.duration`
-- :attr:`telegram.InputMediaVideo.duration`
-- :attr:`telegram.InputMediaAnimation.duration`
-- :attr:`telegram.InputMediaAudio.duration`
-- :attr:`telegram.InputPaidMediaVideo.duration`
-- :attr:`telegram.InlineQueryResultGif.gif_duration`
-- :attr:`telegram.InlineQueryResultMpeg4Gif.mpeg4_duration`
-- :attr:`telegram.InlineQueryResultVideo.video_duration`
-- :attr:`telegram.InlineQueryResultAudio.audio_duration`
-- :attr:`telegram.InlineQueryResultVoice.voice_duration`
-- :attr:`telegram.InlineQueryResultLocation.live_period`
-- :attr:`telegram.Poll.open_period`
-- :attr:`telegram.Location.live_period`
-- :attr:`telegram.MessageAutoDeleteTimerChanged.message_auto_delete_time`
-- :attr:`telegram.ChatInviteLink.subscription_period`
-- :attr:`telegram.InputLocationMessageContent.live_period`
-- :attr:`telegram.error.RetryAfter.retry_after`
-"""
-internal = "Modify `test_official` to handle time periods as timedelta automatically."
-[[pull_requests]]
-uid = "4750"
-author_uid = "aelkheir"
-closes_threads = ["4575"]

changes/22.2_2025-06-29/4792.YsK6LmbEhZv6y3dvhHbXD7.toml

@@ -1,5 +0,0 @@
-internal = "Fix Bug in Automated Channel Announcement"
-[[pull_requests]]
-uid = "4792"
-author_uid = "Bibo-Joshi"
-closes_threads = []

changes/22.2_2025-06-29/4793.mDR5p3mrSmPFQkvWFGWBmD.toml

@@ -1,5 +0,0 @@
-internal = "Fix a Failing Test Case"
-[[pull_requests]]
-uid = "4793"
-author_uid = "Bibo-Joshi"
-closes_threads = []

changes/22.2_2025-06-29/4798.g7G3jRf2ns4ath9LRFEcit.toml

@@ -1,5 +0,0 @@
-internal = "Rework Repository to `src` Layout"
-[[pull_requests]]
-uid = "4798"
-author_uid = "Bibo-Joshi"
-closes_threads = ["4797"]

changes/22.2_2025-06-29/4800.2Z9Q8uvzdU2TqMJ9biBLam.toml

@@ -1,5 +0,0 @@
-dependencies = "Implement PEP 735 Dependency Groups for Development Dependencies"
-[[pull_requests]]
-uid = "4800"
-author_uid = "harshil21"
-closes_threads = ["4795"]

changes/22.2_2025-06-29/4801.feKaYKKZTZq2KBjhyxVVAM.toml

@@ -1,5 +0,0 @@
-dependencies = "Update cachetools requirement from <5.6.0,>=5.3.3 to >=5.3.3,<6.1.0"
-[[pull_requests]]
-uid = "4801"
-author_uid = "dependabot"
-closes_threads = []

changes/22.2_2025-06-29/4802.RMLufX4UazobYg5aZojyoD.toml

@@ -1,14 +0,0 @@
-bugfixes = """
-Fixed a bug where calling ``Application.remove/add_handler`` during update handling can cause a ``RuntimeError`` in ``Application.process_update``.
-
-.. hint::
-    Calling ``Application.add/remove_handler`` now has no influence on calls to ``process_update`` that are
-    already in progress. The same holds for ``Application.add/remove_error_handler`` and ``Application.process_error``, respectively.
-
-    .. warning::
-        This behavior should currently be considered an implementation detail and not as guaranteed behavior.
-"""
-[[pull_requests]]
-uid = "4802"
-author_uid = "Bibo-Joshi"
-closes_threads = ["4803"]

changes/22.2_2025-06-29/4810.KyRnffWk3ARyQFNcF88Uh3.toml

@@ -1,20 +0,0 @@
-documentation = """Documentation Improvements. Among other things
-
-* mention alternative package managers in README and contribution guide
-* remove ``furo-sphinx-search``
-"""
-
-[[pull_requests]]
-uid = "4810"
-author_uid = "Bibo-Joshi"
-closes_threads = []
-
-[[pull_requests]]
-uid = "4824"
-author_uid = "Aweryc"
-closes_threads = ["4823"]
-
-[[pull_requests]]
-uid = "4826"
-author_uid = "harshil21"
-closes_threads = []

changes/22.2_2025-06-29/4811.TQgVr5Sa6uDFtWXdTS5wfw.toml

@@ -1,5 +0,0 @@
-internal = "Bump github/codeql-action from 3.28.16 to 3.28.18"
-[[pull_requests]]
-uid = "4811"
-author_uid = "dependabot"
-closes_threads = []

changes/22.2_2025-06-29/4812.i4aqsTfCkdEs8uYNYS59si.toml

@@ -1,5 +0,0 @@
-internal = "Bump actions/setup-python from 5.5.0 to 5.6.0"
-[[pull_requests]]
-uid = "4812"
-author_uid = "dependabot"
-closes_threads = []

changes/22.2_2025-06-29/4813.cnbzL2eSRzj3i9NcUMFyFo.toml

@@ -1,5 +0,0 @@
-internal = "Bump dependabot/fetch-metadata from 2.3.0 to 2.4.0"
-[[pull_requests]]
-uid = "4813"
-author_uid = "dependabot"
-closes_threads = []

changes/22.2_2025-06-29/4814.RMQVXTNywcpBQ3HkX2TuyA.toml

@@ -1,5 +0,0 @@
-internal = "Bump codecov/codecov-action from 5.4.2 to 5.4.3"
-[[pull_requests]]
-uid = "4814"
-author_uid = "dependabot"
-closes_threads = []

changes/22.2_2025-06-29/4815.9dLSFHFozQiAM7oCpX4NyL.toml

@@ -1,5 +0,0 @@
-internal = "Bump codecov/test-results-action from 1.1.0 to 1.1.1"
-[[pull_requests]]
-uid = "4815"
-author_uid = "dependabot"
-closes_threads = []

changes/22.2_2025-06-29/4816.hhYVDfdzUgoQoMNRKkCDjb.toml

@@ -1,5 +0,0 @@
-internal = "Fix Typo in `TelegramObject._get_attrs`"
-[[pull_requests]]
-uid = "4816"
-author_uid = "harshil21"
-closes_threads = []

changes/22.2_2025-06-29/4817.ZHx38jvj9zKRNZfQh9Xrpb.toml

@@ -1,5 +0,0 @@
-bugfixes = "Allow for pattern matching empty inline queries"
-[[pull_requests]]
-uid = "4817"
-author_uid = "locobott"
-closes_threads = []

changes/22.2_2025-06-29/4818.3VPDqqEWEhDCrTipFY8KKU.toml

@@ -1,12 +0,0 @@
-bugfixes = """
-Correctly parse parameter ``allow_sending_without_reply`` in ``Message.reply_*`` when used in combination with ``do_quote=True``.
-
-.. hint::
-
-   Using ``dict`` valued input for ``do_quote`` along with passing ``allow_sending_without_reply`` is not supported and will raise an error.
-"""
-
-[[pull_requests]]
-uid = "4818"
-author_uid = "Bibo-Joshi"
-closes_threads = ["4807"]

changes/22.2_2025-06-29/4820.7bFkjLSeWKdNVhThPpVMAT.toml

@@ -1,5 +0,0 @@
-dependencies = "Bump ``httpx`` from ~=0.27 to >=0.27,<0.29"
-[[pull_requests]]
-uid = "4820"
-author_uid = "Bibo-Joshi"
-closes_threads = ["4819"]

changes/22.2_2025-06-29/4822.DrW3tJ3KoB8kTmHtNnNEpQ.toml

@@ -1,5 +0,0 @@
-other = "Improve Informativeness of Network Errors Raised by ``BaseRequest.post/retrieve``"
-
-[[pull_requests]]
-uid = "4822"
-author_uid = "Bibo-Joshi"

changes/22.2_2025-06-29/4825.R7wiTzvN37KAV656s9kfnC.toml

@@ -1,5 +0,0 @@
-other = "Add Python 3.14 Beta To Test Matrix. *Python 3.14 is not officially supported by PTB yet!*"
-[[pull_requests]]
-uid = "4825"
-author_uid = "harshil21"
-closes_threads = []

changes/22.2_2025-06-29/4830.EZzGEAk7DiFuedKPoQMMvd.toml

@@ -1,5 +0,0 @@
-dependencies = "Update ``cachetools`` requirement from <6.1.0,>=5.3.3 to >=5.3.3,<6.2.0"
-
-[[pull_requests]]
-uid = "4830"
-author_uid = "dependabot"

changes/22.2_2025-06-29/4834.oBWsiGWNMuoSXvJNom6N6A.toml

@@ -1,5 +0,0 @@
-other = "Bump Version to v22.2"
-[[pull_requests]]
-uid = "4834"
-author_uid = "Bibo-Joshi"
-closes_threads = []

changes/22.3_2025-07-20/4837.cVTsY7pxfQqgVXfFW9hgZK.toml

@@ -1,6 +0,0 @@
-internal = "Update API Token for Local Testing Bot"
-
-[[pull_requests]]
-uid = "4837"
-author_uid = "Bibo-Joshi"
-closes_threads = []

changes/22.3_2025-07-20/4839.gExNhF7C6kR5VrBg6cBaar.toml

@@ -1,5 +0,0 @@
-documentation = "Documentation Improvements. Among others, fix links to source code."
-[[pull_requests]]
-uid = "4839"
-author_uid = "aelkheir"
-closes_threads = ["4838"]

changes/22.3_2025-07-20/4840.jz9uGugc5DUd8x8pQHPyzg.toml

@@ -1,5 +0,0 @@
-internal = "Bump stefanzweifel/git-auto-commit-action from 5.2.0 to 6.0.1"
-[[pull_requests]]
-uid = "4840"
-author_uid = "dependabot"
-closes_threads = []

changes/22.3_2025-07-20/4841.HHVCCXXZbYAaaQVmKHCJm2.toml

@@ -1,5 +0,0 @@
-internal = "Bump github/codeql-action from 3.28.18 to 3.29.2"
-[[pull_requests]]
-uid = "4841"
-author_uid = "dependabot"
-closes_threads = []

changes/22.3_2025-07-20/4842.PSW9ZbxENhwfRhbSfemCwE.toml

@@ -1,5 +0,0 @@
-internal = "Bump astral-sh/setup-uv from 5.4.1 to 6.3.1"
-[[pull_requests]]
-uid = "4842"
-author_uid = "dependabot"
-closes_threads = []

changes/22.3_2025-07-20/4843.f5aZ5Vpxevw8fEEudawU5u.toml

@@ -1,5 +0,0 @@
-internal = "Bump sigstore/gh-action-sigstore-python from 3.0.0 to 3.0.1"
-[[pull_requests]]
-uid = "4843"
-author_uid = "dependabot"
-closes_threads = []

changes/22.3_2025-07-20/4847.8ujbbBbaZ2VTEdRLeqirSZ.toml

@@ -1,18 +0,0 @@
-highlights = "Full Support for Bot API 9.1"
-
-features = """
-New filters based on Bot API 9.1:
-
-* ``filters.StatusUpdate.DIRECT_MESSAGE_PRICE_CHANGED`` for ``Message.direct_message_price_changed``
-* ``filters.StatusUpdate.CHECKLIST_TASKS_ADDED`` for ``Message.checklist_tasks_added``
-* ``filters.StatusUpdate.CHECKLIST_TASKS_DONE`` for ``Message.checklist_tasks_done``
-* ``filters.CHECKLIST`` for ``Message.checklist``
-"""
-
-pull_requests = [
-  { uid = "4847", author_uid = "Bibo-Joshi", closes_threads = ["4845"] },
-  { uid = "4848", author_uid = "Bibo-Joshi" },
-  { uid = "4849", author_uid = "harshil21" },
-  { uid = "4851", author_uid = "harshil21" },
-  { uid = "4857", author_uid = "aelkheir" },
-]

changes/22.3_2025-07-20/4852.mz3RDjX636ZdGoR456C6v9.toml

@@ -1,11 +0,0 @@
-breaking = """Remove Functionality Deprecated in API 9.0
-
-* Remove deprecated argument and attribute ``BusinessConnection.can_reply``.
-* Remove deprecated argument and attribute ``ChatFullInfo.can_send_gift``
-* Remove deprecated class ``constants.StarTransactions``. Please instead use :attr:`telegram.constants.Nanostar.VALUE`.
-* Remove deprecated attributes ``constants.StarTransactionsLimit.NANOSTAR_MIN_AMOUNT`` and ``constants.StarTransactionsLimit.NANOSTAR_MAX_AMOUNT``. Please instead use :attr:`telegram.constants.NanostarLimit.MIN_AMOUNT` and :attr:`telegram.constants.NanostarLimit.MAX_AMOUNT`.
-"""
-[[pull_requests]]
-uid = "4852"
-author_uid = "aelkheir"
-closes_threads = []

changes/22.3_2025-07-20/4855.8hCFRFMeMaRWpBEYaxrTMq.toml

@@ -1,5 +0,0 @@
-other= "Make Gender Input Case-Insensitive in ``conversationbot.py``"
-[[pull_requests]]
-uid = "4855"
-author_uid = "fengxiaohu"
-closes_threads = ["4846"]