Bump version to v5.1.1

CHANGES.rst

@@ -2,6 +2,12 @@
 Changes
 =======
 
+**2016-10-10**
+
+*Released 5.1.1*
+
+- Fix documentation builds on readthedocs
+
 **2016-09-24**
 
 *Released 5.1*

README.rst

@@ -103,6 +103,7 @@ Or you can install from source with:
     $ git clone https://github.com/python-telegram-bot/python-telegram-bot
     $ cd python-telegram-bot
     $ python setup.py install
+
 ===============
 Getting started
 ===============

docs/source/conf.py

@@ -15,7 +15,7 @@
 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
@@ -59,9 +59,9 @@ author = u'Leandro Toledo'
 # built documents.
 #
 # The short X.Y version.
-version = telegram.__version__[:3]
+version = '5.1'  # telegram.__version__[:3]
 # The full version, including alpha/beta/rc tags.
-release = telegram.__version__
+release = '5.1.1'  # telegram.__version__
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

examples/README.md

@@ -4,7 +4,7 @@ The examples in this folder are small bots meant to show you how a bot that is w
 
 All examples are licensed under the [CC0 License](https://github.com/python-telegram-bot/python-telegram-bot/blob/master/examples/LICENSE.txt) and are therefore fully dedicated to the public domain. You can use them as the base for your own bots without worrying about copyrights.
 
-### [`echobot2.py`](https://github.com/python-telegram-bot/python-telegram-bot/blob/v5.0/examples/echobot2.py) 
+### [`echobot2.py`](https://github.com/python-telegram-bot/python-telegram-bot/blob/master/examples/echobot2.py) 
 This is probably the base for most of the bots made with `python-telegram-bot`. It simply replies to each text message with a message that contains the same text.
 
 ### [`timerbot.py`](https://github.com/python-telegram-bot/python-telegram-bot/blob/master/examples/timerbot.py) 

examples/conversationbot.py

@@ -35,11 +35,11 @@ GENDER, PHOTO, LOCATION, BIO = range(4)
 def start(bot, update):
     reply_keyboard = [['Boy', 'Girl', 'Other']]
 
-    bot.sendMessage(update.message.chat_id,
-                    text='Hi! My name is Professor Bot. I will hold a conversation with you. '
-                         'Send /cancel to stop talking to me.\n\n'
-                         'Are you a boy or a girl?',
-                    reply_markup=ReplyKeyboardMarkup(reply_keyboard, one_time_keyboard=True))
+    update.message.reply_text(
+        'Hi! My name is Professor Bot. I will hold a conversation with you. '
+        'Send /cancel to stop talking to me.\n\n'
+        'Are you a boy or a girl?',
+        reply_markup=ReplyKeyboardMarkup(reply_keyboard, one_time_keyboard=True))
 
     return GENDER
 
@@ -47,9 +47,8 @@ def start(bot, update):
 def gender(bot, update):
     user = update.message.from_user
     logger.info("Gender of %s: %s" % (user.first_name, update.message.text))
-    bot.sendMessage(update.message.chat_id,
-                    text='I see! Please send me a photo of yourself, '
-                         'so I know what you look like, or send /skip if you don\'t want to.')
+    update.message.reply_text('I see! Please send me a photo of yourself, '
+                              'so I know what you look like, or send /skip if you don\'t want to.')
 
     return PHOTO
 
@@ -59,8 +58,8 @@ def photo(bot, update):
     photo_file = bot.getFile(update.message.photo[-1].file_id)
     photo_file.download('user_photo.jpg')
     logger.info("Photo of %s: %s" % (user.first_name, 'user_photo.jpg'))
-    bot.sendMessage(update.message.chat_id, text='Gorgeous! Now, send me your location please, '
-                                                 'or send /skip if you don\'t want to.')
+    update.message.reply_text('Gorgeous! Now, send me your location please, '
+                              'or send /skip if you don\'t want to.')
 
     return LOCATION
 
@@ -68,8 +67,8 @@ def photo(bot, update):
 def skip_photo(bot, update):
     user = update.message.from_user
     logger.info("User %s did not send a photo." % user.first_name)
-    bot.sendMessage(update.message.chat_id, text='I bet you look great! Now, send me your '
-                                                 'location please, or send /skip.')
+    update.message.reply_text('I bet you look great! Now, send me your location please, '
+                              'or send /skip.')
 
     return LOCATION
 
@@ -79,8 +78,8 @@ def location(bot, update):
     user_location = update.message.location
     logger.info("Location of %s: %f / %f"
                 % (user.first_name, user_location.latitude, user_location.longitude))
-    bot.sendMessage(update.message.chat_id, text='Maybe I can visit you sometime! '
-                                                 'At last, tell me something about yourself.')
+    update.message.reply_text('Maybe I can visit you sometime! '
+                              'At last, tell me something about yourself.')
 
     return BIO
 
@@ -88,8 +87,8 @@ def location(bot, update):
 def skip_location(bot, update):
     user = update.message.from_user
     logger.info("User %s did not send a location." % user.first_name)
-    bot.sendMessage(update.message.chat_id, text='You seem a bit paranoid! '
-                                                 'At last, tell me something about yourself.')
+    update.message.reply_text('You seem a bit paranoid! '
+                              'At last, tell me something about yourself.')
 
     return BIO
 
@@ -97,8 +96,7 @@ def skip_location(bot, update):
 def bio(bot, update):
     user = update.message.from_user
     logger.info("Bio of %s: %s" % (user.first_name, update.message.text))
-    bot.sendMessage(update.message.chat_id,
-                    text='Thank you! I hope we can talk again some day.')
+    update.message.reply_text('Thank you! I hope we can talk again some day.')
 
     return ConversationHandler.END
 
@@ -106,8 +104,7 @@ def bio(bot, update):
 def cancel(bot, update):
     user = update.message.from_user
     logger.info("User %s canceled the conversation." % user.first_name)
-    bot.sendMessage(update.message.chat_id,
-                    text='Bye! I hope we can talk again some day.')
+    update.message.reply_text('Bye! I hope we can talk again some day.')
 
     return ConversationHandler.END
 

examples/echobot.py

@@ -46,7 +46,7 @@ def echo(bot):
 
         if update.message:  # your bot can receive updates without messages
             # Reply to the message
-            bot.sendMessage(chat_id=chat_id, text=update.message.text)
+            update.message.reply_text(update.message.text)
 
 
 if __name__ == '__main__':

examples/inlinebot.py

@@ -34,11 +34,11 @@ logger = logging.getLogger(__name__)
 # Define a few command handlers. These usually take the two arguments bot and
 # update. Error handlers also receive the raised TelegramError object in error.
 def start(bot, update):
-    bot.sendMessage(update.message.chat_id, text='Hi!')
+    update.message.reply_text('Hi!')
 
 
 def help(bot, update):
-    bot.sendMessage(update.message.chat_id, text='Help!')
+    update.message.reply_text('Help!')
 
 
 def escape_markdown(text):
@@ -68,7 +68,7 @@ def inlinequery(bot, update):
                                                 "_%s_" % escape_markdown(query),
                                                 parse_mode=ParseMode.MARKDOWN)))
 
