polymonitor 0.1.6

Polymonitor can be used as a stand alone CLI tool to quickly check the status of a URL or as a plugin for polybar.

Polymonitor

Polymonitor can be used as a stand alone CLI tool to quickly check the status of a URL or as a plugin for polybar.

Installation

Use the package manager pip to install polymonitor.

$ pip install polymonitor

Alternatively you can clone the git repository and use Poetry to install it.

$ git clone https://github.com/hegelocampus/polymonitor
$ cd polymonitor
$ poetry install

Usage

polymonitor --help 
usage: Displays site status for polybar. [-h] [-s] [-c] [-u URLS [URLS ...]]

optional arguments:
  -h, --help            show this help message and exit
  -s, --symbolic        Displays the results as symbols
  -c, --compact         Reduces the results into a more compact package
  -u URLS [URLS ...], --urls URLS [URLS ...]
                        Pass in URLs to monitor

A basic use case would be quickly printing the status of web-apps you'd like to check on:

$ polymonitor -cu duckduckgo.com google.com google.com/404
Up: 2 Down: google.com/404

Note that you do not need to preface the URLs with a protocol (e.g., https://). If you do not provide a full URL https:// will be prefixed to your URL before it is pinged.

You can leave off the -c flag for more verbose output:

$ polymonitor -cu duckduckgo.com google.com google.com/404
google.com: Up google.com/404: Down duckduckgo.com: Up

Polybar Use

If you would like to use this tool in your polybar you need to add the following to your polybar config:

[module/polymonitor]
type = custom/script
exec = polymonitor -cu duckduckgo.com google.com twitter.com cloudflare.com
interval = 10800

This is what the above configuration will generate:

Note that if you are using this to ping your own web-pages, you may want to raise the interval to only refresh every couple hours. The interval is specified in seconds so one hour would be interval = 3600 and the above example would refresh every three hours.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT