Yet another common wrapper for Alice skills and Facebook/Telegram bots
Project description
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 Alice/Telegram/Facebook/VK:
DialogConnector - A number of simple dialogue constructors:
BaseDialogManagerand its flavors, including:- a simple FAQ dialog manager
- a simple form-filling dialog manager
- A wrapper for storing dialogue state:
BaseStorageand its flavors (specifially,MongoBasedStorage) - Yet another wrapper for serving your bot as a Flask application
This package may be installed with pip install tgalice.
A brief how-to
To create your own bot, you need either to write a config for an existing dialog manager,
or to inherit your own dialog manager from BaseDialogManager.
The components of tgalice may be combined into a working app as follows:
import tgalice
class EchoDialogManager(tgalice.dialog_manager.BaseDialogManager):
def respond(self, ctx: tgalice.dialog.Context):
return tgalice.dialog.Response(text=ctx.message_text)
connector = tgalice.dialog_connector.DialogConnector(
dialog_manager=EchoDialogManager(),
storage=tgalice.session_storage.BaseStorage()
)
server = tgalice.flask_server.FlaskServer(connector=connector)
if __name__ == '__main__':
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 webhook for Telegram will be set automatically, if you set the TOKEN environment variable to the token
given to you by the @BotFather.
If you want to test your app locally, you can run it with command line args:
--cli- to read and type messages in command line, completely offline--poll- to run a Telegram bot locally, in long polling mode (in some countries, you need a VPN to do this)--ngrok- to run the bot locally, using the ngrok tool** to create a tunnel from your machine into the internet. This is probably the simplest way to test Alice skills without deploying them anywhere .
The examples directory contains more detailed examples of how to create dialogs and serve the bot.
If you have questions, you can ask them in the Telegram chat @tgalice_support.
* The Telegram wrapper is based on the pyTelegramBotAPI package.
** The ngrok connector was taken from the flask-ngrok library. It will be refactored to a dependency, as soon as the library is updated on PyPI.
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.
Source Distribution
File details
Details for the file tgalice-0.2.6.tar.gz.
File metadata
- Download URL: tgalice-0.2.6.tar.gz
- Upload date:
- Size: 33.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/44.0.0 requests-toolbelt/0.9.1 tqdm/4.40.2 CPython/3.6.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 9a147080d90ea347e88a3dceee7fe23f542362ed4a96b580a43be98a20105a80 |
|
| MD5 | 57c934f72033149e4203670eee6b3f77 |
|
| BLAKE2b-256 | f8ea878f3037e7d5ba0d33daf44c977463b2242ca2d7ac788f528a95ddc0eaa5 |
