Skip to content

Latest commit

 

History

History
59 lines (39 loc) · 2.19 KB

README.md

File metadata and controls

59 lines (39 loc) · 2.19 KB
Raw

Andaluh Telegram Bot

Deploy

Transliterate your spanish to andaluh EPA using this telegram bot. This bot stores user preferences after interacting with the transliteration options.

andaluh-slack about

Table of Contents

Installation

First install dependencies

You can setup 4 environment variables to integrate with Telegram. Only TOKEN is mandatory:

  • APIURL: URl for your andaluh-api instance. You can use ours as well https://api.andaluh.es/epa
  • TOKEN: Create your bot with Telegram's BotFather to retrieve your TOKEN
  • USERPREF_PATH: Where to store the user preferences persistence storage
  • IMG_BASEURL: Base url of the option icons, by default uses those hosted at https://andaluh.es. You can use the .env file to store them secretly. Use the .env.example template:
$ cp .env.example .env # and edit the file!

Then you can run the bot using the run.sh script for development purposes:

$ pip3 install -r requirements.txt
$ run.sh

Or dockerised, a better option for production deployments:

$ docker-compose up --build -d

IMPORTANT NOTE: In order to collect user preferences, you need to ENABLE inline feedback with /setinlinefeedback BotFather command. Please check doc for further reference: https://core.telegram.org/bots/inline#collecting-feedback

Roadmap

  • Add andaluh-py as an option instead of API.
  • Add a new command to set user preferences
  • Add a new command to explain how a transliteration is done, rule by rule. For educational purposes.
  • Add a new command to retrieve andalugeeks memes. For fun!

Support

Please open an issue for support.

Contributing

Please contribute using Github Flow. Create a branch, add commits, and open a pull request.