Bump to v10.0.1

* Fix conversationhandler

As found by @nmlorg and described in #1031

closes #1031

* adding another test and definitely finish conversationhandler

It seems another problem was when the job executed the timeout, it wasn;t removed from `self.conversation_timeouts` which made it still fail because job would be present in the handler dict, although it was already disabled.
This should fix it properly.

.codeclimate.yml

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

.coveragerc

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

.github/CONTRIBUTING.rst

@@ -0,0 +1,222 @@
+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.
+
+2. Clone your forked repository of ``python-telegram-bot`` to your computer:
+
+   .. code-block:: bash
+
+      $ git clone https://github.com/<your username>/python-telegram-bot --recursive
+      $ cd python-telegram-bot
+
+3. Add a track to the original repository:
+
+   .. code-block:: bash
+
+      $ git remote add upstream https://github.com/python-telegram-bot/python-telegram-bot
+
+4. Install dependencies:
+
+   .. code-block:: bash
+
+      $ sudo pip install -r requirements.txt -r requirements-dev.txt
+
+
+5. Install pre-commit hooks:
+
+   .. code-block:: bash
+
+      $ 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 `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``.
+
+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``.
+
+2. **Create a new branch with this name, starting from** ``master``. In other words, run:
+
+   .. code-block:: bash
+
+      $ git fetch upstream
+      $ git checkout master
+      $ git merge upstream/master
+      $ 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.
+
+   - 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.
+
+   - 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.
+
+   - Please ensure that the code you write is well-tested.
+
+   - Don’t break backward compatibility.
+
+   - Add yourself to the AUTHORS.rst_ file in an alphabetical fashion.
+
+   - Before making a commit ensure that all automated tests still pass:
+
+     .. code-block::
+
+        $ make test
+
+     If you don't have ``make``, do:
+
+     .. code-block::
+
+        $ pytest -v
+
+   - 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
+
+      $ git push origin your-branch-name
+
+4. **When your feature is ready to merge, create a pull request.**
+
+   - Go to your fork on GitHub, select your branch from the dropdown menu, and click "New pull request".
+
+   - Add a descriptive comment explaining the purpose of the branch (e.g. "Add the new API feature to create inline bot queries."). This will tell the reviewer what the purpose of the branch is.
+
+   - Click "Create pull request". An admin will assign a reviewer to your commit.
+
+5. **Address review comments until all reviewers give LGTM ('looks good to me').**
+
+   - 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)".
+
+       - 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
+
+   - If after merging you see local modified files in ``telegram/vendor/`` directory, that you didn't actually touch, that means you need to update submodules with this command:
+
+     .. code-block:: bash
+
+        $ git submodule update --init --recursive
+
+   - At the end, the reviewer will merge the pull request.
+
+6. **Tidy up!** Delete the feature branch from both your local clone and the GitHub repository:
+
+   .. code-block:: bash
+
+      $ git branch -D your-branch-name
+      $ git push origin --delete your-branch-name
+
+7. **Celebrate.** Congratulations, you have contributed to ``python-telegram-bot``!
+
+Style commandments
+------------------
+
+Specific commandments
+#####################
+
+- Avoid using "double quotes" where you can reasonably use 'single quotes'.
+
+Assert comparison order
+#######################
+
+- assert statements should compare in **actual** == **expected** order.
+For example (assuming ``test_call`` is the thing being tested):
+
+.. code-block:: python
+
+    # GOOD
+    assert test_call() == 5
+
+    # BAD
+    assert 5 == test_call()
+
+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
+callable we prefer that the call also uses keyword arg syntax. For example:
+
+.. code-block:: python
+
+   # GOOD
+   f(0, optional=True)
+
+   # BAD
+   f(0, True)
+
+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
+####################################
+
+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, last_name=None, **kwargs):
+       self.last_name = last_name
+
+    # BAD
+    def __init__(self, id, name, last_name=None):
+       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
+.. _`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,36 @@
+<!--
+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.
+
+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)

.gitignore

@@ -40,6 +40,7 @@ htmlcov/
 .coverage
 .coverage.*
 .cache
+.pytest_cache
 nosetests.xml
 coverage.xml
 *,cover
@@ -61,3 +62,18 @@ target/
 
 # Sublime Text 2
 *.sublime*
+
+# 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

.gitmodules

@@ -0,0 +1,4 @@
+[submodule "telegram/vendor/urllib3"]
+	path = telegram/vendor/ptb_urllib3
+	url = https://github.com/python-telegram-bot/urllib3.git
+	branch = ptb

.pre-commit-config.yaml

@@ -0,0 +1,20 @@
+-   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: v1.2.0
+    hooks:
+    -   id: flake8
+        exclude: ^(setup.py|docs/source/conf.py)$
+-   repo: git://github.com/pre-commit/mirrors-pylint
+    sha: v1.7.1
+    hooks:
+    -   id: pylint
+        files: ^telegram/.*\.py$
+        args:
+        - --errors-only
+        - --disable=import-error

.readthedocs.yml

@@ -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

.travis.yml

@@ -1,15 +1,37 @@
 language: python
 python:
-  - "2.6"
   - "2.7"
-  - "3.3"
   - "3.4"
-  - "pypy"
-  - "pypy3"
+  - "3.5"
+  - "3.6"
+  - "pypy-5.7.1"
+
+dist: trusty
+sudo: false
+
+branches:
+  only:
+    - master
+
+cache:
+  directories:
+    - $HOME/.cache/pip
+    - $HOME/.pre-commit
+before_cache:
+  - rm -f $HOME/.cache/pip/log/debug.log
+  - rm -f $HOME/.pre-commit/pre-commit.log
+
 install:
-  - pip install coveralls
-  - pip install -r requirements.txt
+  - pip install -U codecov pytest-cov
+  - pip install -U wheel
+  - pip install -U -r requirements.txt
+  - pip install -U -r requirements-dev.txt
+  - if [[ $TRAVIS_PYTHON_VERSION != 'pypy'* ]]; then pip install ujson; fi
+
 script:
-  nosetests --with-coverage --cover-package telegram/
+  - pytest -v -m nocoverage
+  - pytest -v -m "not nocoverage" --cov
+
 after_success:
-  coveralls
+  - coverage combine
+  - codecov -F Travis

AUTHORS.rst

@@ -1,24 +1,69 @@
 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>`_
+- `Anton Tagunov <https://github.com/anton-tagunov>`_
 - `Avanatiker <https://github.com/Avanatiker>`_
+- `Balduro <https://github.com/Balduro>`_
 - `bimmlerd <https://github.com/bimmlerd>`_
+- `d-qoi <https://github.com/d-qoi>`_
+- `daimajia <https://github.com/daimajia>`_
+- `Daniel Reed <https://github.com/nmlorg>`_
+- `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>`_
+- `ihoru <https://github.com/ihoru>`_
+- `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>`_
+- `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>`_
+- `Kjwon15 <https://github.com/kjwon15>`_
+- `Li-aung Yip <https://github.com/LiaungYip>`_
 - `macrojames <https://github.com/macrojames>`_
+- `Michael Elovskikh <https://github.com/wronglink>`_
+- `Mischa Krüger <https://github.com/Makman2>`_
+- `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>`_
+- `Oleg Sushchenko <https://github.com/feuillemorte>`_
+- `overquota <https://github.com/overquota>`_
+- `Patrick Hofmann <https://github.com/PH89>`_
+- `Paul Larsen <https://github.com/PaulSonOfLars>`_
+- `Pieter Schutz <https://github.com/eldinnie>`_
 - `Rahiel Kasim <https://github.com/rahiel>`_
