CHANGES.rst: cosmetic fix

[ci skip]
Bump version to v7.0.0
2026-06-21 08:35:28 +00:00 · 2017-07-25 23:07:26 +03:00 · 2017-07-25 22:53:20 +03:00 · 2017-07-25 22:48:18 +03:00 · 2017-07-25 22:37:58 +03:00 · 2017-07-25 22:33:28 +03:00
355 changed files with 17522 additions and 7271 deletions
@@ -1,5 +1,8 @@
 [run]
 source = telegram
+omit = telegram/vendor/*

 [report]
-omit = tests/
+omit =
+    tests/
+    telegram/vendor/*
@@ -12,7 +12,7 @@ Setting things up

   .. code-block:: bash

-      $ git clone https://github.com/<your username>/python-telegram-bot
+      $ git clone https://github.com/<your username>/python-telegram-bot --recursive
      $ cd python-telegram-bot

 3. Add a track to the original repository:
@@ -85,6 +85,12 @@ Here's how to make a one-off code change.

        $ make test

+     If you don't have ``make``, do:
+
+     .. code-block::
+
+        $ nosetests -v
+
   - To actually make the commit (this will trigger tests for yapf, lint and pep8 automatically):

     .. code-block:: bash
@@ -184,11 +190,11 @@ break the API classes. For example:
 .. code-block:: python

    # GOOD
-    def __init__(self, id, name, **kwargs):
-       self.last_name = kwargs.get('last_name', '')
+    def __init__(self, id, name, last_name=None, **kwargs):
+       self.last_name = last_name

    # BAD
-    def __init__(self, id, name, last_name=''):
+    def __init__(self, id, name, last_name=None):
       self.last_name = last_name


@@ -1,6 +1,15 @@
 <!--
 Thanks for reporting issues of python-telegram-bot!
+
+Use this template to notify us if you found a bug, or if you want to request a new feature.
+If you're looking for help with programming your bot using our library, feel free to ask your
+questions in out telegram group at: https://t.me/pythontelegrambotgroup
+
 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.
@@ -19,13 +28,9 @@ Tell us what happens instead
 **Operating System:**


-**Version of Python:**
+**Version of Python, python-telegram-bot & dependencies:**

-``$ python -V``
-
-**Version of python-telegram-bot:**
-
-``$ python -c 'import telegram; print(telegram.__version__)'``
+``$ python -m telegram``

 ### Logs
 Insert logs here (if necessary)
@@ -65,6 +65,14 @@ target/
 # unitests files
 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
@@ -0,0 +1,4 @@
+[submodule "telegram/vendor/urllib3"]
+	path = telegram/vendor/ptb_urllib3
+	url = https://github.com/python-telegram-bot/urllib3.git
+	branch = ptb
@@ -1,15 +1,17 @@
-   repo: git://github.com/pre-commit/mirrors-yapf
-    sha: 316b795b2f32cbe80047aff7e842b72368d5a2c1
+-   repo: git://github.com/python-telegram-bot/mirrors-yapf
+    sha: master
    hooks:
    -   id: yapf
        files: ^(telegram|tests)/.*\.py$
+        args:
+        - --diff
 -   repo: git://github.com/pre-commit/pre-commit-hooks
-    sha: 3fa02652357ff0dbb42b5bc78c673b7bc105fcf3
+    sha: 78818b90cd694c29333ba54d38f9e60b6359ccfc
    hooks:
    -   id: flake8
        files: ^telegram/.*\.py$
 -   repo: git://github.com/pre-commit/mirrors-pylint
-    sha: 4de6c8dfadef1a271a814561ce05b8bc1c446d22
+    sha: v1.7.1
    hooks:
    -   id: pylint
        files: ^telegram/.*\.py$
@@ -0,0 +1,9 @@
+# syntax: https://docs.readthedocs.io/en/latest/yaml-config.html
+
+formats:
+    - pdf
+
+python:
+   setup_py_install: true
+
+requirements_file: docs/requirements-docs.txt
@@ -1,18 +1,35 @@
 language: python
 python:
-  - "2.6"
  - "2.7"
  - "3.3"
  - "3.4"
  - "3.5"
-  - "pypy"
-  - "pypy3"
+  - "3.6"
+  - "pypy-5.7.1"
+  - "pypy3.5-5.8.0"
+
+dist: trusty
+sudo: false
+
+branches:
+  only:
+    - master
+
+cache:
+  directories:
+    - $HOME/.cache/pip
+before_cache:
+  - rm -f $HOME/.cache/pip/log/debug.log
+
 install:
  - pip install coveralls
+  - pip install -U wheel
  - 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 != 2.6 ] && [ $TRAVIS_PYTHON_VERSION != 3.3 ] && [ $TRAVIS_PYTHON_VERSION != pypy3 ]; then pre-commit run --all-files; fi'
+  - python travis.py
+
 after_success:
-  coveralls
+  coveralls
@@ -1,31 +1,63 @@
 Credits
 =======

-``python-telegram-bot`` is written and maintained by `Leandro Toledo <https://github.com/leandrotoledo>`_.
+``python-telegram-bot`` was originally created by
+`Leandro Toledo <https://github.com/leandrotoledo>`_ and is now maintained by
+`Jannes Höke <https://github.com/jh0ker>`_ (`@jh0ker <https://t.me/jh0ker>`_ on Telegram) and
+`Noam Meltzer <https://github.com/tsnoam>`_.
+
+We're vendoring urllib3 as part of ``python-telegram-bot`` which is distributed under the MIT
+license. For more info, full credits & license terms, the sources can be found here:
+`https://github.com/python-telegram-bot/urllib3`.

 Contributors
 ------------

 The following wonderful people contributed directly or indirectly to this project:

+- `Alateas <https://github.com/alateas>`_
 - `Avanatiker <https://github.com/Avanatiker>`_
+- `Anton Tagunov <https://github.com/anton-tagunov>`_
 - `Balduro <https://github.com/Balduro>`_
 - `bimmlerd <https://github.com/bimmlerd>`_
+- `d-qoi <https://github.com/d-qoi>`_
+- `daimajia <https://github.com/daimajia>`_
+- `Eli Gao <https://github.com/eligao>`_
 - `ErgoZ Riftbit Vaper <https://github.com/ergoz>`_
+- `Eugene Lisitsky <https://github.com/lisitsky>`_
+- `Eugenio Panadero <https://github.com/azogue>`_
+- `evgfilim1 <https://github.com/evgfilim1>`_
 - `franciscod <https://github.com/franciscod>`_
+- `Hugo Damer <https://github.com/HakimusGIT>`_
+- `Jacob Bom <https://github.com/bomjacob>`_
 - `JASON0916 <https://github.com/JASON0916>`_
+- `jeffffc <https://github.com/jeffffc>`_
+- `Jelle Besseling <https://github.com/pingiun>`_
 - `jh0ker <https://github.com/jh0ker>`_
+- `John Yong <https://github.com/whipermr5>`_
+- `jossalgon <https://github.com/jossalgon>`_
 - `JRoot3D <https://github.com/JRoot3D>`_
 - `jlmadurga <https://github.com/jlmadurga>`_
+- `Kjwon15 <https://github.com/kjwon15>`_
+- `Li-aung Yip <https://github.com/LiaungYip>`_
 - `macrojames <https://github.com/macrojames>`_
+- `Michael Elovskikh <https://github.com/wronglink>`_
 - `naveenvhegde <https://github.com/naveenvhegde>`_
+- `neurrone <https://github.com/neurrone>`_
 - `njittam <https://github.com/njittam>`_
 - `Noam Meltzer <https://github.com/tsnoam>`_
 - `Oleg Shlyazhko <https://github.com/ollmer>`_
+- `overquota <https://github.com/overquota>`_
+- `Patrick Hofmann <https://github.com/PH89>`_
+- `Pieter Schutz <https://github.com/eldinnie>`_
 - `Rahiel Kasim <https://github.com/rahiel>`_
+- `Joscha Götzer <https://github.com/Rostgnom>`_
+- `Sascha <https://github.com/saschalalala>`_
 - `Shelomentsev D <https://github.com/shelomentsevd>`_
 - `sooyhwang <https://github.com/sooyhwang>`_
+- `thodnev <https://github.com/thodnev>`_
 - `Valentijn <https://github.com/Faalentijn>`_
+- `voider1 <https://github.com/voider1>`_
 - `wjt <https://github.com/wjt>`_

 Please add yourself here alphabetically when you submit your first pull request.
@@ -2,12 +2,124 @@
 Changes
 =======

+**2017-07-25**
+*Released 7.0.0*
+
+- Fully support Bot API 3.2.
+- New filters for handling messages from specific chat/user id (PR #677).
+- Add the possibility to add objects as arguments to send_* methods (PR #742).
+- Fixed download of URLs with UTF-8 chars in path (PR #688).
+- Fixed URL parsing for ``Message`` text properties (PR #689).
+- Fixed args dispatching in ``MessageQueue``'s decorator (PR #705).
+- Fixed regression preventing IPv6 only hosts from connnecting to Telegram servers (Issue #720).
+- ConvesationHandler - check if a user exist before using it (PR #699).
+- Removed deprecated ``telegram.Emoji``.
+- Removed deprecated ``Botan`` import from ``utils`` (``Botan`` is still available through ``contrib``).
+- Removed deprecated ``ReplyKeyboardHide``.
+- Removed deprecated ``edit_message`` argument of ``bot.set_game_score``.
+- Internal restructure of files.
+- Improved documentation.
+- Improved unitests.
+
+**2017-06-18**
+
+*Released 6.1.0*
+
+- Fully support Bot API 3.0
+- Add more fine-grained filters for status updates
+- Bug fixes and other improvements
+
+**2017-05-29**
+
+*Released 6.0.3*
+
+- Faulty PyPI release
+
+**2017-05-29**
+
+*Released 6.0.2*
+
+- Avoid confusion with user's ``urllib3`` by renaming vendored ``urllib3`` to ``ptb_urllib3``
+
+**2017-05-19**
+
+*Released 6.0.1*
+
+- Add support for ``User.language_code``
+- Fix ``Message.text_html`` and ``Message.text_markdown`` for messages with emoji
+
+**2017-05-19**
+
+*Released 6.0.0*
+
+- Add support for Bot API 2.3.1
+- Add support for ``deleteMessage`` API method
+- New, simpler API for ``JobQueue`` - https://github.com/python-telegram-bot/python-telegram-bot/pull/484
+- Download files into file-like objects - https://github.com/python-telegram-bot/python-telegram-bot/pull/459
+- Use vendor ``urllib3`` to address issues with timeouts
+  - The default timeout for messages is now 5 seconds. For sending media, the default timeout is now 20 seconds.
+- String attributes that are not set are now ``None`` by default, instead of empty strings
+- Add ``text_markdown`` and ``text_html`` properties to ``Message`` - https://github.com/python-telegram-bot/python-telegram-bot/pull/507
+- Add support for Socks5 proxy - https://github.com/python-telegram-bot/python-telegram-bot/pull/518
+- Add support for filters in ``CommandHandler`` - https://github.com/python-telegram-bot/python-telegram-bot/pull/536
+- Add the ability to invert (not) filters - https://github.com/python-telegram-bot/python-telegram-bot/pull/552
+- Add ``Filters.group`` and ``Filters.private``
+- Compatibility with GAE via ``urllib3.contrib`` package - https://github.com/python-telegram-bot/python-telegram-bot/pull/583
+- Add equality rich comparision operators to telegram objects - https://github.com/python-telegram-bot/python-telegram-bot/pull/604
+- Several bugfixes and other improvements
+- Remove some deprecated code
+
+**2017-04-17**
+
+*Released 5.3.1*
+
+- Hotfix release due to bug introduced by urllib3 version 1.21
+
+**2016-12-11**
+
+*Released 5.3*
+
+- Implement API changes of November 21st (Bot API 2.3)
+- ``JobQueue`` now supports ``datetime.timedelta`` in addition to seconds
+- ``JobQueue`` now supports running jobs only on certain days
+- New ``Filters.reply`` filter
+- Bugfix for ``Message.edit_reply_markup``
+- Other bugfixes
+
+**2016-10-25**
+
+*Released 5.2*
+
+- Implement API changes of October 3rd (games update)
+- Add ``Message.edit_*`` methods
+- Filters for the ``MessageHandler`` can now be combined using bitwise operators (``& and |``)
+- Add a way to save user- and chat-related data temporarily
+- Other bugfixes and improvements
+
+**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``
+- Introduce ``telegram.constants`` - https://github.com/python-telegram-bot/python-telegram-bot/pull/342

 **2016-07-12**

@@ -1,9 +1,9 @@
 .. image:: https://github.com/python-telegram-bot/logos/blob/master/logo-text/png/ptb-logo-text_768.png?raw=true
   :align: center
-   :target: https://github.com/python-telegram-bot/logos
+   :target: https://python-telegram-bot.org
   :alt: python-telegram-bot Logo

-Not **just** a Python wrapper around the Telegram Bot API
+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>`_.

@@ -15,8 +15,12 @@ Not **just** a Python wrapper around the Telegram Bot API
   :target: https://pypi.python.org/pypi/python-telegram-bot
   :alt: Supported python versions

+.. image:: https://www.cpu.re/static/python-telegram-bot/downloads.svg
+   :target: https://www.cpu.re/static/python-telegram-bot/downloads-by-python-version.txt
+   :alt: PyPi Package Monthly Download
+
 .. image:: https://img.shields.io/badge/docs-latest-af1a97.svg
-   :target: https://pythonhosted.org/python-telegram-bot/
+   :target: https://python-telegram-bot.readthedocs.io/
   :alt: Documentation Status

 .. image:: https://img.shields.io/pypi/l/python-telegram-bot.svg
@@ -37,7 +41,7 @@ Not **just** a Python wrapper around the Telegram Bot API
   
 .. 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
+   :alt: Median time to resolve an issue

 .. image:: https://img.shields.io/badge/Telegram-Group-blue.svg
   :target: https://telegram.me/pythontelegrambotgroup
@@ -73,8 +77,7 @@ Introduction

 This library provides a pure Python interface for the
 `Telegram Bot API <https://core.telegram.org/bots/api>`_.
-It works with Python versions from 2.6+ (**Note:** Support for 2.6 will be dropped at some point
-this year. 2.7 will still be supported).
+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 a number of high-level classes to
@@ -85,7 +88,7 @@ make the development of bots easy and straightforward. These classes are contain
 Telegram API support
 ====================

-As of **28. May 2016**, all types and methods of the Telegram Bot API are supported.
+As of **23. July 2017**, all types and methods of the Telegram Bot API 3.2 are supported.

 ==========
 Installing
@@ -97,6 +100,20 @@ You can install or upgrade python-telegram-bot with:

    $ pip install python-telegram-bot --upgrade

+Or you can install from source with:
+
+.. code:: shell
+
+    $ git clone https://github.com/python-telegram-bot/python-telegram-bot --recursive
+    $ cd python-telegram-bot
+    $ python setup.py install
+    
+In case you have a previously cloned local repository already, you should initialize the added urllib3 submodule before installing with:
+
+.. code:: shell
+
+    $ git submodule update --init --recursive
+
 ===============
 Getting started
 ===============
@@ -109,7 +126,7 @@ Our Wiki contains a lot of resources to get you started with ``python-telegram-b
 Other references:

 - `Telegram API documentation <https://core.telegram.org/bots/api>`_
- `python-telegram-bot documentation <https://pythonhosted.org/python-telegram-bot/>`_
+- `python-telegram-bot documentation <https://python-telegram-bot.readthedocs.io/>`_

 -------------------
 Learning by example
@@ -117,21 +134,11 @@ Learning by example

 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`` (below), it is de facto the base for most of the bots out there. Best of all,
+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.

- `echobot2 <https://github.com/python-telegram-bot/python-telegram-bot/blob/master/examples/echobot2.py>`_ replies back messages.
-
- `inlinebot <https://github.com/python-telegram-bot/python-telegram-bot/blob/master/examples/inlinebot.py>`_ basic example of an `inline bot <https://core.telegram.org/bots/inline>`_.
-
- `state machine bot <https://github.com/python-telegram-bot/python-telegram-bot/blob/master/examples/state_machine_bot.py>`_ keeps the state for individual users, useful for multipart conversations.
-
- `timerbot <https://github.com/python-telegram-bot/python-telegram-bot/blob/master/examples/timerbot.py>`_ uses the ``JobQueue`` to send timed messages.
-
- `echobot <https://github.com/python-telegram-bot/python-telegram-bot/blob/master/examples/legacy/echobot.py>`_ uses only the pure API to echo messages.
-
-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.
+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.

 -------
 Logging
@@ -165,7 +172,7 @@ If you want DEBUG logs instead:
 Documentation
 =============

-``python-telegram-bot``'s documentation lives at `pythonhosted.org <https://pythonhosted.org/python-telegram-bot/>`_.
+``python-telegram-bot``'s documentation lives at `readthedocs.io <https://python-telegram-bot.readthedocs.io/>`_.

 ============
 Getting help
@@ -0,0 +1,31 @@
+environment:
+
+  matrix:
+    # For Python versions available on Appveyor, see
+    # http://www.appveyor.com/docs/installed-software#python
+    # The list here is complete (excluding Python 2.6, which
+    # isn't covered by this document) at the time of writing.
+
+    - PYTHON: "C:\\Python27"
+    - PYTHON: "C:\\Python33"
+    - PYTHON: "C:\\Python34"
+    - PYTHON: "C:\\Python35"
+    - PYTHON: "C:\\Python36"
+
+install:
+  # We need wheel installed to build wheels
+  - "git submodule update --init --recursive"
+  - "%PYTHON%\\python.exe -m pip install -U wheel"
+  - "%PYTHON%\\python.exe -m pip install -r requirements.txt"
+  - "%PYTHON%\\python.exe -m pip install -r requirements-dev.txt"
+
+build: off
+
+cache: C:\Users\appveyor\pip\wheels
+
+test_script:
+  - "%python%\\Scripts\\nosetests -v --with-flaky --no-flaky-report tests"
+
+after_test:
+  # This step builds your wheels.
+  - "%PYTHON%\\python.exe setup.py bdist_wheel"
@@ -1,3 +1,3 @@
-sphinx
+sphinx>=1.5.4
 sphinx_rtd_theme
 sphinx-pypi-upload
@@ -11,11 +11,10 @@
 #
 # All configuration values have a default; values that are commented out
 # serve to show the default.
-
 import sys
 import os
 import shlex
-import telegram
+# import telegram

 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
@@ -25,7 +24,7 @@ sys.path.insert(0, os.path.abspath('../..'))
 # -- General configuration ------------------------------------------------

 # If your documentation needs a minimal Sphinx version, state it here.
-#needs_sphinx = '1.0'
+needs_sphinx = '1.5.4'  # fixes issues with autodoc-skip-member and napoleon

 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
@@ -51,7 +50,7 @@ master_doc = 'index'

 # General information about the project.
 project = u'Python Telegram Bot'
-copyright = u'2015-2016, Leandro Toledo'
+copyright = u'2015-2017, Leandro Toledo'
 author = u'Leandro Toledo'

 # The version info for the project you're documenting, acts as replacement for
@@ -59,9 +58,9 @@ author = u'Leandro Toledo'
 # built documents.
 #
 # The short X.Y version.
-version = telegram.__version__[:3]
+version = '7.0'  # telegram.__version__[:3]
 # The full version, including alpha/beta/rc tags.
-release = telegram.__version__
+release = '7.0.0'  # telegram.__version__

 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -131,12 +130,12 @@ html_theme = 'sphinx_rtd_theme'

 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
-#html_logo = None
+html_logo = 'ptb-logo-orange.png'

 # The name of an image file (within the static path) to use as favicon of the
 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 # pixels large.
-#html_favicon = None
+html_favicon = 'ptb-logo-orange.ico'

 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
@@ -209,14 +208,17 @@ htmlhelp_basename = 'PythonTelegramBotdoc'
 # -- Options for LaTeX output ---------------------------------------------

 latex_elements = {
+
 # The paper size ('letterpaper' or 'a4paper').
-#'papersize': 'letterpaper',
+    'papersize': 'a4paper',

 # The font size ('10pt', '11pt' or '12pt').
 #'pointsize': '10pt',

 # Additional stuff for the LaTeX preamble.
-#'preamble': '',
+    'preamble': r'''\setcounter{tocdepth}{2}
+\usepackage{enumitem}
+\setlistdepth{99}''',

 # Latex figure (float) alignment
 #'figure_align': 'htbp',
@@ -227,12 +229,12 @@ latex_elements = {
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
  (master_doc, 'PythonTelegramBot.tex', u'Python Telegram Bot Documentation',
-   u'Leandro Toledo', 'manual'),
+   author, 'manual'),
 ]

 # The name of an image file (relative to this directory) to place at the top of
 # the title page.
-#latex_logo = None
+latex_logo = 'ptb-logo_1024.png'

 # For "manual" documents, if this is true, then toplevel headings are parts,
 # not chapters.
@@ -271,7 +273,7 @@ man_pages = [
 #  dir menu entry, description, category)
 texinfo_documents = [
  (master_doc, 'PythonTelegramBot', u'Python Telegram Bot Documentation',
-   author, 'PythonTelegramBot', 'Not just a Python wrapper around the Telegram Bot API',
+   author, 'PythonTelegramBot', "We have made you a wrapper you can't refuse",
   'Miscellaneous'),
 ]

@@ -286,3 +288,21 @@ texinfo_documents = [

 # If true, do not generate a @detailmenu in the "Top" node's menu.
 #texinfo_no_detailmenu = False
+
+# -- script stuff --------------------------------------------------------
+
+import inspect
+
+
+def autodoc_skip_member(app, what, name, obj, skip, options):
+    try:
+        if inspect.getmodule(obj).__name__.startswith('telegram') and inspect.isfunction(obj):
+            if name.lower() != name:
+                return True
+    except AttributeError:
+        pass
+    # Return None so napoleon can handle it
+
+
+def setup(app):
+    app.connect('autodoc-skip-member', autodoc_skip_member)
@@ -6,12 +6,11 @@
 Welcome to Python Telegram Bot's documentation!
 ===============================================

-Contents:
-   telegram
+Below you can find the documentation for the python-telegram-bot library. except for the .ext package most of the
+objects in the package reflect the types as defined by the `telegram bot api <https://core.telegram.org/bots/api>`_.

 .. toctree::
-   :maxdepth: 2
-
+   telegram


 Indices and tables
@@ -1,7 +0,0 @@
-telegram
-========
-
-.. toctree::
-   :maxdepth: 4
-
-   telegram
@@ -0,0 +1,6 @@
+telegram.Animation
+==================
+
+.. autoclass:: telegram.Animation
+    :members:
+    :show-inheritance:
@@ -1,7 +1,6 @@
-telegram.audio module
-=====================
+telegram.Audio
+==============

-.. automodule:: telegram.audio
+.. autoclass:: telegram.Audio
    :members:
-    :undoc-members:
    :show-inheritance:
@@ -1,7 +0,0 @@
-telegram.base module
-====================
-
-.. automodule:: telegram.base
-    :members:
-    :undoc-members:
-    :show-inheritance:
@@ -1,6 +1,6 @@
-telegram.bot module
-===================
+telegram.Bot
+============

-.. automodule:: telegram.bot
+.. autoclass:: telegram.Bot
    :members:
-    :show-inheritance:
+    :show-inheritance:
@@ -0,0 +1,6 @@
+telegram.Callbackgame
+=====================
+
+.. autoclass:: telegram.CallbackGame
+    :members:
+    :show-inheritance:
@@ -0,0 +1,6 @@
+telegram.CallbackQuery
+======================
+
+.. autoclass:: telegram.CallbackQuery
+    :members:
+    :show-inheritance:
@@ -1,7 +1,6 @@
-telegram.chat module
-=========================
+telegram.Chat
+=============

-.. automodule:: telegram.chat
+.. autoclass:: telegram.Chat
    :members:
-    :undoc-members:
    :show-inheritance:
@@ -1,7 +1,6 @@
-telegram.chataction module
-==========================
+telegram.ChatAction
+===================

-.. automodule:: telegram.chataction
+.. autoclass:: telegram.ChatAction
    :members:
-    :undoc-members:
    :show-inheritance:
@@ -0,0 +1,6 @@
+telegram.ChatMember
+===================
+
+.. autoclass:: telegram.ChatMember
+    :members:
+    :show-inheritance:
@@ -0,0 +1,6 @@
+telegram.ChatPhoto
+==================
+
+.. autoclass:: telegram.ChatPhoto
+    :members:
+    :show-inheritance:
@@ -1,7 +1,6 @@
-telegram.choseninlineresult module
-==================================
+telegram.ChosenInlineResult
+===========================

-.. automodule:: telegram.choseninlineresult
+.. autoclass:: telegram.ChosenInlineResult
    :members:
-    :undoc-members:
    :show-inheritance:
@@ -1,7 +1,6 @@
-telegram.constants module
+telegram.constants Module
 =========================

 .. automodule:: telegram.constants
    :members:
-    :undoc-members:
    :show-inheritance:
@@ -1,7 +1,6 @@
-telegram.contact module
-=======================
+telegram.Contact
+================

-.. automodule:: telegram.contact
+.. autoclass:: telegram.Contact
    :members:
-    :undoc-members:
    :show-inheritance:
@@ -1,7 +1,7 @@
-telegram.contrib.botan module
-=============================
+telegram.contrib.Botan
+======================

-.. automodule:: telegram.contrib.botan
+.. autoclass:: telegram.contrib.Botan
    :members:
    :undoc-members:
    :show-inheritance:
@@ -0,0 +1,18 @@
+telegram.contrib package
+========================
+
+Submodules
+----------
+
+.. toctree::
+
+    telegram.contrib.botan
+
+Module contents
+---------------
+
+.. automodule:: telegram.contrib
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :noindex:
@@ -1,7 +1,6 @@
-telegram.document module
-========================
+telegram.Document
+=================

-.. automodule:: telegram.document
+.. autoclass:: telegram.Document
    :members:
-    :undoc-members:
    :show-inheritance:
@@ -1,7 +0,0 @@
-telegram.emoji module
-=====================
-
-.. automodule:: telegram.emoji
-    :members:
-    :undoc-members:
-    :show-inheritance:
@@ -1,7 +1,6 @@
-telegram.ext.callbackqueryhandler module
-========================================
+telegram.ext.CallbackQueryHandler
+=================================

-.. automodule:: telegram.ext.callbackqueryhandler
+.. autoclass:: telegram.ext.CallbackQueryHandler
    :members:
-    :undoc-members:
    :show-inheritance:
@@ -1,7 +1,6 @@
-telegram.ext.choseninlineresulthandler module
-=============================================
+telegram.ext.ChosenInlineResultHandler
+======================================

-.. automodule:: telegram.ext.choseninlineresulthandler
+.. autoclass:: telegram.ext.ChosenInlineResultHandler
    :members:
-    :undoc-members:
    :show-inheritance:
@@ -1,7 +1,6 @@
-telegram.ext.commandhandler module
-==================================
+telegram.ext.CommandHandler
+===========================

-.. automodule:: telegram.ext.commandhandler
+.. autoclass:: telegram.ext.CommandHandler
    :members:
-    :undoc-members:
    :show-inheritance:
@@ -1,7 +1,6 @@
-telegram.ext.conversationhandler module
-=======================================
+telegram.ext.ConversationHandler
+================================

-.. automodule:: telegram.ext.conversationhandler
+.. autoclass:: telegram.ext.ConversationHandler
    :members:
-    :undoc-members:
    :show-inheritance:
@@ -0,0 +1,7 @@
+telegram.ext.DelayQueue
+=======================
+
+.. autoclass:: telegram.ext.DelayQueue
+    :members:
+    :show-inheritance:
+    :special-members:
@@ -1,7 +1,6 @@
-telegram.ext.dispatcher module
-==============================
+telegram.ext.Dispatcher
+=======================

-.. automodule:: telegram.ext.dispatcher
+.. autoclass:: telegram.ext.Dispatcher
    :members:
-    :undoc-members:
    :show-inheritance:
@@ -0,0 +1,6 @@
+telegram.ext.filters Module
+===========================
+
+.. automodule:: telegram.ext.filters
+    :members:
+    :show-inheritance:
@@ -1,7 +1,7 @@
-telegram.ext.handler module
-===========================
+telegram.ext.Handler
+====================

-.. automodule:: telegram.ext.handler
+.. autoclass:: telegram.ext.Handler
    :members:
    :undoc-members:
    :show-inheritance:
@@ -1,7 +1,6 @@
-telegram.ext.inlinequeryhandler module
-======================================
+telegram.ext.InlineQueryHandler
+===============================

-.. automodule:: telegram.ext.inlinequeryhandler
+.. autoclass:: telegram.ext.InlineQueryHandler
    :members:
-    :undoc-members:
    :show-inheritance:
@@ -1,7 +1,6 @@
-telegram.ext.jobqueue module
-============================
+telegram.ext.JobQueue
+=====================

-.. automodule:: telegram.ext.jobqueue
+.. autoclass:: telegram.ext.JobQueue
    :members:
-    :undoc-members:
    :show-inheritance:
@@ -1,7 +1,6 @@
-telegram.ext.messagehandler module
-==================================
+telegram.ext.MessageHandler
+===========================

-.. automodule:: telegram.ext.messagehandler
+.. autoclass:: telegram.ext.MessageHandler
    :members:
-    :undoc-members:
    :show-inheritance:
@@ -0,0 +1,7 @@
+telegram.ext.MessageQueue
+=========================
+
+.. autoclass:: telegram.ext.MessageQueue
+    :members:
+    :show-inheritance:
+    :special-members:
@@ -0,0 +1,6 @@
+telegram.ext.PreCheckoutQueryHandler
+====================================
+
+.. autoclass:: telegram.ext.PreCheckoutQueryHandler
+    :members:
+    :show-inheritance:
@@ -1,7 +1,6 @@
-telegram.ext.regexhandler module
-================================
+telegram.ext.RegexHandler
+=========================

-.. automodule:: telegram.ext.regexhandler
+.. autoclass:: telegram.ext.RegexHandler
    :members:
-    :undoc-members:
    :show-inheritance:
@@ -1,29 +1,30 @@
 telegram.ext package
 ====================

-Submodules
----------
-
 .. toctree::

    telegram.ext.updater
    telegram.ext.dispatcher
+    telegram.ext.filters
    telegram.ext.jobqueue
+    telegram.ext.messagequeue
+    telegram.ext.delayqueue
+
+Handlers
+--------
+
+.. toctree::
+
    telegram.ext.handler
+    telegram.ext.callbackqueryhandler
    telegram.ext.choseninlineresulthandler
    telegram.ext.conversationhandler
    telegram.ext.commandhandler
    telegram.ext.inlinequeryhandler
    telegram.ext.messagehandler
+    telegram.ext.precheckoutqueryhandler
    telegram.ext.regexhandler
+    telegram.ext.shippingqueryhandler
    telegram.ext.stringcommandhandler
    telegram.ext.stringregexhandler
    telegram.ext.typehandler
-
-Module contents
---------------
-
-.. automodule:: telegram.ext
-    :members:
-    :undoc-members:
-    :show-inheritance:
@@ -0,0 +1,6 @@
+telegram.ext.ShippingQueryHandler
+=================================
+
+.. autoclass:: telegram.ext.ShippingQueryHandler
+    :members:
+    :show-inheritance:
@@ -1,7 +1,6 @@
-telegram.ext.stringcommandhandler module
-========================================
+telegram.ext.StringCommandHandler
+=================================

-.. automodule:: telegram.ext.stringcommandhandler
+.. autoclass:: telegram.ext.StringCommandHandler
    :members:
-    :undoc-members:
    :show-inheritance:
@@ -1,7 +1,6 @@
-telegram.ext.stringregexhandler module
-======================================
+telegram.ext.StringRegexHandler
+===============================

-.. automodule:: telegram.ext.stringregexhandler
+.. autoclass:: telegram.ext.StringRegexHandler
    :members:
-    :undoc-members:
    :show-inheritance:
@@ -1,7 +1,6 @@
-telegram.ext.typehandler module
-===============================
+telegram.ext.TypeHandler
+========================

-.. automodule:: telegram.ext.typehandler
+.. autoclass:: telegram.ext.TypeHandler
    :members:
-    :undoc-members:
    :show-inheritance:
@@ -1,7 +1,6 @@
-telegram.ext.updater module
-===========================
+telegram.ext.Updater
+====================

-.. automodule:: telegram.ext.updater
+.. autoclass:: telegram.ext.Updater
    :members:
-    :undoc-members:
    :show-inheritance:
@@ -0,0 +1,6 @@
+telegram.File
+=============
+
+.. autoclass:: telegram.File
+    :members:
+    :show-inheritance:
@@ -1,7 +1,6 @@
-telegram.forcereply module
-==========================
+telegram.ForceReply
+===================

-.. automodule:: telegram.forcereply
+.. autoclass:: telegram.ForceReply
    :members:
-    :undoc-members:
    :show-inheritance:
@@ -0,0 +1,6 @@
+telegram.Game
+=============
+
+.. autoclass:: telegram.Game
+    :members:
+    :show-inheritance:
@@ -0,0 +1,6 @@
+telegram.GameHighScore
+======================
+
+.. autoclass:: telegram.GameHighScore
+    :members:
+    :show-inheritance:
@@ -1,7 +1,6 @@
-telegram.inlinekeyboardbutton module
-===========================
+telegram.InlineKeyboardButton
+=============================

-.. automodule:: telegram.inlinekeyboardbutton
+.. autoclass:: telegram.InlineKeyboardButton
    :members:
-    :undoc-members:
    :show-inheritance:
@@ -1,7 +1,6 @@
-telegram.inlinekeyboardmarkup module
-==========================
+telegram.InlineKeyboardMarkup
+=============================

-.. automodule:: telegram.inlinekeyboardmarkup
+.. autoclass:: telegram.InlineKeyboardMarkup
    :members:
-    :undoc-members:
    :show-inheritance:
@@ -1,7 +1,6 @@
-telegram.inlinequery module
-===========================
+telegram.InlineQuery
+====================

-.. automodule:: telegram.inlinequery
+.. autoclass:: telegram.InlineQuery
    :members:
-    :undoc-members:
    :show-inheritance:
@@ -1,7 +1,6 @@
-telegram.inlinequeryresult module
-=================================
+telegram.InlineQueryResult
+==========================

-.. automodule:: telegram.inlinequeryresult
+.. autoclass:: telegram.InlineQueryResult
    :members:
-    :undoc-members:
    :show-inheritance:
@@ -1,7 +1,6 @@
-telegram.inlinequeryresultarticle module
+telegram.InlineQueryResultArticle
 =================================

-.. automodule:: telegram.inlinequeryresultarticle
+.. autoclass:: telegram.InlineQueryResultArticle
    :members:
-    :undoc-members:
    :show-inheritance:
@@ -1,7 +1,6 @@
-telegram.inlinequeryresultaudio module
-=================================
+telegram.InlineQueryResultAudio
+===============================

-.. automodule:: telegram.inlinequeryresultaudio
+.. autoclass:: telegram.InlineQueryResultAudio
    :members:
-    :undoc-members:
    :show-inheritance:
@@ -1,7 +1,6 @@
-telegram.inlinequeryresultcachedaudio module
-=================================
+telegram.InlineQueryResultCachedAudio
+=====================================

-.. automodule:: telegram.inlinequeryresultcachedaudio
+.. autoclass:: telegram.InlineQueryResultCachedAudio
    :members:
-    :undoc-members:
    :show-inheritance:
@@ -1,7 +1,6 @@
-telegram.inlinequeryresultcacheddocument module
-=================================
+telegram.InlineQueryResultCachedDocument
+========================================

-.. automodule:: telegram.inlinequeryresultcacheddocument
+.. autoclass:: telegram.InlineQueryResultCachedDocument
    :members:
-    :undoc-members:
    :show-inheritance:
@@ -1,7 +1,6 @@
-telegram.inlinequeryresultcachedgif module
-=================================
+telegram.InlineQueryResultCachedGif
+===================================

-.. automodule:: telegram.inlinequeryresultcachedgif
+.. autoclass:: telegram.InlineQueryResultCachedGif
    :members:
-    :undoc-members:
    :show-inheritance:
@@ -1,7 +1,6 @@
-telegram.inlinequeryresultcachedmpeg4gif module
-=================================
+telegram.InlineQueryResultCachedMpeg4Gif
+========================================

-.. automodule:: telegram.inlinequeryresultcachedmpeg4gif
+.. autoclass:: telegram.InlineQueryResultCachedMpeg4Gif
    :members:
-    :undoc-members:
    :show-inheritance:
@@ -1,7 +1,6 @@
-telegram.inlinequeryresultcachedphoto module
-=================================
+telegram.InlineQueryResultCachedPhoto
+=====================================

-.. automodule:: telegram.inlinequeryresultcachedphoto
+.. autoclass:: telegram.InlineQueryResultCachedPhoto
    :members:
-    :undoc-members:
    :show-inheritance:
@@ -1,7 +1,6 @@
-telegram.inlinequeryresultcachedsticker module
-=================================
+telegram.InlineQueryResultCachedSticker
+=======================================

-.. automodule:: telegram.inlinequeryresultcachedsticker
+.. autoclass:: telegram.InlineQueryResultCachedSticker
    :members:
-    :undoc-members:
    :show-inheritance:
@@ -1,7 +1,6 @@
-telegram.inlinequeryresultcachedvideo module
-=================================
+telegram.InlineQueryResultCachedVideo
+=====================================

-.. automodule:: telegram.inlinequeryresultcachedvideo
+.. autoclass:: telegram.InlineQueryResultCachedVideo
    :members:
-    :undoc-members:
    :show-inheritance:
@@ -1,7 +1,6 @@
-telegram.inlinequeryresultcachedvoice module
-=================================
+telegram.InlineQueryResultCachedVoice
+=====================================

-.. automodule:: telegram.inlinequeryresultcachedvoice
+.. autoclass:: telegram.InlineQueryResultCachedVoice
    :members:
-    :undoc-members:
    :show-inheritance:
@@ -1,7 +1,6 @@
-telegram.inlinequeryresultcontact module
+telegram.InlineQueryResultContact
 =================================

-.. automodule:: telegram.inlinequeryresultcontact
+.. autoclass:: telegram.InlineQueryResultContact
    :members:
-    :undoc-members:
    :show-inheritance:
@@ -1,7 +1,6 @@
-telegram.inlinequeryresultdocument module
-=================================
+telegram.InlineQueryResultDocument
+==================================

-.. automodule:: telegram.inlinequeryresultdocument
+.. autoclass:: telegram.InlineQueryResultDocument
    :members:
-    :undoc-members:
    :show-inheritance:
@@ -0,0 +1,6 @@
+telegram.InlineQueryResultGame
+==============================
+
+.. autoclass:: telegram.InlineQueryResultGame
+    :members:
+    :show-inheritance:
@@ -1,7 +1,6 @@
-telegram.inlinequeryresultgif module
-=================================
+telegram.InlineQueryResultGif
+=============================

-.. automodule:: telegram.inlinequeryresultgif
+.. autoclass:: telegram.InlineQueryResultGif
    :members:
-    :undoc-members:
    :show-inheritance:
@@ -1,7 +1,6 @@
-telegram.inlinequeryresultlocation module
-=================================
+telegram.InlineQueryResultLocation
+==================================

-.. automodule:: telegram.inlinequeryresultlocation
+.. autoclass:: telegram.InlineQueryResultLocation
    :members:
-    :undoc-members:
    :show-inheritance:
@@ -1,7 +1,6 @@
-telegram.inlinequeryresultmpeg4gif module
-=================================
+telegram.InlineQueryResultMpeg4Gif
+==================================

-.. automodule:: telegram.inlinequeryresultmpeg4gif
+.. autoclass:: telegram.InlineQueryResultMpeg4Gif
    :members:
-    :undoc-members:
    :show-inheritance:
@@ -1,7 +1,6 @@
-telegram.inlinequeryresultphoto module
-=================================
+telegram.InlineQueryResultPhoto
+===============================

-.. automodule:: telegram.inlinequeryresultphoto
+.. autoclass:: telegram.InlineQueryResultPhoto
    :members:
-    :undoc-members:
    :show-inheritance:
@@ -1,7 +1,6 @@
-telegram.inlinequeryresultvenue module
-=================================
+telegram.InlineQueryResultVenue
+===============================

-.. automodule:: telegram.inlinequeryresultvenue
+.. autoclass:: telegram.InlineQueryResultVenue
    :members:
-    :undoc-members:
    :show-inheritance:
@@ -1,7 +1,6 @@
-telegram.inlinequeryresultvideo module
-=================================
+telegram.InlineQueryResultVideo
+===============================

-.. automodule:: telegram.inlinequeryresultvideo
+.. autoclass:: telegram.InlineQueryResultVideo
    :members:
-    :undoc-members:
    :show-inheritance:
@@ -1,7 +1,6 @@
-telegram.inlinequeryresultvoice module
-=================================
+telegram.InlineQueryResultVoice
+===============================

-.. automodule:: telegram.inlinequeryresultvoice
+.. autoclass:: telegram.InlineQueryResultVoice
    :members:
-    :undoc-members:
    :show-inheritance:
@@ -0,0 +1,6 @@
+telegram.InputContactMessageContent
+===================================
+
+.. autoclass:: telegram.InputContactMessageContent
+    :members:
+    :show-inheritance:
@@ -1,7 +1,6 @@
-telegram.inputfile module
-=========================
+telegram.InputFile
+==================

-.. automodule:: telegram.inputfile
+.. autoclass:: telegram.InputFile
    :members:
-    :undoc-members:
    :show-inheritance:
@@ -0,0 +1,6 @@
+telegram.InputLocationMessageContent
+====================================
+
+.. autoclass:: telegram.InputLocationMessageContent
+    :members:
+    :show-inheritance:
@@ -0,0 +1,6 @@
+telegram.InputMessageContent
+============================
+
+.. autoclass:: telegram.InputMessageContent
+    :members:
+    :show-inheritance:
@@ -0,0 +1,6 @@
+telegram.InputTextMessageContent
+================================
+
+.. autoclass:: telegram.InputTextMessageContent
+    :members:
+    :show-inheritance:
@@ -0,0 +1,6 @@
+telegram.InputVenueMessageContent
+=================================
+
+.. autoclass:: telegram.InputVenueMessageContent
+    :members:
+    :show-inheritance:
@@ -0,0 +1,6 @@
+telegram.Invoice
+================
+
+.. autoclass:: telegram.Invoice
+    :members:
+    :show-inheritance:
@@ -0,0 +1,6 @@
+telegram.KeyboardButton
+=======================
+
+.. autoclass:: telegram.KeyboardButton
+    :members:
+    :show-inheritance:
@@ -0,0 +1,6 @@
+telegram.LabeledPrice
+=====================
+
+.. autoclass:: telegram.LabeledPrice
+    :members:
+    :show-inheritance:
@@ -1,7 +1,6 @@
-telegram.location module
-========================
+telegram.Location
+=================

-.. automodule:: telegram.location
+.. autoclass:: telegram.Location
    :members:
-    :undoc-members:
    :show-inheritance:
@@ -0,0 +1,6 @@
+telegram.MaskPosition
+=====================
+
+.. autoclass:: telegram.MaskPosition
+    :members:
+    :show-inheritance:
@@ -1,7 +1,6 @@
-telegram.message module
-=======================
+telegram.Message
+================

-.. automodule:: telegram.message
+.. autoclass:: telegram.Message
    :members:
-    :undoc-members:
    :show-inheritance:
@@ -0,0 +1,6 @@
+telegram.MessageEntity
+======================
+
+.. autoclass:: telegram.MessageEntity
+    :members:
+    :show-inheritance:
@@ -1,7 +0,0 @@
-telegram.nullhandler module
-===========================
-
-.. automodule:: telegram.nullhandler
-    :members:
-    :undoc-members:
-    :show-inheritance:
@@ -0,0 +1,6 @@
+telegram.OrderInfo
+==================
+
+.. autoclass:: telegram.OrderInfo
+    :members:
+    :show-inheritance:
@@ -0,0 +1,6 @@
+telegram.ParseMode
+==================
+
+.. autoclass:: telegram.ParseMode
+    :members:
+    :show-inheritance:
--- a/Show More
+++ b/Show More