introduced splits, delays and readme

Author: fmauch

README.md

@@ -0,0 +1,15 @@
+# Catmux
+
+## DISCLAIMER - IN HEAVY DEVELOPMENT
+This package is currently in early development phase. It's interface might completely change and/or
+functionality might be moved around or even removed without notice. Use it at your own risks and
+report issues and problems :)
+
+
+## About
+Catmux is a little helper to run a tmux session with multiple windows and panes with just one
+command. It is inspired and functionally very similar to [tmuxinator](https://github.com/tmuxinator/tmuxinator), but without the project management feature which is in my opinion kind of an overhead.
+
+Session configs can be stored anywhere and have to given as an argument.
+
+

etc/example_session.yaml

@@ -1,11 +1,49 @@
 ---
 common:
   before_commands:
-    - fzirob change_environment
+    - fzirob change_environment # before commands can be specified global and per window
+  default_window: README # This window will be visible when first attaching to the session
 windows:
   - name: roscore
+    splits:
+      - commands:
+        - roscore
+    delay: 1 # Use this to wait before starting the next window
+  - name: tiled
+    layout: tiled
+    splits:
+      - commands:
+        - echo "hello"
+        - echo "world"
+      - commands:
+        - echo "1"
+      - commands:
+        - echo "2"
+      - commands:
+        - echo "3"
+      - commands:
+        - echo "4"
+  - name: left-right
+    layout: even-vertical
+    splits:
+      - commands:
+        - echo "left"
+      - commands:
+        - echo "right"
+  - name: top-bottom
+    layout: even-horizontal
+    splits:
+      - commands:
+        - echo "top"
+      - commands:
+        - echo "bottom"
+  - name: README
+    commands: # This looks a bit weird, but gives nicer colors
+      - clear && tput bold && tput setaf 6 && roscat catmux readme_tmux.txt
+      - tput sgr0
+  - name: no_split
+    # If just one split is desired, just skip it
     commands:
       - echo "hello"
-  - name: spare
 
 

etc/readme_tmux.txt

@@ -0,0 +1,13 @@
+Hello there,
+
+you just started the catmux example. This launched a tmux shell with a lot of open windows.
+If you know your way around tmux, have fun :)
+If you dont know tmux very well, have a look at this tutorial:
+In this tmux config mouse mode is enabled, so you should be able to scroll with the mouse and select splits and tabs with the mouse. The tabbar is at the bottom, btw.
+For your convenience, we defined a couple of key mappings:
+
+    ALT-<Arrow-keys>         navigate around splits (Called panes in tmux)
+    CTRL-<PageUp/PageDown>   toggle through tabs (Called windows in tmux)
+    CTRL-b, d                detach from current session (this keeps everything running)
+                             (Press CTRL-b, release both and then press d)
+    CTRL-b, SHIFT-k          Kill the complete session

src/catmux/session.py

@@ -24,6 +24,7 @@
 
 import yaml
 from window import Window
+import tmux_wrapper as tmux
 
 
 class Session(object):
@@ -52,7 +53,6 @@ def init_from_yaml(self, yaml_data):
         """Initialize config directly by an already loaded yaml structure."""
 
         self.__yaml_data = yaml_data
-
         self._parse_common()
         self._parse_windows()
 
@@ -62,10 +62,14 @@ def run(self):
             print('No windows to run found')
             return
 
+        first = True
         for window in self._windows:
-            window.debug()
-            window.create()
-            window.run()
+            window.create(first)
+            first = False
+
+        if 'default_window' in self._common:
+            tmux.tmux_call(['select-window', '-t', self._common['default_window']])
+
 
     def _parse_common(self):
         if self.__yaml_data is None:
@@ -82,19 +86,12 @@ def _parse_windows(self):
 
         if 'windows' in self.__yaml_data:
             for window in self.__yaml_data['windows']:
-                commands = list()
-                before_commands = list()
+                kwargs = dict()
                 if 'before_commands' in self._common:
-                    before_commands = self._common['before_commands']
-
-                if 'commands' in window:
-                    commands = window['commands']
-                if 'before_commands' in window:
-                    before_commands = window['before_commands']
-                self._windows.append(
-                    Window(
-                        window['name'],
-                        commands=commands,
-                        before_commands=before_commands))
+                    kwargs['before_commands'] = self._common['before_commands']
+
+                kwargs.update(window)
+
+                self._windows.append(Window(**kwargs))
         else:
             print('No window section found in session config')

