Skip to main content

Telegram bot for messages, task notifications & system management

Project description

hermes

Telegram bot for messages, task notifications & system management.

version Documentation Status


What can Hermes do?

Hermes is a Python library that provides a Telegram bot interface for your computer. It is capable of sending messages, files, or images to a specific user, either via terminal commands or inside Python scripts. Additionally, it can run as a server that interacts with specific commands received through the Telegram bot.

In detail, the functionalities of Hermes are developed around three core blocks:

  • CLI
    • send a text message
    • send images and files
    • send a message after the completion of a specific command/process (which can be carried out in background)
  • Bot server - A user can interact with the bot to execute specific commands:
    • poweroff / reboot your system
    • retrieve power statistics
    • retrieve network status
    • custom functions implemented by the user
  • Tasks
    • create a Python script using the Task module of Hermes, in order to ...
      • ... receive notifications (waypoint-based) to keep track of the script execution
      • ... send images and Matplotlib plots through the bot
      • ... create a private log file that can be retrieved through the bot server
    • failsafe: an error in Hermes does not stop your code

Requirements

  • Linux system
  • Python 3.8 or above
    • the following packages are required: pyTelegramBotAPI termcolor

Documentation

I tried to include as much as possible in the package documentation. Follow through the Setup section to install and configure Hermes. The rest of the documentation should help with the usage.



Creative Commons License
This work is licensed under a Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bothermes-2.2.0.post2.tar.gz (41.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

botHermes-2.2.0.post2-py3-none-any.whl (44.6 kB view details)

Uploaded Python 3

File details

Details for the file bothermes-2.2.0.post2.tar.gz.

File metadata

  • Download URL: bothermes-2.2.0.post2.tar.gz
  • Upload date:
  • Size: 41.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for bothermes-2.2.0.post2.tar.gz
Algorithm Hash digest
SHA256 b36781e7511de9192fac508845160e208a5edb6fd439c780adad6e8ffe02d53b
MD5 a8e308fa90aa080d0c639e13a980ccee
BLAKE2b-256 9e502049af0797afa026a34e687af60c185dfc11b08ca09829d4b4692937bcda

See more details on using hashes here.

File details

Details for the file botHermes-2.2.0.post2-py3-none-any.whl.

File metadata

File hashes

Hashes for botHermes-2.2.0.post2-py3-none-any.whl
Algorithm Hash digest
SHA256 9f8491494f4df94c2f78036ffe5038164c7cad40abc001a16579538a397c5c21
MD5 8257d8c171c83109328552fe75ec4dd1
BLAKE2b-256 ac5109e5cfb66b7b145ea8b4e959b33e59bb8cb0520c9b5db0664c7ba3a5b748

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page