+- `Sascha <https://github.com/saschalalala>`_
+- `Shelomentsev D <https://github.com/shelomentsevd>`_
+- `Simon Schürrle <https://github.com/SitiSchu>`_
 - `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.

CHANGES.rst

@@ -1,189 +1,728 @@
-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 channels
-  Raise exception if Telegram times out on long-polling
-  *Special thanks to @jh0ker for all hard work*
+=======
+Changes
+=======
+**2018-03-05**
+*Released 10.0.1*
+
+Fixes:
+- Fix conversationhandler timeout (PR `#1032`_)
+- Add missing docs utils (PR `#912`_)
+
+.. _`#1032`: https://github.com/python-telegram-bot/python-telegram-bot/pull/826
+.. _`#912`: https://github.com/python-telegram-bot/python-telegram-bot/pull/826
+
+**2018-03-02**
+*Released 10.0.0*
+
+Non backward compatabile changes and changed defaults
+
+- JobQueue: Remove deprecated prevent_autostart & put() (PR `#1012`_)
+- Bot, Updater: Remove deprecated network_delay (PR `#1012`_)
+- Remove deprecated Message.new_chat_member (PR `#1012`_)
+- Retry bootstrap phase indefinitely (by default) on network errors (PR `#1018`_)
+
+New Features
+
+- Support v3.6 API (PR `#1006`_)
+- User.full_name convinience property (PR `#949`_)
+- Add `send_phone_number_to_provider` and `send_email_to_provider` arguments to send_invoice (PR `#986`_)
+- Bot: Add shortcut methods reply_{markdown,html} (PR `#827`_)
+- Bot: Add shortcut method reply_media_group (PR `#994`_)
+- Added utils.helpers.effective_message_type (PR `#826`_)
+- Bot.get_file now allows passing a file in addition to file_id (PR `#963`_)
+- Add .get_file() to Audio, Document, PhotoSize, Sticker, Video, VideoNote and Voice (PR `#963`_)
+- Add .send_*() methods to User and Chat (PR `#963`_)
+- Get jobs by name (PR `#1011`_)
+- Add Message caption html/markdown methods (PR `#1013`_)
+- File.download_as_bytearray - new method to get a d/led file as bytearray (PR `#1019`_)
+- File.download(): Now returns a meaningful return value (PR `#1019`_)
+- Added conversation timeout in ConversationHandler (PR `#895`_)
+
+Changes
+
+- Store bot in PreCheckoutQuery (PR `#953`_)
+- Updater: Issue INFO log upon received signal (PR `#951`_)
+- JobQueue: Thread safety fixes (PR `#977`_)
+- WebhookHandler: Fix exception thrown during error handling (PR `#985`_)
+- Explicitly check update.effective_chat in ConversationHandler.check_update (PR `#959`_)
+- Updater: Better handling of timeouts during get_updates (PR `#1007`_)
+- Remove unnecessary to_dict() (PR `#834`_)
+- CommandHandler - ignore strings in entities and "/" followed by whitespace (PR `#1020`_)
+- Documentation & style fixes (PR `#942`_, PR `#956`_, PR `#962`_, PR `#980`_, PR `#983`_)
+
+.. _`#826`: https://github.com/python-telegram-bot/python-telegram-bot/pull/826
+.. _`#827`: https://github.com/python-telegram-bot/python-telegram-bot/pull/827
+.. _`#834`: https://github.com/python-telegram-bot/python-telegram-bot/pull/834
+.. _`#895`: https://github.com/python-telegram-bot/python-telegram-bot/pull/895
+.. _`#942`: https://github.com/python-telegram-bot/python-telegram-bot/pull/942
+.. _`#949`: https://github.com/python-telegram-bot/python-telegram-bot/pull/949
+.. _`#951`: https://github.com/python-telegram-bot/python-telegram-bot/pull/951
+.. _`#956`: https://github.com/python-telegram-bot/python-telegram-bot/pull/956
+.. _`#953`: https://github.com/python-telegram-bot/python-telegram-bot/pull/953
+.. _`#962`: https://github.com/python-telegram-bot/python-telegram-bot/pull/962
+.. _`#959`: https://github.com/python-telegram-bot/python-telegram-bot/pull/959
+.. _`#963`: https://github.com/python-telegram-bot/python-telegram-bot/pull/963
+.. _`#977`: https://github.com/python-telegram-bot/python-telegram-bot/pull/977
+.. _`#980`: https://github.com/python-telegram-bot/python-telegram-bot/pull/980
+.. _`#983`: https://github.com/python-telegram-bot/python-telegram-bot/pull/983
+.. _`#985`: https://github.com/python-telegram-bot/python-telegram-bot/pull/985
+.. _`#986`: https://github.com/python-telegram-bot/python-telegram-bot/pull/986
+.. _`#994`: https://github.com/python-telegram-bot/python-telegram-bot/pull/994
+.. _`#1006`: https://github.com/python-telegram-bot/python-telegram-bot/pull/1006
+.. _`#1007`: https://github.com/python-telegram-bot/python-telegram-bot/pull/1007
+.. _`#1011`: https://github.com/python-telegram-bot/python-telegram-bot/pull/1011
+.. _`#1012`: https://github.com/python-telegram-bot/python-telegram-bot/pull/1012
+.. _`#1013`: https://github.com/python-telegram-bot/python-telegram-bot/pull/1013
+.. _`#1018`: https://github.com/python-telegram-bot/python-telegram-bot/pull/1018
+.. _`#1019`: https://github.com/python-telegram-bot/python-telegram-bot/pull/1019
+.. _`#1020`: https://github.com/python-telegram-bot/python-telegram-bot/pull/1020
+
+**2017-12-08**
+*Released 9.0.0*
+
+Breaking changes (possibly)
+
+- Drop support for python 3.3 (PR `#930`_)
 
 
-2015-10-08
-  Released 2.8.7
-  Type as optional for GroupChat class
+New Features
+
+- Support Bot API 3.5 (PR `#920`_)
 
 
-2015-10-08
-  Released 2.8.6
-  Adds type to User and GroupChat classes (pre-release Telegram feature)
+Changes
+
+- Fix race condition in dispatcher start/stop (`#887`_)
+- Log error trace if there is no error handler registered (`#694`_)
+- Update examples with consistent string formatting (`#870`_)
+- Various changes and improvements to the docs.
+
+.. _`#920`: https://github.com/python-telegram-bot/python-telegram-bot/pull/920
+.. _`#930`: https://github.com/python-telegram-bot/python-telegram-bot/pull/930
+.. _`#887`: https://github.com/python-telegram-bot/python-telegram-bot/pull/887
+.. _`#694`: https://github.com/python-telegram-bot/python-telegram-bot/pull/694
+.. _`#870`: https://github.com/python-telegram-bot/python-telegram-bot/pull/870
+
+**2017-10-15**
+*Released 8.1.1*
+
+- Fix Commandhandler crashing on single character messages (PR `#873`_).
+
+.. _`#873`: https://github.com/python-telegram-bot/python-telegram-bot/pull/871
+
+**2017-10-14**
+*Released 8.1.0*
+
+New features
+- Support Bot API 3.4 (PR `#865`_).
+
+Changes
+- MessageHandler & RegexHandler now consider channel_updates.
+- Fix command not recognized if it is directly followed by a newline (PR `#869`_).
+- Removed Bot._message_wrapper (PR `#822`_).
+- Unitests are now also running on AppVeyor (Windows VM).
+- Various unitest improvements.
+- Documentation fixes.
+
+.. _`#822`: https://github.com/python-telegram-bot/python-telegram-bot/pull/822
+.. _`#865`: https://github.com/python-telegram-bot/python-telegram-bot/pull/865
+.. _`#869`: https://github.com/python-telegram-bot/python-telegram-bot/pull/869
+
+**2017-09-01**
+*Released 8.0.0*
+
+New features
+
+- Fully support Bot Api 3.3 (PR `#806`_).
+- DispatcherHandlerStop (`see docs`_).
+- Regression fix for text_html & text_markdown (PR `#777`_).
+- Added effective_attachment to message (PR `#766`_).
+
+Non backward compatible changes
+
+- Removed Botan support from the library  (PR `#776`_).
+- Fully support Bot Api 3.3 (PR `#806`_).
+- Remove de_json() (PR `#789`_).
+
+Changes
+
+- Sane defaults for tcp socket options on linux (PR `#754`_).
+- Add RESTRICTED as constant to ChatMember (PR `#761`_).
+- Add rich comparison to CallbackQuery (PR `#764`_).
+- Fix get_game_high_scores (PR `#771`_).
+- Warn on small con_pool_size during custom initalization of Updater (PR `#793`_).
+- Catch exceptions in error handlerfor errors that happen during polling (PR `#810`_).
+- For testing we switched to pytest (PR `#788`_).
+- Lots of small improvements to our tests and documentation.
 
 
-2015-09-24
-  Released 2.8.5
-  Handles HTTP Bad Gateway (503) errors on request
-  Fixes regression on Audio and Document for unicode fields
+.. _`see docs`: http://python-telegram-bot.readthedocs.io/en/stable/telegram.ext.dispatcher.html#telegram.ext.Dispatcher.add_handler
+.. _`#777`: https://github.com/python-telegram-bot/python-telegram-bot/pull/777
+.. _`#806`: https://github.com/python-telegram-bot/python-telegram-bot/pull/806
+.. _`#766`: https://github.com/python-telegram-bot/python-telegram-bot/pull/766
+.. _`#776`: https://github.com/python-telegram-bot/python-telegram-bot/pull/776
+.. _`#789`: https://github.com/python-telegram-bot/python-telegram-bot/pull/789
+.. _`#754`: https://github.com/python-telegram-bot/python-telegram-bot/pull/754
+.. _`#761`: https://github.com/python-telegram-bot/python-telegram-bot/pull/761
+.. _`#764`: https://github.com/python-telegram-bot/python-telegram-bot/pull/764
+.. _`#771`: https://github.com/python-telegram-bot/python-telegram-bot/pull/771
+.. _`#788`: https://github.com/python-telegram-bot/python-telegram-bot/pull/788
+.. _`#793`: https://github.com/python-telegram-bot/python-telegram-bot/pull/793
+.. _`#810`: https://github.com/python-telegram-bot/python-telegram-bot/pull/810
+
+**2017-07-28**
+*Released 7.0.1*
+
+- Fix TypeError exception in RegexHandler (PR #751).
+- Small documentation fix (PR #749).
+
+**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**
+
+*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-09-20
-  Released 2.8.4
-  getFile and File.download is now fully supported
+**2015-10-08**
+
+*Released 2.8.7*
+
+- Type as optional for ``GroupChat`` class
 
 
-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-10-08**
+
+*Released 2.8.6*
+
+- Adds type to ``User`` and ``GroupChat`` classes (pre-release Telegram feature)
 
 
-2015-09-05
-  Released 2.8.2
-  Fix regression on Telegram ReplyMarkup
-  Add certificate to is_inputfile method
+**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-05
-  Released 2.8.1
-  Fix regression on Telegram objects with thumb properties
+**2015-09-20**
+
+*Released 2.8.4*
+
+- ``getFile`` and ``File.download`` is now fully supported
 
 
-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-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-08-19
-  Released 2.7.1
-  Fixed JSON serialization for message
+**2015-09-05**
+
+*Released 2.8.2*
+
+- Fix regression on Telegram ReplyMarkup
+- Add certificate to ``is_inputfile`` method
 
 
-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-09-05**
+
+*Released 2.8.1*
+
+- Fix regression on Telegram objects with thumb properties
 
 
-2015-08-15
-  Released 2.6.1
-  Fixed parsing image header issue on < Python 2.7.3
+**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-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-19**
+
+*Released 2.7.1*
+
+- Fixed JSON serialization for ``message``
 
 
-2015-08-12
-  Released 2.5.3
-  telegram.Bot now supports to be unpickled
+**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-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-15**
+
+*Released 2.6.1*
+
+- Fixed parsing image header issue on < Python 2.7.3
 
 
-2015-08-10
-  Released 2.5.1
-  Moved from GPLv2 to LGPLv3
+**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-09
-  Released 2.5
-  Fixes logging calls in API
+**2015-08-12**
+
+*Released 2.5.3*
+
+- ``telegram.Bot`` now supports to be unpickled
 
 
-2015-08-08
-  Released 2.4
-  Fixes Emoji class for Python 3
-  PEP8 improvements
+**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-08
-  Released 2.3
-  Fixes ForceReply class
-  Remove logging.basicConfig from library
+**2015-08-10**
+
+*Released 2.5.1*
+
+- Moved from GPLv2 to LGPLv3
 
 
-2015-07-25
-  Released 2.2
-  Allows debug=True when initializing telegram.Bot
+**2015-08-09**
+
+*Released 2.5*
+
+- Fixes logging calls in API
 
 
-2015-07-20
-  Released 2.1
-  Fix to_dict for Document and Video
+**2015-08-08**
+
+*Released 2.4*
+
+- Fixes ``Emoji`` class for Python 3
+- ``PEP8`` improvements
 
 
-2015-07-19
-  Released 2.0
-  Fixes bugs
-  Improves __str__ over to_json()
-  Creates abstractclass TelegramObject
+**2015-08-08**
+
+*Released 2.3*
+
+- Fixes ``ForceReply`` class
+- Remove ``logging.basicConfig`` from library
 
 
-2015-07-15
-  Released 1.9
-  Python 3 officially supported
-  PEP8 improvements
+**2015-07-25**
+
+*Released 2.2*
+
+- Allows ``debug=True`` when initializing ``telegram.Bot``
 
 
-2015-07-12
-  Released 1.8
-  Fixes crash when replying an unicode text message (special thanks to JRoot3D)
+**2015-07-20**
+
+*Released 2.1*
+
+- Fix ``to_dict`` for ``Document`` and ``Video``
 
 
-2015-07-11
-  Released 1.7
-  Fixes crash when username is not defined on chat (special thanks to JRoot3D)
+**2015-07-19**
+
+*Released 2.0*
+
+- Fixes bugs
+- Improves ``__str__`` over ``to_json()``
+- Creates abstract class ``TelegramObject``
 
 
-2015-07-10
-  Released 1.6
-  Improvements for GAE support
+**2015-07-15**
+
+*Released 1.9*
+
+- Python 3 officially supported
+- ``PEP8`` improvements
 
 
-2015-07-10
-  Released 1.5
-  Fixes randomly unicode issues when using InputFile
+**2015-07-12**
+
+*Released 1.8*
+
+- Fixes crash when replying an unicode text message (special thanks to JRoot3D)
 
 
-2015-07-10
-  Released 1.4
-  requests lib is no longer required
-  Google App Engine (GAE) is supported
+**2015-07-11**
+
+*Released 1.7*
+
+- Fixes crash when ``username`` is not defined on ``chat`` (special thanks to JRoot3D)
 
 
-2015-07-10
-  Released 1.3
-  Added support to setWebhook (special thanks to macrojames)
+**2015-07-10**
+
+*Released 1.6*
+
+- Improvements for GAE support
 
 
-2015-07-09
-  Released 1.2
-  CustomKeyboard classes now available
-  Emojis available
-  PEP8 improvements
+**2015-07-10**
+
+*Released 1.5*
+
+- Fixes randomly unicode issues when using ``InputFile``
 
 
-2015-07-08
-  Released 1.1
-  PyPi package now available
+**2015-07-10**
+
+*Released 1.4*
+
+- ``requests`` lib is no longer required
+- Google App Engine (GAE) is supported
 
 
-2015-07-08
-  Released 1.0
-  Initial checkin of python-telegram-bot
+**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.md

@@ -0,0 +1,47 @@
+# 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][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.rst

@@ -1,39 +0,0 @@
-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.
-
-Here are a few guidelines to get you started:
-
-- Add yourself to the AUTHORS.rst_ file in an alphabetical fashion.
-  Every contribution is valuable and shall be credited.
-- If your change is noteworthy, add an entry to the CHANGES_.
-- No contribution is too small; please submit as many fixes for typos and grammar bloopers as you can!
-- Don’t break backward compatibility.
-- *Always* add tests and docs for your code.
-  This is a hard rule; patches with missing tests or documentation won’t be merged.
-  If a feature is not tested or documented, it doesn’t exist.
-- Obey `PEP 8`_ and `PEP 257`_.
-- Follow `Google Python Style Guide`_ and `Google Python Style Docstrings`_.
-- Write `good commit messages`_.
-
-.. note::
-   If you have something great but aren’t sure whether it adheres -- or even can adhere -- to the rules above: **please submit a pull request anyway**!
-
-   In the best case, we can mold it into something, in the worst case the pull request gets politely closed.
-   There’s absolutely nothing to fear.
-
-Thank you for considering to contribute to ``python-telegram-bot``!
-If you have any question or concerns, feel free to reach out to me.
-
-
-.. _`PEP 8`: https://www.python.org/dev/peps/pep-0008/
-.. _`PEP 257`: https://www.python.org/dev/peps/pep-0257/
-.. _`good commit messages`: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
-.. _`Code of Conduct`: https://www.python.org/psf/codeofconduct/
-.. _`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
-.. _CHANGES: https://github.com/leandrotoledo/python-telegram-bot/blob/master/CHANGES
-.. _AUTHORS.rst: https://github.com/leandrotoledo/python-telegram-bot/blob/master/AUTHORS.rst

MANIFEST.in

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

Makefile

@@ -1,4 +1,12 @@
-.PHONY: clean pep8 lint test install
+.DEFAULT_GOAL := help
+.PHONY: clean pep257 pep8 yapf lint test install
+
+PYLINT          := pylint
+PYTEST          := pytest
+PEP257          := pep257
+PEP8            := flake8
+YAPF            := yapf
+PIP             := pip
 
 clean:
 	rm -fr build
@@ -6,22 +14,39 @@ clean:
 	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:
-	flake8 telegram
+	$(PEP8) telegram
+
+yapf:
+	$(YAPF) -r telegram
 
 lint:
-	pylint -E telegram
+	$(PYLINT) -E telegram --disable=no-name-in-module,import-error
 
 test:
-	nosetests
+	$(PYTEST) -v
 
 install:
-	pip install -r requirements.txt
+	$(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 "- test        Run tests"
+	@echo "- yapf        Check style with yapf"
+	@echo "- test        Run tests using pytest"
+	@echo
+	@echo "Available variables:"
+	@echo "- PYLINT      default: $(PYLINT)"
+	@echo "- PYTEST      default: $(PYTEST)"
+	@echo "- PEP257      default: $(PEP257)"
+	@echo "- PEP8        default: $(PEP8)"
+	@echo "- YAPF        default: $(YAPF)"
+	@echo "- PIP         default: $(PIP)"

README.rst

@@ -1,38 +1,56 @@
-Python Telegram Bot
+.. 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
 
-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 <http://telegram.me/pythontelegrambotchannel>`_.
-
-By `Leandro Toledo <leandrotoledodesouza@gmail.com>`_
+*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.python.org/pypi/python-telegram-bot
    :alt: PyPi Package Version
 
-.. image:: https://img.shields.io/pypi/dm/python-telegram-bot.svg
+.. image:: https://img.shields.io/pypi/pyversions/python-telegram-bot.svg
    :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://readthedocs.org/projects/python-telegram-bot/badge/?version=latest
-   :target: https://readthedocs.org/projects/python-telegram-bot/?badge=latest
+.. image:: https://img.shields.io/badge/docs-latest-af1a97.svg
+   :target: https://python-telegram-bot.readthedocs.io/
    :alt: Documentation Status
 
 .. image:: https://img.shields.io/pypi/l/python-telegram-bot.svg
-   :target: http://www.gnu.org/licenses/lgpl-3.0.html
+   :target: https://www.gnu.org/licenses/lgpl-3.0.html
    :alt: LGPLv3 License
 
-.. image:: https://travis-ci.org/leandrotoledo/python-telegram-bot.svg?branch=master
-   :target: https://travis-ci.org/leandrotoledo/python-telegram-bot
+.. 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://codeclimate.com/github/leandrotoledo/python-telegram-bot/badges/gpa.svg
-   :target: https://codeclimate.com/github/leandrotoledo/python-telegram-bot
-   :alt: Code Climate
+.. image:: https://img.shields.io/appveyor/ci/Eldinnie/python-telegram-bot/master.svg?logo=appveyor
+   :target: https://ci.appveyor.com/project/Eldinnie/python-telegram-bot
+   :alt: AppVeyor CI Status
 
-.. image:: https://coveralls.io/repos/leandrotoledo/python-telegram-bot/badge.svg?branch=master&service=github
-   :target: https://coveralls.io/github/leandrotoledo/python-telegram-bot?branch=master
-   :alt: Coveralls
+
+.. image:: https://codecov.io/gh/python-telegram-bot/python-telegram-bot/branch/master/graph/badge.svg
+   :target: https://codecov.io/gh/python-telegram-bot/python-telegram-bot
+   :alt: Code coverage
+   
+.. 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: Median time to resolve an issue
+
+.. image:: https://img.shields.io/badge/Telegram-Group-blue.svg
+   :target: https://telegram.me/pythontelegrambotgroup
+   :alt: Telegram Group
+
+.. image:: https://img.shields.io/badge/IRC-Channel-blue.svg
+   :target: https://webchat.freenode.net/?channels=##python-telegram-bot
+   :alt: IRC Bridge
 
 =================
 Table of contents
@@ -40,251 +58,150 @@ Table of contents
 
 - `Introduction`_
 
-- `Status`_
-
-  1. `Telegram API support`_
-
-  2. `Python Version support`_
+- `Telegram API support`_
 
 - `Installing`_
 
-- `Getting the code`_
-
 - `Getting started`_
 
-  1. `API`_
+  #. `Learning by example`_
 
-  2. `Logging`_
+  #. `Logging`_
 
-  3. `Examples`_
+  #. `Documentation`_
 
-  4. `Documentation`_
+- `Getting help`_
+
+- `Contributing`_
 
 - `License`_
 
-- `Contact`_
+============
+Introduction
+============
 
-- `TODO`_
+This library provides a pure Python interface for the
+`Telegram Bot API <https://core.telegram.org/bots/api>`_.
+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>`_.
 
-===============
-_`Introduction`
-===============
+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.
 
-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+. It also works with `Google App Engine <https://cloud.google.com/appengine>`_.
+====================
+Telegram API support
+====================
 
-=========
-_`Status`
-=========
+All types and methods of the Telegram Bot API 3.4 are supported.
 
------------------------
-_`Telegram API support`
------------------------
+==========
+Installing
+==========
 
-========================= ============
-Telegram Bot API Method   *Supported?*
-========================= ============
-getMe                     Yes
-sendMessage               Yes
-forwardMessage            Yes
-sendPhoto                 Yes
-sendAudio                 Yes
-sendDocument              Yes
-sendSticker               Yes
-sendVideo                 Yes
-sendVoice                 Yes
-sendLocation              Yes
-sendChatAction            Yes
-getUpdates                Yes
-getUserProfilePhotos      Yes
-getFile                   Yes
-setWebhook                Yes
-========================= ============
+You can install or upgrade python-telegram-bot with:
 
--------------------------
-_`Python Version support`
--------------------------
-
-============== ============
-Python Version *Supported?*
-============== ============
-2.6            Yes
-2.7            Yes
-3.3            Yes
-3.4            Yes
-PyPy           Yes
-PyPy3          Yes
-============== ============
-
-=============
-_`Installing`
-=============
-
-You can install python-telegram-bot using::
-
-    $ pip install python-telegram-bot
-
-Or upgrade to the latest version::
+.. code:: shell
 
     $ pip install python-telegram-bot --upgrade
 
-===================
-_`Getting the code`
-===================
+Or you can install from source with:
 
-The code is hosted at https://github.com/leandrotoledo/python-telegram-bot
+.. code:: shell
 
-Check out the latest development version anonymously with::
-
-    $ git clone https://github.com/leandrotoledo/python-telegram-bot
+    $ 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:
 
-Run tests:
+.. code:: shell
 
-    $ make test
+    $ git submodule update --init --recursive
 
-To see other options available, run:
+===============
+Getting started
+===============
 
-    $ make help
+Our Wiki contains a lot of resources to get you started with ``python-telegram-bot``:
 
-==================
-_`Getting started`
-==================
+- `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>`_
 
-View the last release API documentation at: https://core.telegram.org/bots/api
+Other references:
 
-------
-_`API`
-------
+- `Telegram API documentation <https://core.telegram.org/bots/api>`_
+- `python-telegram-bot documentation <https://python-telegram-bot.readthedocs.io/>`_
 
-The API is exposed via the ``telegram.Bot`` class.
+-------------------
+Learning by example
+-------------------
 
-To generate an Access Token you have to talk to `BotFather <https://telegram.me/botfather>`_ and follow a few simple steps (described `here <https://core.telegram.org/bots#botfather>`_).
+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.
 
-For full details see the `Bots: An introduction for developers <https://core.telegram.org/bots>`_.
+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.
 
-To create an instance of the ``telegram.Bot``::
+-------
+Logging
+-------
 
-    >>> import telegram
-    >>> bot = telegram.Bot(token='token')
+This library uses the ``logging`` module. To set up logging to standard output, put:
 
-To see if your credentials are successful::
+.. code:: python
 
-    >>> print bot.getMe()
-    {"first_name": "Toledo's Palace Bot", "username": "ToledosPalaceBot"}
+    import logging
+    logging.basicConfig(level=logging.DEBUG,
+                        format='%(asctime)s - %(name)s - %(levelname)s - %(message)s')
 
-Bots can't initiate conversations with users. A user must either add them to a group or send them a message first. People can use ``telegram.me/<bot_username>`` links or username search to find your bot.
+at the beginning of your script.
 
-To fetch text messages sent to your Bot::
+You can also use logs in your application by calling ``logging.getLogger()`` and setting the log level you want:
 
-    >>> updates = bot.getUpdates()
-    >>> print [u.message.text for u in updates]
+.. code:: python
 
-To fetch images sent to your Bot::
+    logger = logging.getLogger()
+    logger.setLevel(logging.INFO)
 
-    >>> updates = bot.getUpdates()
-    >>> print [u.message.photo for u in updates if u.message.photo]
+If you want DEBUG logs instead:
 
-To reply messages you'll always need the chat_id::
+.. code:: python
 
-    >>> chat_id = bot.getUpdates()[-1].message.chat_id
+    logger.setLevel(logging.DEBUG)
 
-To post a text message::
 
-    >>> bot.sendMessage(chat_id=chat_id, text="I'm sorry Dave I'm afraid I can't do that.")
+=============
+Documentation
+=============
 
-To post a text message with markdown::
+``python-telegram-bot``'s documentation lives at `readthedocs.io <https://python-telegram-bot.readthedocs.io/>`_.
 
-    >>> bot.sendMessage(chat_id=chat_id, text="*bold* _italic_ [link](http://google.com).", parse_mode=telegram.ParseMode.MARKDOWN)
+============
+Getting help
+============
 
-To post an Emoji (special thanks to `Tim Whitlock <http://apps.timwhitlock.info/emoji/tables/unicode>`_)::
+You can get help in several ways:
 
-    >>> bot.sendMessage(chat_id=chat_id, text=telegram.Emoji.PILE_OF_POO)
+1. We have a vibrant community of developers helping each other in our `Telegram group <https://telegram.me/pythontelegrambotgroup>`_. Join us!
 
-To post an image file via URL (right now only sendPhoto supports this)::
+2. Our `Wiki pages <https://github.com/python-telegram-bot/python-telegram-bot/wiki/>`_ offer a growing amount of resources.
 
-    >>> bot.sendPhoto(chat_id=chat_id, photo='https://telegram.org/img/t_logo.png')
+3. You can ask for help on Stack Overflow using the `python-telegram-bot tag <https://stackoverflow.com/questions/tagged/python-telegram-bot>`_.
 
-To post a voice file::
+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>`_.
 
-    >>> bot.sendVoice(chat_id=chat_id, voice=open('tests/telegram.ogg', 'rb'))
 
-To tell the user that something is happening on bot's side::
+============
+Contributing
+============
 
-    >>> bot.sendChatAction(chat_id=chat_id, action=telegram.ChatAction.TYPING)
-
-To create `Custom Keyboards <https://core.telegram.org/bots#keyboards>`_::
-
-    >>> custom_keyboard = [[ telegram.Emoji.THUMBS_UP_SIGN, telegram.Emoji.THUMBS_DOWN_SIGN ]]
-    >>> reply_markup = telegram.ReplyKeyboardMarkup(custom_keyboard)
-    >>> bot.sendMessage(chat_id=chat_id, text="Stay here, I'll be back.", reply_markup=reply_markup)
-
-To hide `Custom Keyboards <https://core.telegram.org/bots#keyboards>`_::
-
-    >>> reply_markup = telegram.ReplyKeyboardHide()
-    >>> bot.sendMessage(chat_id=chat_id, text="I'm back.", reply_markup=reply_markup)
-
-To download a file (you will need its file_id)::
-
-    >>> file_id = message.voice.file_id
-    >>> newFile = bot.getFile(file_id)
-    >>> newFile.download('voice.ogg')
-
-There are many more API methods, to read the full API documentation::
-
-    $ pydoc telegram.Bot
-
------------
-_`Logging`
------------
-
-You can get logs in your main application by calling `logging` and setting the log level you want::
-
-    >>> import logging
-    >>> logger = logging.getLogger()
-    >>> logger.setLevel(logging.INFO)
-
-If you want DEBUG logs instead::
-
-    >>> logger.setLevel(logging.DEBUG)
-
------------
-_`Examples`
------------
-
-Here follows some examples to help you to get your own Bot up to speed:
-
-- `echobot <https://github.com/leandrotoledo/python-telegram-bot/blob/master/examples/echobot.py>`_ replies back messages.
-
-- `roboed <https://github.com/leandrotoledo/python-telegram-bot/blob/master/examples/roboed.py>`_ talks to `Robô Ed <http://www.ed.conpet.gov.br/br/converse.php>`_.
-
-- `Simple-Echo-Telegram-Bot <https://github.com/sooyhwang/Simple-Echo-Telegram-Bot>`_ simple Python Telegram bot that echoes your input with Flask microframework, setWebhook method, and Google App Engine (optional) - by @sooyhwang.
-
-- `DevOps Reaction Bot <https://github.com/leandrotoledo/gae-devops-reaction-telegram-bot>`_ sends latest or random posts from `DevOps Reaction <http://devopsreactions.tumblr.com/>`_. Running on `Google App Engine <https://cloud.google.com/appengine>`_ (billing has to be enabled for fully Socket API support).
-
-================
-_`Documentation`
-================
-
-``python-telegram-bot``'s documentation lives at `Read the Docs <http://python-telegram-bot.readthedocs.org/en/latest/>`_.
-
-==========
-_`License`
-==========
-
-You may copy, distribute and modify the software provided that modifications are described and licensed for free under `LGPL-3 <http://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 <http://www.gnu.org/licenses/lgpl-3.0.html>`_, but applications that use the library don't have to be.
-
-==========
-_`Contact`
-==========
-
-Feel free to join to our `Telegram group <https://telegram.me/joinchat/ALnA-AJQm5SEwuAzar3nvw>`_.
-
-If you face trouble joining in the group please ping me `via Telegram <https://telegram.me/leandrotoledo>`_, I'll be glad to add you.
+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>`_.
 
 =======
-_`TODO`
+License
 =======
 
-Patches and bug reports are `welcome <https://github.com/leandrotoledo/python-telegram-bot/issues/new>`_, just please keep the style consistent with the original source.
-
-- Add commands handler.
+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.

appveyor.yml

@@ -0,0 +1,39 @@
+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:\\Python34"
+    - PYTHON: "C:\\Python35"
+    - PYTHON: "C:\\Python36"
+
+branches:
+  only:
+  - master
+
+skip_branch_with_pr: true
+
+max_jobs: 1
+
+install:
+  - "SET PATH=%PYTHON%;%PYTHON%\\Scripts;%PATH%"
+  - "git submodule update --init --recursive"
+  # Check that we have the expected version and architecture for Python
+  - "python --version"
+  # We need wheel installed to build wheels
+  - "pip install -U codecov pytest-cov"
+  - "pip install -U wheel"
+  - "pip install -r requirements.txt"
+  - "pip install -r requirements-dev.txt"
+
+build: off
+
+test_script:
+  - "pytest -m \"not nocoverage\" --cov --cov-report xml:coverage.xml"
+
+after_test:
+ - "codecov -f coverage.xml -F Appveyor"

codecov.yml

@@ -0,0 +1 @@
+comment: false

docs/Makefile

@@ -189,4 +189,4 @@ xml:
 pseudoxml:
 	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
 	@echo
-	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
+	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

docs/requirements-docs.txt

@@ -1,3 +1,3 @@
-sphinx
+sphinx>=1.5.4
 sphinx_rtd_theme
 sphinx-pypi-upload

docs/source/conf.py

@@ -11,10 +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
 
 # 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
@@ -24,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
@@ -50,7 +50,7 @@ master_doc = 'index'
 
 # General information about the project.
 project = u'Python Telegram Bot'
-copyright = u'2015, Leandro Toledo'
+copyright = u'2015-2018, Leandro Toledo'
 author = u'Leandro Toledo'
 
 # The version info for the project you're documenting, acts as replacement for
@@ -58,9 +58,9 @@ author = u'Leandro Toledo'
 # built documents.
 #
 # The short X.Y version.
-version = '2.9'
+version = '10.0'  # telegram.__version__[:3]
 # The full version, including alpha/beta/rc tags.
-release = '2.9'
+release = '10.0.1'  # telegram.__version__
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -130,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,
@@ -208,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',
@@ -226,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.
@@ -270,7 +273,7 @@ man_pages = [
 #  dir menu entry, description, category)
 texinfo_documents = [
   (master_doc, 'PythonTelegramBot', u'Python Telegram Bot Documentation',
-   author, 'PythonTelegramBot', 'One line description of project.',
+   author, 'PythonTelegramBot', "We have made you a wrapper you can't refuse",
    'Miscellaneous'),
 ]
 
@@ -285,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)

docs/source/index.rst

@@ -6,12 +6,16 @@
 Welcome to Python Telegram Bot's documentation!
 ===============================================
 
-Contents:
+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
 
+Changelog
+---------
 
+.. include:: ../../CHANGES.rst
 
 Indices and tables
 ==================

docs/source/modules.rst

@@ -1,7 +0,0 @@
-telegram
-========
-
-.. toctree::
-   :maxdepth: 4
-
-   telegram

docs/source/telegram.animation.rst

@@ -0,0 +1,6 @@
+telegram.Animation
+==================
+
+.. autoclass:: telegram.Animation
+    :members:
+    :show-inheritance:

docs/source/telegram.audio.rst

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

docs/source/telegram.bot.rst

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

docs/source/telegram.callbackgame.rst

@@ -0,0 +1,6 @@
+telegram.Callbackgame
+=====================
+
+.. autoclass:: telegram.CallbackGame
+    :members:
+    :show-inheritance:

docs/source/telegram.callbackquery.rst

@@ -0,0 +1,6 @@
+telegram.CallbackQuery
+======================
+
+.. autoclass:: telegram.CallbackQuery
+    :members:
+    :show-inheritance:

docs/source/telegram.chat.rst

@@ -0,0 +1,6 @@
+telegram.Chat
+=============
+
+.. autoclass:: telegram.Chat
+    :members:
+    :show-inheritance:

docs/source/telegram.chataction.rst

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

docs/source/telegram.chatmember.rst

@@ -0,0 +1,6 @@
+telegram.ChatMember
+===================
+
+.. autoclass:: telegram.ChatMember
+    :members:
+    :show-inheritance:

docs/source/telegram.chatphoto.rst

@@ -0,0 +1,6 @@
+telegram.ChatPhoto
+==================
+
+.. autoclass:: telegram.ChatPhoto
+    :members:
+    :show-inheritance:

docs/source/telegram.choseninlineresult.rst

@@ -0,0 +1,6 @@
+telegram.ChosenInlineResult
+===========================
+
+.. autoclass:: telegram.ChosenInlineResult
+    :members:
+    :show-inheritance:

docs/source/telegram.constants.rst

@@ -0,0 +1,6 @@
+telegram.constants Module
+=========================
+
+.. automodule:: telegram.constants
+    :members:
+    :show-inheritance:

docs/source/telegram.contact.rst

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

docs/source/telegram.document.rst

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

docs/source/telegram.emoji.rst

@@ -1,7 +0,0 @@
-telegram.emoji module
-=====================
-
-.. automodule:: telegram.emoji
-    :members:
-    :undoc-members:
-    :show-inheritance:

docs/source/telegram.ext.callbackqueryhandler.rst

@@ -0,0 +1,6 @@
+telegram.ext.CallbackQueryHandler
+=================================
+
+.. autoclass:: telegram.ext.CallbackQueryHandler
+    :members:
+    :show-inheritance:

docs/source/telegram.ext.choseninlineresulthandler.rst

@@ -0,0 +1,6 @@
+telegram.ext.ChosenInlineResultHandler
+======================================
+
+.. autoclass:: telegram.ext.ChosenInlineResultHandler
+    :members:
+    :show-inheritance:

docs/source/telegram.ext.commandhandler.rst

@@ -0,0 +1,6 @@
+telegram.ext.CommandHandler
+===========================
+
+.. autoclass:: telegram.ext.CommandHandler
+    :members:
+    :show-inheritance:

docs/source/telegram.ext.conversationhandler.rst

@@ -0,0 +1,6 @@
+telegram.ext.ConversationHandler
+================================
+
+.. autoclass:: telegram.ext.ConversationHandler
+    :members:
+    :show-inheritance:

docs/source/telegram.ext.delayqueue.rst

@@ -0,0 +1,7 @@
+telegram.ext.DelayQueue
+=======================
+
+.. autoclass:: telegram.ext.DelayQueue
+    :members:
+    :show-inheritance:
+    :special-members:

docs/source/telegram.ext.dispatcher.rst

@@ -0,0 +1,6 @@
+telegram.ext.Dispatcher
+=======================
+
+.. autoclass:: telegram.ext.Dispatcher
+    :members:
+    :show-inheritance:

docs/source/telegram.ext.filters.rst

@@ -0,0 +1,6 @@
+telegram.ext.filters Module
+===========================
+
+.. automodule:: telegram.ext.filters
+    :members:
+    :show-inheritance:

docs/source/telegram.ext.handler.rst

@@ -1,7 +1,7 @@
-telegram.base module
+telegram.ext.Handler
 ====================
 
-.. automodule:: telegram.base
+.. autoclass:: telegram.ext.Handler
     :members:
     :undoc-members:
     :show-inheritance:

docs/source/telegram.ext.inlinequeryhandler.rst

@@ -0,0 +1,6 @@
+telegram.ext.InlineQueryHandler
+===============================
+
+.. autoclass:: telegram.ext.InlineQueryHandler
+    :members:
+    :show-inheritance:

docs/source/telegram.ext.job.rst

@@ -0,0 +1,6 @@
+telegram.ext.Job
+=====================
+
+.. autoclass:: telegram.ext.Job
+    :members:
+    :show-inheritance:

docs/source/telegram.ext.jobqueue.rst

@@ -0,0 +1,6 @@
+telegram.ext.JobQueue
+=====================
+
+.. autoclass:: telegram.ext.JobQueue
+    :members:
+    :show-inheritance:

docs/source/telegram.ext.messagehandler.rst

@@ -0,0 +1,6 @@
+telegram.ext.MessageHandler
+===========================
+
+.. autoclass:: telegram.ext.MessageHandler
+    :members:
+    :show-inheritance:

docs/source/telegram.ext.messagequeue.rst

@@ -0,0 +1,7 @@
+telegram.ext.MessageQueue
+=========================
+
+.. autoclass:: telegram.ext.MessageQueue
+    :members:
+    :show-inheritance:
+    :special-members:

docs/source/telegram.ext.precheckoutqueryhandler.rst

@@ -0,0 +1,6 @@
+telegram.ext.PreCheckoutQueryHandler
+====================================
+
+.. autoclass:: telegram.ext.PreCheckoutQueryHandler
+    :members:
+    :show-inheritance:

docs/source/telegram.ext.regexhandler.rst

@@ -0,0 +1,6 @@
+telegram.ext.RegexHandler
+=========================
+
+.. autoclass:: telegram.ext.RegexHandler
+    :members:
+    :show-inheritance:

docs/source/telegram.ext.rst

@@ -0,0 +1,31 @@
+telegram.ext package
+====================
+
+.. toctree::
+
+    telegram.ext.updater
+    telegram.ext.dispatcher
+    telegram.ext.filters
+    telegram.ext.job
+    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

docs/source/telegram.ext.shippingqueryhandler.rst

@@ -0,0 +1,6 @@
+telegram.ext.ShippingQueryHandler
+=================================
+
+.. autoclass:: telegram.ext.ShippingQueryHandler
+    :members:
+    :show-inheritance:

docs/source/telegram.ext.stringcommandhandler.rst

@@ -0,0 +1,6 @@
+telegram.ext.StringCommandHandler
+=================================
+
+.. autoclass:: telegram.ext.StringCommandHandler
+    :members:
+    :show-inheritance:

docs/source/telegram.ext.stringregexhandler.rst

@@ -0,0 +1,6 @@
+telegram.ext.StringRegexHandler
+===============================
+
+.. autoclass:: telegram.ext.StringRegexHandler
+    :members:
+    :show-inheritance:

docs/source/telegram.ext.typehandler.rst

@@ -0,0 +1,6 @@
+telegram.ext.TypeHandler
+========================
+
+.. autoclass:: telegram.ext.TypeHandler
+    :members:
+    :show-inheritance:

docs/source/telegram.ext.updater.rst

@@ -0,0 +1,6 @@
+telegram.ext.Updater
+====================
+
+.. autoclass:: telegram.ext.Updater
+    :members:
+    :show-inheritance:

docs/source/telegram.file.rst

@@ -0,0 +1,6 @@
+telegram.File
+=============
+
+.. autoclass:: telegram.File
+    :members:
+    :show-inheritance:

docs/source/telegram.forcereply.rst

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

docs/source/telegram.game.rst

@@ -0,0 +1,6 @@
+telegram.Game
+=============
+
+.. autoclass:: telegram.Game
+    :members:
+    :show-inheritance:

docs/source/telegram.gamehighscore.rst

@@ -0,0 +1,6 @@
+telegram.GameHighScore
+======================
+
+.. autoclass:: telegram.GameHighScore
+    :members:
+    :show-inheritance:

docs/source/telegram.groupchat.rst

@@ -1,7 +0,0 @@
-telegram.groupchat module
-=========================
-
-.. automodule:: telegram.groupchat
-    :members:
-    :undoc-members:
-    :show-inheritance:

docs/source/telegram.inlinekeyboardbutton.rst

@@ -0,0 +1,6 @@
+telegram.InlineKeyboardButton
+=============================
+
+.. autoclass:: telegram.InlineKeyboardButton
+    :members:
+    :show-inheritance:

docs/source/telegram.inlinekeyboardmarkup.rst

@@ -0,0 +1,6 @@
+telegram.InlineKeyboardMarkup
+=============================
+
+.. autoclass:: telegram.InlineKeyboardMarkup
+    :members:
+    :show-inheritance:

docs/source/telegram.inlinequery.rst

@@ -0,0 +1,6 @@
+telegram.InlineQuery
+====================
+
+.. autoclass:: telegram.InlineQuery
+    :members:
+    :show-inheritance:

docs/source/telegram.inlinequeryresult.rst

@@ -0,0 +1,6 @@
+telegram.InlineQueryResult
+==========================
+
+.. autoclass:: telegram.InlineQueryResult
+    :members:
+    :show-inheritance:

docs/source/telegram.inlinequeryresultarticle.rst

@@ -0,0 +1,6 @@
+telegram.InlineQueryResultArticle
+=================================
+
+.. autoclass:: telegram.InlineQueryResultArticle
+    :members:
+    :show-inheritance:

docs/source/telegram.inlinequeryresultaudio.rst

@@ -0,0 +1,6 @@
+telegram.InlineQueryResultAudio
+===============================
+
+.. autoclass:: telegram.InlineQueryResultAudio
+    :members:
+    :show-inheritance:

docs/source/telegram.inlinequeryresultcachedaudio.rst

@@ -0,0 +1,6 @@
+telegram.InlineQueryResultCachedAudio
+=====================================
+
+.. autoclass:: telegram.InlineQueryResultCachedAudio
+    :members:
+    :show-inheritance:

docs/source/telegram.inlinequeryresultcacheddocument.rst

@@ -0,0 +1,6 @@
+telegram.InlineQueryResultCachedDocument
+========================================
+
+.. autoclass:: telegram.InlineQueryResultCachedDocument
+    :members:
+    :show-inheritance:

docs/source/telegram.inlinequeryresultcachedgif.rst

@@ -0,0 +1,6 @@
+telegram.InlineQueryResultCachedGif
+===================================
+
+.. autoclass:: telegram.InlineQueryResultCachedGif
+    :members:
+    :show-inheritance:

docs/source/telegram.inlinequeryresultcachedmpeg4gif.rst

@@ -0,0 +1,6 @@
+telegram.InlineQueryResultCachedMpeg4Gif
+========================================
+
+.. autoclass:: telegram.InlineQueryResultCachedMpeg4Gif
+    :members:
+    :show-inheritance:

docs/source/telegram.inlinequeryresultcachedphoto.rst

@@ -0,0 +1,6 @@
+telegram.InlineQueryResultCachedPhoto
+=====================================
+
+.. autoclass:: telegram.InlineQueryResultCachedPhoto
+    :members:
+    :show-inheritance:

docs/source/telegram.inlinequeryresultcachedsticker.rst

@@ -0,0 +1,6 @@
+telegram.InlineQueryResultCachedSticker
+=======================================
+
+.. autoclass:: telegram.InlineQueryResultCachedSticker
+    :members:
+    :show-inheritance:

docs/source/telegram.inlinequeryresultcachedvideo.rst

@@ -0,0 +1,6 @@
+telegram.InlineQueryResultCachedVideo
+=====================================
+
+.. autoclass:: telegram.InlineQueryResultCachedVideo
+    :members:
+    :show-inheritance:

docs/source/telegram.inlinequeryresultcachedvoice.rst

@@ -0,0 +1,6 @@
+telegram.InlineQueryResultCachedVoice
+=====================================
+
+.. autoclass:: telegram.InlineQueryResultCachedVoice
+    :members:
+    :show-inheritance:

docs/source/telegram.inlinequeryresultcontact.rst

@@ -0,0 +1,6 @@
+telegram.InlineQueryResultContact
+=================================
+
+.. autoclass:: telegram.InlineQueryResultContact
+    :members:
+    :show-inheritance:

docs/source/telegram.inlinequeryresultdocument.rst

@@ -0,0 +1,6 @@
+telegram.InlineQueryResultDocument
+==================================
+
+.. autoclass:: telegram.InlineQueryResultDocument
+    :members:
+    :show-inheritance:

docs/source/telegram.inlinequeryresultgame.rst

@@ -0,0 +1,6 @@
+telegram.InlineQueryResultGame
+==============================
+
+.. autoclass:: telegram.InlineQueryResultGame
+    :members:
+    :show-inheritance:

docs/source/telegram.inlinequeryresultgif.rst

@@ -0,0 +1,6 @@
+telegram.InlineQueryResultGif
+=============================
+
+.. autoclass:: telegram.InlineQueryResultGif
+    :members:
+    :show-inheritance:

docs/source/telegram.inlinequeryresultlocation.rst

@@ -0,0 +1,6 @@
+telegram.InlineQueryResultLocation
+==================================
+
+.. autoclass:: telegram.InlineQueryResultLocation
+    :members:
+    :show-inheritance:

docs/source/telegram.inlinequeryresultmpeg4gif.rst

@@ -0,0 +1,6 @@
+telegram.InlineQueryResultMpeg4Gif
+==================================
+
+.. autoclass:: telegram.InlineQueryResultMpeg4Gif
+    :members:
+    :show-inheritance:

docs/source/telegram.inlinequeryresultphoto.rst

@@ -0,0 +1,6 @@
+telegram.InlineQueryResultPhoto
+===============================
+
+.. autoclass:: telegram.InlineQueryResultPhoto
+    :members:
+    :show-inheritance:

docs/source/telegram.inlinequeryresultvenue.rst

@@ -0,0 +1,6 @@
+telegram.InlineQueryResultVenue
+===============================
+
+.. autoclass:: telegram.InlineQueryResultVenue
+    :members:
+    :show-inheritance:

docs/source/telegram.inlinequeryresultvideo.rst

@@ -0,0 +1,6 @@
+telegram.InlineQueryResultVideo
+===============================
+
+.. autoclass:: telegram.InlineQueryResultVideo
+    :members:
+    :show-inheritance:

docs/source/telegram.inlinequeryresultvoice.rst

@@ -0,0 +1,6 @@
+telegram.InlineQueryResultVoice
+===============================
+
+.. autoclass:: telegram.InlineQueryResultVoice
+    :members:
+    :show-inheritance:

docs/source/telegram.inputcontactmessagecontent.rst

@@ -0,0 +1,6 @@
+telegram.InputContactMessageContent
+===================================
+
+.. autoclass:: telegram.InputContactMessageContent
+    :members:
+    :show-inheritance:

docs/source/telegram.inputfile.rst

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

docs/source/telegram.inputlocationmessagecontent.rst

@@ -0,0 +1,6 @@
+telegram.InputLocationMessageContent
+====================================
+
+.. autoclass:: telegram.InputLocationMessageContent
+    :members:
+    :show-inheritance:

docs/source/telegram.inputmedia.rst

@@ -0,0 +1,6 @@
+telegram.InputMedia
+===================
+
+.. autoclass:: telegram.InputMedia
+    :members:
+    :show-inheritance:

docs/source/telegram.inputmediaphoto.rst

@@ -0,0 +1,6 @@
+telegram.InputMediaPhoto
+========================
+
+.. autoclass:: telegram.InputMediaPhoto
+    :members:
+    :show-inheritance:

docs/source/telegram.inputmediavideo.rst

@@ -0,0 +1,6 @@
+telegram.InputMediaVideo
+========================
+
+.. autoclass:: telegram.InputMediaVideo
+    :members:
+    :show-inheritance:

docs/source/telegram.inputmessagecontent.rst

@@ -0,0 +1,6 @@
+telegram.InputMessageContent
+============================
+
+.. autoclass:: telegram.InputMessageContent
+    :members:
+    :show-inheritance:

docs/source/telegram.inputtextmessagecontent.rst

@@ -0,0 +1,6 @@
+telegram.InputTextMessageContent
+================================
+
+.. autoclass:: telegram.InputTextMessageContent
+    :members:
+    :show-inheritance:

docs/source/telegram.inputvenuemessagecontent.rst

@@ -0,0 +1,6 @@
+telegram.InputVenueMessageContent
+=================================
+
+.. autoclass:: telegram.InputVenueMessageContent
+    :members:
+    :show-inheritance: