Refactored utils functions

Author: iiSeymour

bashplotlib/utils/commandhelp.py

@@ -1,24 +1,28 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+"""
+Usage messages for bashplotlib system commands
+"""
 
 hist = {
     "usage": """hist is a command for making histograms. it accepts a series of values in one of the following formats:
         1) txt file w/ 1 column of numbers
-        2) standard in piped from another command line cat or curl    
-    
+        2) standard in piped from another command line cat or curl
+
     for some examples of how to use hist, you can type the command:
         hist --demo
     or visit https://github.com/glamp/bashplotlib/blob/master/examples/sample.sh
     """
 }
 
 scatter = {
-    "usage": """scatterplot is a command for making xy plots. it accepts a series of x values and a series of y values in the 
+    "usage": """scatterplot is a command for making xy plots. it accepts a series of x values and a series of y values in the
     following formats:
         1) a txt file or standard in value w/ 2 comma seperated columns of x,y values
         2) 2 txt files. 1 w/ designated x values and another with designated y values.
-    
+
     scatter -x <xcoords> -y <ycoords>
     cat <file_with_x_and_y_coords> | scatter
-
     """
 }
-

bashplotlib/utils/helpers.py

@@ -1,37 +1,52 @@
+#!/usr/bin/evn python
+# -*- coding: utf-8 -*-
 
+"""
+Various helpful function for bashplotlib
+"""
+
+import sys
 
 bcolours = {
-    "white": '\033[97m',
-    "aqua": '\033[96m',
-    "pink": '\033[95m',
-    "blue": '\033[94m',
+    "white":  '\033[97m',
+    "aqua":   '\033[96m',
+    "pink":   '\033[95m',
+    "blue":   '\033[94m',
     "yellow": '\033[93m',
-    "green": '\033[92m',
-    "red": '\033[91m',
-    "grey": '\033[90m',
-    "ENDC": '\033[0m'
+    "green":  '\033[92m',
+    "red":    '\033[91m',
+    "grey":   '\033[90m',
+    "black":  '\033[30m',
+    "ENDC":   '\033[39m',
 }
 
+
 def get_colour(colour):
-    return bcolours.get(colour, bcolours['white'])
+    """
+    Get the escape code sequence for a colour
+    """
+    return bcolours.get(colour, bcolours['ENDC'])
 
-def printcolor(txt, sameline=False, color=get_colour("white")):
+
+def printcolour(text, sameline=False, colour=get_colour("ENDC")):
+    """
+    Print color text using escape codes
+    """
     if sameline:
-        if color=='\033[97m':
-            print txt,
-        else:
-            print color + txt + bcolours["ENDC"],
+        sep = ''
     else:
-        if color=='\033[97m':
-            print txt
-        else:
-            print color + txt + bcolours["ENDC"]
+        sep = '\n'
+    sys.stdout.write(get_colour(colour) + text + bcolours["ENDC"] + sep)
+
 
 def drange(start, stop, step=1.0, include_stop=False):
-    "generate between 2 numbers w/ optional step, optionally include upper bound"
-    if step==0:
+    """
+    Generate between 2 numbers w/ optional step, optionally include upper bound
+    """
+    if step == 0:
         step = 0.01
     r = start
+
     if include_stop:
         while r <= stop:
             yield r
@@ -43,9 +58,12 @@ def drange(start, stop, step=1.0, include_stop=False):
             r += step
             r = round(r, 10)
 
+
 def box_text(text, width, offset=0):
-    box = " "*offset + "-"*(width+2) + "\n"
-    box += " "*offset + "|"+ text.center(width) + "|" + "\n"
-    box += " "*offset + "-"*(width+2)
+    """
+    Return text inside an ascii textbox
+    """
+    box = " " * offset + "-" * (width+2) + "\n"
+    box += " " * offset + "|" + text.center(width) + "|" + "\n"
+    box += " " * offset + "-" * (width+2)
     return box
-