a0720b9ac6
* Minor doc updates, following official API docs * Fix spelling in Defaults docstrings * Clarify Changelog of v12.7 about aware dates * Fix typo in CHANGES.rst (#2024) * Fix PicklePersistence.flush() with only bot_data (#2017) * Update pylint in pre-commit to fix CI (#2018) * Add Filters.via_bot (#2009) * feat: via_bot filter also fixing a small mistake in the empty parameter of the user filter and improve docs slightly * fix: forgot to set via_bot to None * fix: redoing subclassing to copy paste solution * Cosmetic changes Co-authored-by: Hinrich Mahler <hinrich.mahler@freenet.de> * Update CHANGES.rst Fixed Typo Co-authored-by: Bibo-Joshi <hinrich.mahler@freenet.de> Co-authored-by: Poolitzer <25934244+Poolitzer@users.noreply.github.com> * Update downloads badge, add info on IRC Channel to Getting Help section * Remove RegexHandler from ConversationHandlers Docs (#1973) Replaced RegexHandler with MessageHandler, since the former is deprecated * Fix Filters.via_bot docstrings * Add notes on Markdown v1 being legacy mode * Fixed typo in the Regex doc.. (#2036) * Typo: Spelling * Minor cleanup from #2043 * Document CommandHandler ignoring channel posts * Doc fixes for a few telegram.ext classes * Doc fixes for most `telegram` classes. * pep-8 forgot the hard wrap is at 99 chars, not 100! fixed a few spelling mistakes too. * Address review and made rendering of booleans consistent True, False, None are now rendered with ``bool`` wherever they weren't in telegram and telegram.ext classes. * Few doc fixes for inline* classes As usual, docs were cross-checked with official tg api docs. * Doc fixes for telegram/files classes As usual, docs were cross-checked with official tg api docs. * Doc fixes for telegram.Game Mostly just added hyperlinks. And fixed message length doc. As usual, docs were cross-checked with official tg api docs. * Very minor doc fix for passportfile.py and passportelementerrors.py Didn't bother changing too much since this seems to be a custom implementation. * Doc fixes for telegram.payments As usual, cross-checked with official bot api docs. * Address review 2 Few tiny other fixes too. * Changed from ``True/False/None`` to :obj:`True/False/None` project-wide. Few tiny other doc fixes too. Co-authored-by: Robert Geislinger <mitachundkrach@gmail.com> Co-authored-by: Poolitzer <25934244+Poolitzer@users.noreply.github.com> Co-authored-by: GauthamramRavichandran <30320759+GauthamramRavichandran@users.noreply.github.com> Co-authored-by: Mahesh19 <maheshvagicherla99438@gmail.com> Co-authored-by: hoppingturtles <ilovebhagwan@gmail.com> |
||
|---|---|---|
| .. | ||
| conversationbot.png | ||
| conversationbot.py | ||
| conversationbot2.png | ||
| conversationbot2.py | ||
| deeplinking.py | ||
| echobot.py | ||
| errorhandlerbot.py | ||
| inlinebot.py | ||
| inlinekeyboard.py | ||
| inlinekeyboard2.py | ||
| LICENSE.txt | ||
| nestedconversationbot.png | ||
| nestedconversationbot.py | ||
| passportbot.html | ||
| passportbot.py | ||
| paymentbot.py | ||
| persistentconversationbot.py | ||
| pollbot.py | ||
| rawapibot.py | ||
| README.md | ||
| timerbot.py | ||
Examples
In this folder are small examples to show what a bot written with python-telegram-bot looks like. Some bots focus on one specific aspect of the Telegram Bot API while others focus on one of the mechanics of this library. Except for the rawapibot.py example, they all use the high-level framework this library provides with the telegram.ext submodule.
All examples are licensed under the CC0 License and are therefore fully dedicated to the public domain. You can use them as the base for your own bots without worrying about copyrights.
echobot.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
This bot uses the JobQueue class to send timed messages. The user sets a timer by using /set command with a specific time, for example /set 30. The bot then sets up a job to send a message to that user after 30 seconds. The user can also cancel the timer by sending /unset. To learn more about the JobQueue, read this wiki article.
conversationbot.py
A common task for a bot is to ask information from the user. In v5.0 of this library, we introduced the ConversationHandler for that exact purpose. This example uses it to retrieve user-information in a conversation-like style. To get a better understanding, take a look at the state diagram.
conversationbot2.py
A more complex example of a bot that uses the ConversationHandler. It is also more confusing. Good thing there is a fancy state diagram for this one, too!
nestedconversationbot.py
A even more complex example of a bot that uses the nested ConversationHandlers. While it's certainly not that complex that you couldn't built it without nested ConversationHanldlers, it gives a good impression on how to work with them. Of course, there is a fancy state diagram for this example, too!
persistentconversationbot.py
A basic example of a bot store conversation state and user_data over multiple restarts.
inlinekeyboard.py
This example sheds some light on inline keyboards, callback queries and message editing.
inlinekeyboard2.py
A more complex example about inline keyboards, callback queries and message editing. This example showcases how an interactive menu could be build using inline keyboards.
deeplinking.py
A basic example on how to use deeplinking with inline keyboards.
inlinebot.py
A basic example of an inline bot. Don't forget to enable inline mode with @BotFather.
pollbot.py
This example sheds some light on polls, poll answers and the corresponding handlers.
passportbot.py
A basic example of a bot that can accept passports. Use in combination with passportbot.html. Don't forget to enable and configure payments with @BotFather. Check out this guide on Telegram passports in PTB.
paymentbot.py
A basic example of a bot that can accept payments. Don't forget to enable and configure payments with @BotFather.
errorhandlerbot.py
A basic example on how to set up a custom error handler.
Pure API
The rawapibot.py example uses only the pure, "bare-metal" API wrapper.