Script for bootstrapping tmuxp dev environment requirements in a python file, using script_before. Update JSON and YAML example configs.

Author: tony

.tmuxp.json

@@ -1,68 +1,42 @@
 {
+  "before_script": "./bootstrap_env.py", 
   "windows": [
     {
       "panes": [
         {
-          "shell_command": [
-            "reset", 
-            "vim", 
-            ":Ex"
-          ], 
           "focus": true
         }, 
-        "pane",
-        {
-          "shell_command": [
-            "command -v .env/bin/tmuxp >/dev/null 2>&1 || { pip install -e .; }", 
-            "command -v watching_testrunner >/dev/null 2>&1 || { pip install watching_testrunner; }", 
-            "watching_testrunner --basepath ./ --pattern=\"*.py\" 'python run-tests.py'"
-          ]
-        }
+        "pane", 
+        "watching_testrunner --basepath ./ --pattern=\"*.py\" 'python run-tests.py'"
       ], 
       "options": {
         "main-pane-height": 35
       }, 
       "layout": "main-horizontal", 
       "shell_command_before": [
-        "command -v virtualenv >/dev/null 2>&1 || { pip install virtualenv; }", 
-        "[ -d .env -a -f .env/bin/activate ] && source .env/bin/activate || virtualenv .env", 
-        "[ ! -d .env/build ] || rm -rf .env/build"
+        "[ -d .env -a -f .env/bin/activate ] && source .env/bin/activate"
       ], 
       "focus": true, 
       "window_name": "tmuxp"
     }, 
     {
       "panes": [
         {
-          "shell_command": [
-            "reset", 
-            "vim", 
-            ":Ex"
-          ], 
           "focus": true
         }, 
-        "pwd", 
+        "pane", 
         "echo 'docs built to <http://0.0.0.0:8003/_build/html>'; python -m SimpleHTTPServer 8003", 
-        {
-          "shell_command": [
-            "command -v sphinx-quickstart >/dev/null 2>&1 || { pip install -r requirements.pip; }", 
-            "command -v watching_testrunner >/dev/null 2>&1 || { pip install watching_testrunner; }", 
-            "watching_testrunner --basepath ./ --pattern=\"*.rst\" 'make html'"
-          ]
-        }
+        "watching_testrunner --basepath ./ --pattern=\"*.rst\" 'make html'"
       ], 
+      "start_directory": "doc/", 
+      "layout": "main-horizontal", 
       "shell_command_before": [
-        "command -v virtualenv >/dev/null 2>&1 || { pip install virtualenv; }", 
-        "[ -d .env -a -f .env/bin/activate ] && source .env/bin/activate || virtualenv .env", 
-        "[ ! -d .env/build ] || rm -rf .env/build", 
-        "command -v .env/bin/tmuxp >/dev/null 2>&1 || { pip install -e .; }", 
-        "cd ./doc"
+        "[ -d ../.env -a -f ../.env/bin/activate ] && source ../.env/bin/activate"
       ], 
-      "layout": "main-horizontal", 
-      "window_name": "docs", 
       "options": {
         "main-pane-height": 35
-      }
+      }, 
+      "window_name": "docs"
     }
   ], 
   "session_name": "tmuxp", 

.tmuxp.yaml

@@ -1,45 +1,27 @@
 session_name: tmuxp
 start_directory: ./ # load session relative to config location (project root).
+before_script: ./bootstrap_env.py # ./ to load relative to project root.
 windows:
 - window_name: tmuxp
   focus: True
   layout: main-horizontal
   options:
     main-pane-height: 35
   shell_command_before:
-    - command -v virtualenv >/dev/null 2>&1 || { pip install virtualenv; }
-    - '[ -d .env -a -f .env/bin/activate ] && source .env/bin/activate || virtualenv .env'
-    - '[ ! -d .env/build ] || rm -rf .env/build'
+    - '[ -d .env -a -f .env/bin/activate ] && source .env/bin/activate'
   panes:
-  - shell_command: 
-    - reset
-    - vim
-    - :Ex
-    focus: true
+  - focus: true
   - pane 
-  - shell_command: 
-    - command -v .env/bin/tmuxp >/dev/null 2>&1 || { pip install -e .; }
-    - command -v watching_testrunner >/dev/null 2>&1 || { pip install watching_testrunner; }
-    - watching_testrunner --basepath ./ --pattern="*.py" 'python run-tests.py'
+  - watching_testrunner --basepath ./ --pattern="*.py" 'python run-tests.py'
 - window_name: docs
   layout: main-horizontal
   options:
     main-pane-height: 35
+  start_directory: doc/
   shell_command_before: 
