jackfruit 0.12

Generic views for python-telegram-bot

Jackfruit

Introduction

This library provides a simple way for creating telegram bots with deep level menu.

Components

Library give users components, like:

• Menu (MenuView) - give user ability select menu item and navigate on menus;
• Text Input (TextDataInputView) - give user ability enter text data;
• Image Input (PhotoDataInputView) - give user ability send image to bot;
• Document Input (DocumentDataInputView) - give user ability send files to bot;
• Audio Input (AudioDataInputView) - give user ability send audio files to bot;
• Video Input (VideoDataInputView) - give user ability send video files to bot;
• Voice Input (VoiceDataInputView) - give user ability send voice messages to bot;
• Sticker Input (StickerDataInputView) - give user ability send sticker to bot;

You can use class GenericDataView for show user screen, that blocking next navigation and force user to use command syntax.

All components may be easy customized, for more details please see source code (it have commented).

Usage

from os import environ

from telegram.ext import Updater

from jackfruit import *


class MainMenu(MenuView):
    text = 'Hello from my bot!'
    menu_items = [[('Enter my name', 'EnterName'), ('Select my age', 'SelectAge')], ]


class EnterName(TextDataInputView):
    text = 'Enter my name:'

    def process_data(self, state, update, context, data):
        return 'MainMenu'


class SelectAge(MenuView):
    text = 'Select my age:'
    menu_items = [[('Below 18', 'MainMenu'), ('Above 18', 'MainMenu')]]


updater = Updater(environ['TOKEN'], use_context=True)
main_menu = MainMenu()
enter_name = EnterName()
select_age = SelectAge()
Jackfruit(updater.dispatcher, main_menu, [('start', 'MainMenu')]).register(enter_name, select_age)
updater.start_polling()
updater.idle()