Merge branch 'entr'

Author: tony

.tmuxp.yaml

@@ -12,7 +12,8 @@ windows:
   panes:
   - focus: true
   - pane 
-  - sniffer
+  - if command -v entr > /dev/null; then find . -type f -not -path '*/\.*' | grep -i '.*[.]py$' | entr -c ./run-tests.py; else ./run-tests.py; echo "\nInstall entr(1) to automatically run tests on file change.\n See http://entrproject.org/"; fi
+
 - window_name: docs
   layout: main-horizontal
   options:
@@ -24,4 +25,4 @@ windows:
   - focus: true
   - pane
   - echo 'docs built to <http://0.0.0.0:8003/_build/html>'; python -m SimpleHTTPServer 8003
-  - sniffer
+  - if command -v entr > /dev/null; then find .. -print | grep -i '.*[.]rst' | entr -c make html; else make html; echo "\nInstall entr(1) to automatically rebuild documentation when files change. \nSee http://entrproject.org/"; fi

bootstrap_env.py

@@ -106,6 +106,14 @@ def which(exe=None, throw=True):
 
 
 def main():
+    if not which('entr', throw=False):
+        message = (
+            '\nentr(1) is used in this app as a cross platform file watcher.'
+            'You can install it via your package manager on most POSIX '
+            'systems. See the site at http://entrproject.org/\n'
+        )
+        print(message)
+
     if not virtualenv_exists:
         virtualenv_bin = which('virtualenv', throw=False)
 
@@ -117,24 +125,6 @@ def main():
             [pip_bin, 'install', '-e', project_dir]
         )
 
-    if not os.path.isfile(os.path.join(env_dir, 'bin', 'sniffer')):
-        subprocess.check_call(
-            [pip_bin, 'install', 'sniffer']
-        )
-
-    if platform.system() == 'Linux':
-        subprocess.check_call(
-            [pip_bin, 'install', 'pyinotify']
-        )
-    elif platform.system() == 'Darwin':
-        subprocess.check_call(
-            [pip_bin, 'install', 'MacFSEvents']
-        )
-    elif platform.system() == 'Windows':
-        subprocess.check_call(
-            [pip_bin, 'install', 'pywin32']
-        )
-
     if not os.path.isfile(os.path.join(env_dir, 'bin', 'sphinx-quickstart')):
         subprocess.check_call(
             [pip_bin, 'install', '-r', sphinx_requirements_filepath]

doc/developing.rst

@@ -134,22 +134,25 @@ Run tests on save
 You can re-run tests automatically on file edit.
 
 .. note::
-    This requires and installation of ``sniffer`` from pypi.
+    This requires ``entr(1)``.
 
-Install `sniffer`_ from `pypi`_:
+Install `entr`_.  Packages are available available on most Linux and BSD
+variants, including Debian, Ubuntu, FreeBSD, OS X.
+
+To run all tests upon editing any ``.py`` file:
 
 .. code-block:: bash
 
-    $ pip install sniffer
+    $ find . -type f -not -path '*/\.*' | grep -i '.*[.]py$' | entr -c ./run-tests.py
 
-To run all tests upon editing any ``.py`` file:
+.. _entr: http://entrproject.org/
 
-.. code-block:: bash
+Rebuild the documentation when an ``.rst`` file is edited:
 
-    $ sniffer
+.. code-block:: bash
 
-.. _sniffer: https://github.com/jeffh/sniffer
-.. _pypi: https://pypi.python.org/pypi
+   $ cd doc
+   $ find .. -print | grep -i '.*[.]rst' | entr -c make html
 
 .. _tmuxp developer config: