niltsiar / python-telegram-bot-toggl-alarm

Python Telegram Bot: Toggl Alarm!

Bot para Telegram que coneca con tu cuenta de Toggl y te envía una recompensa o castigo en función de si el día anterior has imputado las horas en Toogl.

Es de uso personal ya que depende de la API TOKEN de Toggl del usuario

Más información en https://fenomenomutante.com/8

• Python Telegram Bot: Toggl Alarm!
  • Requerimientos previos
    • Telegram Token
    • Toggl API Key
  • Instalación
    • Dependencias
    • Variables de entorno
    • Ejecución
  • Modo de uso
  • Librerías utilizadas
  • TODO

Requerimientos previos

Telegram Token

Debes conseguir un token para el bot que vayas a enganchar con esta aplicación.

Sigue las instrucciones del "padre de los bots" en Telegram, utilizando el bot @BotFather

Más info en telegram

Toggl API Key

La API Key de Toggl te da acceso a los informes de registros del usuario.

Más info en https://github.com/toggl/toggl_api_docs

Instalación

Necesitamos un sistema conectado a internet y el repositorio descargado. El programa funciona con python 3

Dependencias

Primero instalamos las dependencias ejecutando este comando del gestor de paquetes pip

pip install -r requirements.txt

Variables de entorno

Copiamos el fichero .env.example y lo convertimos en .env

cp .env.example .env

Sustituimos los valores de los token y API key para el bot de telegram y la cuenta de toggl

Ejecución

python main.py

Modo de uso

Abrimos una conversación con el bot de telegram.

Tenemos estos comandos disponibles

• /set arrancará la alarma. Se ejecutará cada día a esta misma hora
• /unset detiene la alarma
• /help Muestra la ayuda

El bot se conectará a toggl y devolverá un emoticono de 💩 si no se han imputado las horas en el día anterior y un emoticono 💃🏻 si se ha ejecutado correctamente.

Librerías utilizadas

• https://python-telegram-bot.org/
• https://github.com/theskumar/python-dotenv

TODO

• Tarea ejecutada diariamente
• Log optativo
• Elegir la hora de la alarma
• Elegir los días para recibir la alarma
• Acumulado de días o método Jerry Seinfeld