/pytmbot

A simple Telegram bot designed to gather basic information about the status of your local servers, writing on Python

Primary LanguagePythonMIT LicenseMIT

pyTMbot

pyTMbot

A simple Telegram bot designed to gather basic information about the status of your local servers. The bot operates synchronously. It does not use webhooks.

Security Rating Vulnerabilities Quality Gate Status Bugs Maintainability Rating Code Smells Duplicated Lines (%) Codacy Badge

The bot was written using the pyTelegramBotAPI. Use psutil and docker-py libraries for gather information.

💡 Features

  • Load average information
  • Summary memory usage information (with swap)
  • Sensors information
  • Summary process information
  • Uptime information
  • File system base information
  • Containers (only docker and only on Linux) base information
  • Use Jinja2 for answers template
  • Use docker logs collector (sudo docker logs container_id)
  • Use emoji :)

Screenshots are available here: screenshots.md. Video demo see in Youtube Shorts here

🪤 Requirements

Initially, the bot was designed to ensure its correct operation only within the Docker container. I have not tested it running on a local system, either inside or outside a virtual environment. Therefore, please make sure that Docker is installed on your system.

Full list of Python dependencies see in requirements.txt

🔌 Installation, setup and run bot

🛡 Secure

The bot has a user.id authorization mechanism (specified at the initial stage of configuration). If the user.id is not specified, the bot will report that it is unable to access information about the server.

📈 Roadmap

👾 Known issues

  • You tell me :)

🧬 Authors

🚀 About Me

I am a novice Python developer. This is my first publicly available project in this great programming language.

📜 License

MIT License