From 0ac4553591b3a0bf31eed01353547dccabd84dc6 Mon Sep 17 00:00:00 2001 From: Davte Date: Sat, 13 Jul 2019 18:26:12 +0200 Subject: [PATCH] Documentation --- README.md | 20 ++++++++++++-------- davtelepot/__init__.py | 2 +- davtelepot/bot.py | 23 +++++++++++++++++++++++ 3 files changed, 36 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index df1965f..4f0b6ef 100644 --- a/README.md +++ b/README.md @@ -22,20 +22,24 @@ my_other_token = 'token_of_bot2' ## Usage ``` -from davtelepot import Bot +import sys +from davtelepot.bot import Bot from data.passwords import my_token, my_other_token -my_bot = Bot.get(token=my_token, db_name='my_db') -my_other_bot = Bot.get(token=my_other_token, db_name='my_other_db') +long_polling_bot = Bot(token=my_token, database_url='my_db') +webhook_bot = Bot(token=my_other_token, hostname='example.com', + certificate='path/to/certificate.pem', + database_url='my_other_db') -@my_bot.command('/foo') -async def foo_command(update): +@long_polling_bot.command('/foo') +async def foo_command(bot, update, user_record): return "Bar!" -@my_other_bot.command('/bar') -async def bar_command(update): +@webhook_bot.command('/bar') +async def bar_command(bot, update, user_record): return "Foo!" -Bot.run() +exit_state = Bot.run() +sys.exit(exit_state) ``` Check out `help(Bot)` for detailed information. diff --git a/davtelepot/__init__.py b/davtelepot/__init__.py index 46ae87b..33b22df 100644 --- a/davtelepot/__init__.py +++ b/davtelepot/__init__.py @@ -7,7 +7,7 @@ __author__ = "Davide Testa" __email__ = "davide@davte.it" __credits__ = ["Marco Origlia", "Nick Lee @Nickoala"] __license__ = "GNU General Public License v3.0" -__version__ = "2.0" +__version__ = "2.0.1" __maintainer__ = "Davide Testa" __contact__ = "t.me/davte" diff --git a/davtelepot/bot.py b/davtelepot/bot.py index 6d7afb6..98c3e68 100644 --- a/davtelepot/bot.py +++ b/davtelepot/bot.py @@ -2,6 +2,29 @@ camelCase methods mirror API directly, while snake_case ones act as middlewares someway. + +Usage + ``` + import sys + from davtelepot.bot import Bot + from data.passwords import my_token, my_other_token + + long_polling_bot = Bot(token=my_token, database_url='my_db') + webhook_bot = Bot(token=my_other_token, hostname='example.com', + certificate='path/to/certificate.pem', + database_url='my_other_db') + + @long_polling_bot.command('/foo') + async def foo_command(bot, update, user_record): + return "Bar!" + + @webhook_bot.command('/bar') + async def bar_command(bot, update, user_record): + return "Foo!" + + exit_state = Bot.run() + sys.exit(exit_state) + ``` """ # Standard library modules