Metadata-Version: 1.0
Name: stream_monitor
Version: 2018.4.19.2211
Summary: monitoring and alerting program for data streams such as recording files that update regularly
Home-page: https://github.com/wdbm/stream_monitor
Author: Will Breaden Madden
Author-email: wbm@protonmail.ch
License: GPLv3
Description: stream\_monitor
        ===============
        
        This program monitors a specified set of data streams (files) for
        changes. If a file is not changed in a specified time, an alert is sent
        using Pushbullet.
        
        setup
        =====
        
        .. code:: bash
        
            pip install stream_monitor
        
        Set up a Pushbullet account, create an access token and store a
        Pushbullet token in the file ``~/.pushbullet``. Install Pushbullet on a
        mobile device.
        
        -  `Pushbullet
           settings <https://www.pushbullet.com/#settings/account>`__
        -  `Pushbullet
           Android <https://play.google.com/store/apps/details?id=com.pushbullet.android>`__
        
        configuration and usage
        =======================
        
        A JSON configuration file (by default
        ``stream_monitor_configuration.json``) guides the program on the streams
        to monitor and their required update times. Its contents are of the
        following form:
        
        .. code:: python
        
            {
                "streams": {
                    "./recording.csv": {"update_time"}: 30
                }
            }
        
        In this example configuration, ``recording.csv`` is a filepath to
        monitor for changes and ``30`` is the time in seconds within which the
        filepath should change.
        
        When the program ``stream_monitor`` is executed, it imports the
        configuration and runs in a continuous loop, sending a Pushbullet alert
        whenever it detects that a stream is not being updated in its expected
        update time. The script has options for the configuration filepath,
        alarms, checking interval and verbosity (see ``stream_monitor --help``).
        
Platform: UNKNOWN