-    - command -v virtualenv >/dev/null 2>&1 || { pip install virtualenv; }
-    - '[ -d .env -a -f .env/bin/activate ] && source .env/bin/activate || virtualenv .env'
-    - '[ ! -d .env/build ] || rm -rf .env/build'
-    - command -v .env/bin/tmuxp >/dev/null 2>&1 || { pip install -e .; }
-    - cd ./doc
+    - '[ -d ../.env -a -f ../.env/bin/activate ] && source ../.env/bin/activate'
   panes:
-  - shell_command:
-    - reset
-    - vim
-    - :Ex
-    focus: true
-  - pwd
+  - focus: true
+  - pane
   - echo 'docs built to <http://0.0.0.0:8003/_build/html>'; python -m SimpleHTTPServer 8003
-  - shell_command:
-    - command -v sphinx-quickstart >/dev/null 2>&1 || { pip install -r requirements.pip; }
-    - command -v watching_testrunner >/dev/null 2>&1 || { pip install watching_testrunner; }
-    - watching_testrunner --basepath ./ --pattern="*.rst" 'make html'
+  - watching_testrunner --basepath ./ --pattern="*.rst" 'make html'

bootstrap_env.py

@@ -0,0 +1,133 @@
+#!/usr/bin/env python
+
+from __future__ import absolute_import, division, print_function, \
+    with_statement, unicode_literals
+
+
+import os
+import sys
+import subprocess
+
+
+def warning(*objs):
+    print("WARNING: ", *objs, file=sys.stderr)
+
+
+def fail(message):
+    sys.exit("Error: {message}".format(message=message))
+
+
+PY2 = sys.version_info[0] == 2
+if PY2:
+    from urllib import urlretrieve
+else:
+    from urllib.request import urlretrieve
+
+
+def has_module(module_name):
+    try:
+        import imp
+        imp.find_module(module_name)
+        del imp
+        return True
+    except ImportError:
+        return False
+
+
+def which(exe=None, throw=True):
+    """Return path of bin. Python clone of /usr/bin/which.
+
+    from salt.util - https://www.github.com/saltstack/salt - license apache
+
+    :param exe: Application to search PATHs for.
+    :type exe: string
+    :param throw: Raise ``Exception`` if not found in paths
+    :type throw: bool
+    :rtype: string
+
+    """
+    if exe:
+        if os.access(exe, os.X_OK):
+            return exe
+
+        # default path based on busybox's default
+        default_path = '/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin'
+        search_path = os.environ.get('PATH', default_path)
+
+        for path in search_path.split(os.pathsep):
+            full_path = os.path.join(path, exe)
+            if os.access(full_path, os.X_OK):
+                return full_path
+
+        message = (
+            '{0!r} could not be found in the following search '
+            'path: {1!r}'.format(
+                exe, search_path
+            )
+        )
+
+        if throw:
+            raise Exception(message)
+        else:
+            print(message)
+    return None
+
+
+project_dir = os.path.dirname(os.path.realpath(__file__))
+env_dir = os.path.join(project_dir, '.env')
+pip_bin = os.path.join(env_dir, 'bin', 'pip')
+python_bin = os.path.join(env_dir, 'bin', 'python')
+virtualenv_bin = which('virtualenv', throw=False)
+virtualenv_exists = os.path.exists(env_dir) and os.path.isfile(python_bin)
+sphinx_requirements_filepath = os.path.join(project_dir, 'doc', 'requirements.pip')
+
+
+try:
+    import virtualenv
+except ImportError:
+    message = (
+        'Virtualenv is required for this bootstrap to run.\n'
+        'Install virtualenv via:\n'
+        '\t$ [sudo] pip install virtualenv'
+    )
+    fail(message)
+
+
+try:
+    import pip
+except ImportError:
+    message = (
+        'pip is required for this bootstrap to run.\n'
+        'Find instructions on how to install at: %s' %
+        'http://pip.readthedocs.org/en/latest/installing.html'
+    )
+    fail(message)
+
+
+def main():
+    if not virtualenv_exists:
+        virtualenv_bin = which('virtualenv', throw=False)
+
+        subprocess.check_call(
+            [virtualenv_bin, env_dir]
+        )
+
+        subprocess.check_call(
+            [pip_bin, 'install', '-e', project_dir]
+        )
+
+    if not os.path.isfile(os.path.join(env_dir, 'bin', 'watching_testrunner')):
+        subprocess.check_call(
+            [pip_bin, 'install', 'watching-testrunner']
+        )
+
+    if not os.path.isfile(os.path.join(env_dir, 'bin', 'sphinx-quickstart')):
+        subprocess.check_call(
+            [pip_bin, 'install', '-r', sphinx_requirements_filepath]
+        )
+
+    if os.path.exists(os.path.join(env_dir, 'build')):
+        os.removedirs(os.path.join(env_dir, 'build'))
+
+if __name__ == '__main__':
+    main()