Metadata-Version: 1.1
Name: mqtt-watchdir
Version: 1.3
Summary: Recursively watch a directory for modifications and publish file content to an MQTT broker
Home-page: https://github.com/jpmens/mqtt-watchdir
Author: Jan-Piet Mens
Author-email: jpmens@gmail.com
License: BSD License
Description: mqtt-watchdir
        =============
        
        This simple Python program portably watches a directory recursively and
        publishes the content of newly created and modified files as payload to
        an `MQTT <http://mqtt.org>`_ broker. Files which are deleted are
        published with a NULL payload.
        
        The path to the directory to watch recursively (default ``.``), as well
        as a list of files to ignore (``*.swp``, ``*.o``, ``*.pyc``), the broker
        host (``localhost``) and port number (``1883``) must be specified in the
        program, together with the topic prefix to which to publish to
        (``watch/``).
        
        Installation
        ------------
        
        ::
        
            git clone https://github.com/jpmens/mqtt-watchdir.git
            cd mqtt-watchdir
            virtualenv watchdir
            source watchdir/bin/activate
            pip install -e .
        
        Configuration
        -------------
        
        -  ``TOPIC_PREFIX`` is prepended onto the relative path of the file
           being accessed, and may be None.
        
        Testing
        -------
        
        Launch ``mosquitto_sub``:
        
        ::
        
            mosquitto_sub -v -t 'watch/#'
        
        Launch this program and, in another terminal, try something like this:
        
        ::
        
            echo Hello World > message
            echo JP > myname
            rm myname
        
        whereupon, on the first window, you should see:
        
        ::
        
            watch/message Hello World
            watch/myname JP
            watch/myname (null)
        
        Requirements
        ------------
        
        -  `watchdog <https://github.com/gorakhargosh/watchdog>`_, a Python
           library to monitor file-system events.
        -  `Mosquitto <http://mosquitto.org>`_'s Python module
        
        Related utilities & Credits
        ---------------------------
        
        -  Roger Light (of `Mosquitto <http://mosquitto.org>`_ fame) created
           `mqttfs <https://bitbucket.org/oojah/mqttfs>`_, a FUSE driver (in C)
           which works similarly.
        -  Roger Light (yes, the same busy gentleman) also made
           `treewatch <https://bitbucket.org/oojah/treewatch>`_, a program to
           watch a set of directories and execute a program when there is a
           change in the files within the directories.
        -  Thanks to Karl Palsson for ``setup.py``.
        
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Topic :: Communications
Classifier: Topic :: Internet
