tgalice 0.1.3

Yet another common wrapper for Telegram bots and Alice skills

tgalice

This is yet another common Python wrapper for Telegram bots^*, Alice skills, and Facebook Messenger bots.

Currently, it provides:

• An (almost) unified interface between your bot and Telegram or Alice: DialogConnector
• A number of simple dialogue constructors: BaseDialogManager and its flavors, including:
  • a simple FAQ dialog manager
  • a simple form-filling dialog manager
• A wrapper for storing dialogue state: BaseStorage and its flavors (specifially, MongoBasedStorage)

This package may be installed with

pip install tgalice

The three components of tgalice may be combined as follows:

import tgalice
connector = tgalice.dialog_connector.DialogConnector(
    dialog_manager=tgalice.dialog_manager.BaseDialogManager(), 
    storage=tgalice.session_storage.BaseStorage()
)

Now you can plug both Alice and Telegram into the connector. In the example below, they are served with Flask.

@app.route("/" + ALICE_URL, methods=['POST'])
def alice_response():
    response = connector.respond(request.json, source='alice')
    return json.dumps(response, ensure_ascii=False, indent=2)


@bot.message_handler(func=lambda message: True)
def telegram_response(message):
    response = connector.respond(message, source='telegram')
    bot.reply_to(message, **response)

To reduce the amount of boilerplate code even more, you can use the FlaskServer class, which configures both Alice and Telegram for you, and can also run in pure command line mode (e.g. if you want to test your bot without internet connection).

server = tgalice.flask_server.FlaskServer(connector=connector)
server.parse_args_and_run()

Now, if your app is hosted on address {BASE_URL}, then webhooks for Alice and Facebook will be available, respectively, at {BASE_URL}/alice/ and {BASE_URL}/fb/ (and you can reconfigure it, if you want).

The examples directory contains more detailed examples of how to create dialogs and serve the bot.

* The Telegram wrapper is based on the pyTelegramBotAPI package.