Metadata-Version: 2.1
Name: alarmpy
Version: 1.0.2
Summary: Pikud Ha'oref Alarm Tracking
Home-page: https://github.com/yuvadm/alarmpy
Author: Yuval Adam
Author-email: _@yuv.al
License: GPLv3
Project-URL: Bug Tracker, https://github.com/yuvadm/alarmpy/issues
Description: # 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)
        
        ## ⚠️ Disclaimer ⚠️
        
        This tool is based on an unofficial API, and cannot be guaranteed to show correct or timely data. **Do not** use it if human life is at stake. **Do not** assume it shows you correct data. **Do not** assume it works properly, or even works at all. Always follow official guidelines and procedures published by [Pikud Ha'oref](https://www.oref.org.il/).
        
        Further fine-print covering the terms of use of this tool can be found in the [GPLv3 license](LICENSE) file.
        
        ## 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:
          --language [en|he|ar|ru]  Alert language
          --delay INTEGER           Polling delay in seconds
          --routine-delay INTEGER   Routine message delay in seconds
          --alarm-id                Print alarm IDs
          --repeat-alarms           Do not suppress ongoing alarms
          --quiet                   Print only active alarms
          --help                    Show this message and exit.
        ```
        
        ## License
        
        [GPLv3](LICENSE)
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Environment :: Console
Requires-Python: >=3.6
Description-Content-Type: text/markdown
