diff options
| author | Yuval Adam <_@yuv.al> | 2021-05-13 16:07:50 +0300 |
|---|---|---|
| committer | Yuval Adam <_@yuv.al> | 2021-05-13 16:07:50 +0300 |
| commit | c9e5549f1ed30760bac04d1e7bcec1153e258194 (patch) | |
| tree | 9efb7b504bc10527bf72c6904fe719be115b7554 | |
| parent | 9c44a7feda6148d8940d7cb102040684ea1d5e02 (diff) | |
Move params around and add usage in README
| -rw-r--r-- | README.md | 15 | ||||
| -rw-r--r-- | alarmpy.py | 10 |
2 files changed, 22 insertions, 3 deletions
@@ -2,9 +2,24 @@ A simple CLI tool for tracking Pikud Ha'oref alarms. +Polls the unofficial API endpoint every second for incoming alarms. Prints active alarms as they occur. Prints routine messages once every 5 minutes by default. + ## Usage ```bash $ pipenv sync $ pipenv run alarmpy ``` + +Advanced flags can be set as described in the usage: + +```bash +$ pipenv run alarmpy --help +Usage: alarmpy.py [OPTIONS] + +Options: + --delay INTEGER Polling delay in seconds + --routine-delay INTEGER Routine message delay in seconds + --alarm-id Print alarm ID + --help Show this message and exit. +``` @@ -62,12 +62,16 @@ class Alarm(object): @click.command() @click.option("--delay", default=1, help="Polling delay in seconds") -@click.option("--alarm-id", is_flag=True, help="Print alarm ID") @click.option( "--routine-delay", default=60 * 5, help="Routine message delay in seconds" ) -def alarm(delay, alarm_id, routine_delay): - Alarm(delay=delay, alarm_id=alarm_id, routine_delay=routine_delay).start() +@click.option("--alarm-id", is_flag=True, help="Print alarm ID") +def alarm(delay=1, routine_delay=60 * 5, alarm_id=False): + Alarm( + delay=delay, + routine_delay=routine_delay, + alarm_id=alarm_id, + ).start() if __name__ == "__main__": |