src/catmux/split.py

@@ -0,0 +1,48 @@
+# -- BEGIN LICENSE BLOCK ----------------------------------------------
+
+# catmux
+# Copyright (C) 2018  Felix Mauch
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+# -- END LICENSE BLOCK ------------------------------------------------
+
+"""A split in a tmux session"""
+from __future__ import print_function
+
+import tmux_wrapper as tmux
+
+
+class Split(object):
+
+    """A split is a pane where commands can be executed"""
+
+    def __init__(self, **kwargs):
+        """TODO: to be defined1. """
+
+        if kwargs is not None:
+            for key, value in kwargs.iteritems():
+                setattr(self, key, value)
+
+    def debug(self, name='', prefix=''):
+        """Prints all information about this window"""
+        print(prefix + '- Split ' + name + ':')
+        if hasattr(self, 'commands'):
+            print(prefix + '  commands: ')
+            print('\t- ' + '\n\t- '.join(getattr(self, 'commands')))
+
+    def run(self):
+        "Executes all configured commands"""
+        for command in getattr(self, 'commands'):
+            tmux.send_keys(command)

src/catmux/tmux_wrapper.py

@@ -28,6 +28,10 @@ def send_keys(command):
 
     tmux_call(['send-keys', command, 'C-m'])
 
+def split():
+    """Splits the current pane into two"""
+    tmux_call(['split-window'])
+
 def tmux_call(command_list):
     """Executes a tmux command """
     tmux_cmd = ['tmux'] + command_list

src/catmux/window.py

@@ -21,44 +21,62 @@
 """Contains the Window object"""
 from __future__ import print_function
 
+import time
+
 import tmux_wrapper as tmux
+from split import Split
 
 
 class Window(object):
 
     """Class to represent a tmux window structure"""
 
-    def __init__(self, name, **kwargs):
+    def __init__(self, **kwargs):
         """TODO: to be defined1. """
 
-        self._name = name
-        self.before_commands = list()
-        self.commands = list()
+        split_list = kwargs.pop('splits', None)
+        if not split_list and 'commands' in kwargs:
+            split_dict = dict()
+            split_dict['commands'] = kwargs.pop('commands')
+            split_list = [split_dict]
+
+        self.splits = list()
+        for split_data in split_list:
+            self.splits.append(Split(**split_data))
 
         if kwargs is not None:
             for key, value in kwargs.iteritems():
                 setattr(self, key, value)
 
+        self.debug()
+
 
     def debug(self):
         """Prints all information about this window"""
-        print('\n----- {} -----'.format(self._name))
+        print('\n----- {} -----'.format(getattr(self, 'name')))
         if hasattr(self, 'before_commands'):
             print('before_commands: ')
-            print('\n\t- '.join(getattr(self, 'before_commands')))
-        if hasattr(self, 'before_commands'):
-            print('commands: ')
-            print('\n\t- '.join(getattr(self, 'commands')))
+            print('\t- ' + '\n\t- '.join(getattr(self, 'before_commands')))
+        print('Splits:')
+        for counter, split in enumerate(self.splits):
+            split.debug(name=str(counter), prefix=' ')
 
-    def create(self):
+    def create(self, first=False):
         """Creates the window"""
-        tmux.tmux_call(['new-window'])
-        tmux.tmux_call(['rename-window', self._name])
-        for command in getattr(self, 'before_commands'):
-            tmux.send_keys(command)
+        if not first:
+            tmux.tmux_call(['new-window'])
+        tmux.tmux_call(['rename-window', getattr(self, 'name')])
+        for counter, split in enumerate(self.splits):
+            if counter > 0:
+                tmux.split()
+
+            if hasattr(self, 'before_commands'):
+                for cmd in getattr(self, 'before_commands'):
+                    tmux.send_keys(cmd)
+            split.run()
 
-    def run(self):
-        "Executes all configured commands"""
-        for cmd in getattr(self, 'commands'):
-            tmux.send_keys(cmd)
+        if hasattr(self, 'layout'):
+            tmux.tmux_call(['select-layout', getattr(self, 'layout')])
 
+        if hasattr(self, 'delay'):
+            time.sleep(getattr(self, 'delay'))