summaryrefslogtreecommitdiff
path: root/README.md
blob: ce8082d7129ed4509e44439b1dcb0c489688a425 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
# Pikud Ha'oref Alarm Tracking

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.

![example.png](example.png)

## 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.
```