Telegram bot for querying weeelab log.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.gitignore
LICENSE
Pipfile
Pipfile.lock
Procfile
README.md
requirements.txt
variables.py
weeelab_bot.py

README.md

weeelab-telegram-bot

License Version

WEEE-Open Telegram bot.

The goal of this bot is to obtain information about who is currently in the lab,
who has done what, compute some stats and, in general, simplify the life of our members...
And to avoid waste of paper as well.

All data is read from a weeelab log file, which is fetched from an OwnCloud shared folder.

Installation

Deployment of this bot has been tested only on Heroku: just connect the repo.

TODO: run it locally somehow.

weeelab_bot.py is the main script, and it requires some environment variables (imported from variables.py) to run:

  • OC_URL: Url of the owncloud server
  • OC_USER: OwnCloud username
  • OC_PWD: OwnCloud password
  • TOKEN_BOT: Telegram token for the bot API
  • LOG_PATH: Path of the file to read in owncloud (/folder/file.txt)
  • USER_BOTH_PATH: Path of the file to store bot users in OwnCloud (/folder/file.txt)
  • USER_PATH: Path of the file with authorized users in OwnCloud (/folder/file.json)

Command syntax

/start the bot and type /[COMMAND] [OPTION].

Available commands and options:

  • /inlab - Show the people in lab
  • /log - Show log of the day
  • /log n - Show last n days worth of logs
  • /log all - Show last 31 days worth of logs
  • /stat - Show hours you've spent in lab
  • /history item - Show history for an item, straight outta T.A.R.A.L.L.O.
  • /history item n - Show n history entries

Only for admin users

  • /stat name.surname - Show hours spent in lab by this user
  • /top - Show a list of top users by hours spent this month
  • /top all - Show a list of top users by hours spent