initial commit

Author: mcgillij

README.md

@@ -1,2 +1,83 @@
 # http_monitor
 py3status module for monitoring http services
+
+## Prerequisites
+
+This is an i3 / py3status module, so you'll need those first off.
+
+## Installation
+
+```bash
+git clone git@github.com:mcgillij/http_monitor.git ~/.i3/py3status/
+```
+
+## Configuration
+
+Next you will need to add the services you want to monitor, and optionally choose some appropriate emoji's.
+
+Here's an excerpt from my configuration file located at *~/.config/i3/i3status.conf*.
+
+**~/.config/i3/i3status.conf**
+
+```bash
+...
+general {
+        colors = true
+        interval = 15
+}
+
+order += "http_monitor apache"
+order += "http_monitor medusa"
+order += "http_monitor pihole"
+order += "http_monitor nextcloud"
+order += "http_monitor plex"
+order += "http_monitor virtualbox"
+order += "http_monitor airsonic"
+order += "clock"
+order += "mail"
+...
+
+http_monitor  'nextcloud' {
+   service_location = "http://yourserver:8181"
+   service_name = '⛅'
+}
+
+http_monitor  'virtualbox' {
+   service_location = "http://yourserver:81/vb/"
+   service_name = '💻'
+}
+
+http_monitor  'plex' {
+   service_location = "http://yourserver:32400/web/index.html#"
+   service_name = '🎥'
+}
+
+http_monitor  'airsonic' {
+   service_location = "http://yourserver:4040"
+   service_name = '🍃'
+}
+
+http_monitor  'pihole' {
+   service_location = "http://yourserver:80"
+   service_name = '🕳️ '
+}
+
+http_monitor  'apache' {
+   service_location = "http://yourserver:81"
+   service_name = '🪶'
+}
+
+http_monitor  'medusa' {
+   service_location = "http://yourserver:8081"
+   service_name = '🐍'
+}
+``` 
+## Configuration Options
+
+You can pass in the following configuration options:
+
+* service_location
+* service_name
+* timeout
+* cache_timeout
+

http_monitor.py

@@ -0,0 +1,37 @@
+# -*- coding: utf-8 -*-
+"""
+Module to display the status of a remote web service
+"""
+
+class Py3status:
+    cache_timeout = 600
+    service_name = "test"
+    service_location = "http://example.com"
+    timeout = 3
+    status_good = "🟢"
+    status_bad = "🔴"
+    format = '{service_name}: {status}'
+
+    def _get_status(self):
+        try:
+            self.py3.log(self.service_location)
+            status = self.py3.request(self.service_location, timeout=self.timeout)
+            if status.status_code != 200:
+                return self.status_bad
+            return self.status_good
+
+        except self.py3.RequestException as re:
+            return self.status_bad
+
+    def http_monitor(self):
+        status = self._get_status()
+        full_text = self.py3.safe_format(self.format, {'service_name': self.service_name, 'status': status})
+        return {
+            'full_text': full_text,
+            'cached_until': self.py3.time_in(self.cache_timeout)
+        }
+
+
+if __name__ == "__main__":
+    from py3status.module_test import module_test
+    module_test(Py3status)

pyproject.toml

@@ -0,0 +1,16 @@
+[tool.poetry]
+name = "http_monitor"
+version = "0.1.0"
+description = ""
+authors = ["mcgillij <mcgillivray.jason@gmail.com>"]
+license = "MIT"
+
+[tool.poetry.dependencies]
+python = "^3.9"
+py3status = "^3.31"
+
+[tool.poetry.dev-dependencies]
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"