A python module to auto build conversation for a Telegram bot
Project description
Setup
You can find the package on PyPi (pip), here.
pip3 install telegram-autoconv
Requirements
Import
from autoconv.state import State
from autoconv.conversation import Conversation
from autoconv.autoconv_handler import AutoConvHandler
Persistence
If you want to use persistence in your bot, Autoconv provides a simple persistence based on PicklePersistence. The normal PicklePersistence doesn't work, due to an instance of a Telegram.Message
in the user_data
, this persistence uses a workaround.
from autoconv.persistence import AutoconvPersistence
persistence = AutoconvPersistence(filename="bot_persistence", bot_token=BOT_TOKEN)
updater = Updater(BOT_TOKEN, persistence=persistence)
WARNING! This persistence will save the bot token in a pickle file.
Examples
I know you want examples, in fact there is a beautiful folder with some examples.
In the table below, you can find an example for every functions in the module.
Function | Example | Documentation |
---|---|---|
add_keybord |
keyboards.py | State |
add_text |
actions.py | State |
add_action |
actions.py | State |
add_dynamic_keybord |
keyboards.py | State |
add_custom_keyboard |
keyboards.py | State |
add_dynamic_routes |
keyboards.py | State |
add_dynamic_list |
dynamic_list.py | State |
add_custom_handler |
handlers.py | State |
set_long_task |
actions.py | State |
add_refresh_auth |
authorization.py | State |
add_operation_buttons |
keyboards.py | State |
Conversation |
conversation.py | Conversation |
add_routes |
conversation.py | Conversation |
set_defaults |
defaults.py | Conversation |
add_authorized_users |
authorization.py | Conversation |
state_messages |
texts.py | Texts Guide |
restart |
autoconv_handler.py | AutoConvHandler |
force_state |
autoconv_handler.py | AutoConvHandler |
Documentation
Do you want to read? I got you cover, baby!
No more than a little documentation in the Wiki.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.