penyaskito/andaluh-telegram

Telegram bot to transliterate español (spanish) spelling to andaluz proposals

Andaluh Telegram Bot

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

Table of Contents

• Installation
• Roadmap
• Support
• Contributing

Installation

First install dependencies

You need to setup 3 environment variables to integrate with Telegram:

• 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

You can use the .env file to store them secretely. 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 exaplain how a transliteration is done, rule by rule. For educationan 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.