-    bot.answerInlineQuery(update.inline_query.id, results=results)
+    update.inline_query.answer(results)
 
 
 def error(bot, update, error):

examples/inlinekeyboard.py

@@ -20,7 +20,7 @@ def start(bot, update):
 
     reply_markup = InlineKeyboardMarkup(keyboard)
 
-    bot.sendMessage(update.message.chat_id, text="Please choose:", reply_markup=reply_markup)
+    update.message.reply_text('Please choose:', reply_markup=reply_markup)
 
 
 def button(bot, update):
@@ -32,7 +32,7 @@ def button(bot, update):
 
 
 def help(bot, update):
-    bot.sendMessage(update.message.chat_id, text="Use /start to test this bot.")
+    update.message.reply_text("Use /start to test this bot.")
 
 
 def error(bot, update, error):

examples/timerbot.py

@@ -31,7 +31,7 @@ timers = dict()
 # Define a few command handlers. These usually take the two arguments bot and
 # update. Error handlers also receive the raised TelegramError object in error.
 def start(bot, update):
-    bot.sendMessage(update.message.chat_id, text='Hi! Use /set <seconds> to ' 'set a timer')
+    update.message.reply_text('Hi! Use /set <seconds> to set a timer')
 
 
 def alarm(bot, job):
@@ -46,7 +46,7 @@ def set(bot, update, args, job_queue):
         # args[0] should contain the time for the timer in seconds
         due = int(args[0])
         if due < 0:
-            bot.sendMessage(chat_id, text='Sorry we can not go back to future!')
+            update.message.reply_text('Sorry we can not go back to future!')
             return
 
         # Add job to queue
@@ -54,25 +54,25 @@ def set(bot, update, args, job_queue):
         timers[chat_id] = job
         job_queue.put(job)
 
-        bot.sendMessage(chat_id, text='Timer successfully set!')
+        update.message.reply_text('Timer successfully set!')
 
     except (IndexError, ValueError):
-        bot.sendMessage(chat_id, text='Usage: /set <seconds>')
+        update.message.reply_text('Usage: /set <seconds>')
 
 
-def unset(bot, update, job_queue):
+def unset(bot, update):
     """Removes the job if the user changed their mind"""
     chat_id = update.message.chat_id
 
     if chat_id not in timers:
-        bot.sendMessage(chat_id, text='You have no active timer')
+        update.message.reply_text('You have no active timer')
         return
 
     job = timers[chat_id]
     job.schedule_removal()
     del timers[chat_id]
 
-    bot.sendMessage(chat_id, text='Timer successfully unset!')
+    update.message.reply_text('Timer successfully unset!')
 
 
 def error(bot, update, error):
@@ -89,7 +89,7 @@ def main():
     dp.add_handler(CommandHandler("start", start))
     dp.add_handler(CommandHandler("help", start))
     dp.add_handler(CommandHandler("set", set, pass_args=True, pass_job_queue=True))
-    dp.add_handler(CommandHandler("unset", unset, pass_job_queue=True))
+    dp.add_handler(CommandHandler("unset", unset))
 
     # log all errors
     dp.add_error_handler(error)

telegram/version.py

@@ -17,4 +17,4 @@
 # You should have received a copy of the GNU Lesser Public License
 # along with this program.  If not, see [http://www.gnu.org/licenses/].
 
-__version__ = '5.1.0'
+__version__ = '5.1.1'