Color

CHANGELOG.rst

@@ -1,5 +1,10 @@
-1.5.1
------
+In development
+--------------
+* Color: Added colors module, support for colors added to cli
+
+
+1.5.1 (In development)
+----------------------
 * Machines: Added ``.get()`` method for checking several commands. (`#205 <https://github.com/tomerfiliba/plumbum/pull/205>`_)
 * Machines: ``local.cwd`` now is the current directory even if you change the directory with non-Plumbum methods. (`#207 <https://github.com/tomerfiliba/plumbum/pull/207>`_) 
 

README.rst

@@ -103,7 +103,7 @@ Command nesting
     >>> print sudo[ifconfig["-a"]]
     /usr/bin/sudo /sbin/ifconfig -a
     >>> (sudo[ifconfig["-a"]] | grep["-i", "loop"]) & FG
-    lo        Link encap:Local Loopback  
+    lo        Link encap:Local Loopback
               UP LOOPBACK RUNNING  MTU:16436  Metric:1
 
 Remote commands (over SSH)
@@ -120,7 +120,7 @@ and `Paramiko <https://github.com/paramiko/paramiko/>`_ (a pure-Python implement
     >>> r_ls = remote["ls"]
     >>> with remote.cwd("/lib"):
     ...     (r_ls | grep["0.so.0"])()
-    ... 
+    ...
     u'libusb-1.0.so.0\nlibusb-1.0.so.0.0.0\n'
 
 CLI applications
@@ -130,22 +130,21 @@ CLI applications
 
     import logging
     from plumbum import cli
-    
+
     class MyCompiler(cli.Application):
         verbose = cli.Flag(["-v", "--verbose"], help = "Enable verbose mode")
         include_dirs = cli.SwitchAttr("-I", list = True, help = "Specify include directories")
-        
+
         @cli.switch("--loglevel", int)
         def set_log_level(self, level):
             """Sets the log-level of the logger"""
             logging.root.setLevel(level)
-        
+
         def main(self, *srcfiles):
             print "Verbose:", self.verbose
-            print "Include dirs:", self.include_dirs 
+            print "Include dirs:", self.include_dirs
             print "Compiling:", srcfiles
-
-
+
     if __name__ == "__main__":
         MyCompiler.run()
 
@@ -159,6 +158,19 @@ Sample output
     Include dirs: ['foo/bar', 'spam/eggs']
     Compiling: ('x.cpp', 'y.cpp', 'z.cpp')
 
+Color controls
+--------------
+
+.. code-block:: python
+
+    from plumbum import colors
+    with colors.red:
+        print("This library provides safe, flexible color access.")
+        print("Color", "(and styles in general)" << colors.bold, "are easy!")
+    print("The simple 16 colors or", '256 named colors,' << colors.orchid + colors.underline,
+          "or full hex colors" << colors["#129240"], 'can be used.')
+    print("Unsafe " + colors.bg.dark_khaki + "color access" - colors.bg + " is available too.")
+
 
 
 .. image:: https://d2weczhvl823v0.cloudfront.net/tomerfiliba/plumbum/trend.png

docs/_cheatsheet.rst

@@ -151,3 +151,31 @@ Sample output
     Compiling: ('x.cpp', 'y.cpp', 'z.cpp')
 
 See :ref:`guide-cli`.
+
+Color controls
+--------------
+
+.. code-block:: python
+
+    from plumbum import colors
+    with colors.red:
+        print("This library provides safe, flexible color access.")
+        print("Color", "(and styles in general)" << colors.bold, "are easy!")
+    print("The simple 16 colors or", '256 named colors,' << colors.orchid + color.underline,
+          "or full hex colors" << colors["#129240"], 'can be used.')
+    print("Unsafe " + colors.bg.dark_khaki + "color access" - colors.bg + " is available too.")
+
+Sample output
++++++++++++++
+
+.. raw:: html
+
+    <div class="highlight">
+    <code>
+    <pre><font color="#800000">This library provides safe color access.
+    Color <b>(and styles in general)</b> are easy!
+    </font>The simple 16 colors, <font color="#D75FD7"><span style="text-decoration: underline;">256 named colors,</span></font> <font color="#129240">or full hex colors</font> can be used.
+    Unsafe <span style="background-color: #AFAF5F">color access</span> is available too.</pre>
+    </code>
+    </div>
+

docs/api/cli.rst

@@ -8,3 +8,4 @@ Package plumbum.cli
 
 .. automodule:: plumbum.cli.terminal
    :members:
+

docs/api/colors.rst

@@ -0,0 +1,34 @@
+Package plumbum.colors
+======================
+
+.. automodule:: plumbum.colors
+   :members:
+   :special-members:
+
+plumbum.colorlib
+----------------
+
+.. automodule:: plumbum.colorlib
+   :members:
+   :special-members:
+
+plumbum.colorlib.styles
+-----------------------
+
+.. automodule:: plumbum.colorlib.styles
+   :members:
+   :special-members:
+
+plumbum.colorlib.factories
+--------------------------
+
+.. automodule:: plumbum.colorlib.factories
+   :members:
+   :special-members:
+
+plumbum.colorlib.names
+----------------------
+
+.. automodule:: plumbum.colorlib.names
+   :members:
+   :special-members:

docs/cli.rst

@@ -73,6 +73,21 @@ class-level attributes, such as ``PROGNAME``, ``VERSION`` and ``DESCRIPTION``. F
     class MyApp(cli.Application):
         PROGNAME = "Foobar"
         VERSION = "7.3"
+
+Colors are supported through the class level attributes
+``COLOR_PROGNAME``,
+``COLOR_DISCRIPTION``,
+``COLOR_VERSION``,
+``COLOR_HEADING``,
+``COLOR_USAGE``,
+``COLOR_SUBCOMMANDS``,
+``COLOR_GROUPS[]``, and
+``COLOR_GROUPS_BODY[]``,
+which should contain Style objects. The dictionaries support custom colors
+for named groups. The default is ``colors.do_nothing``, but if you just want more
+colorful defaults, subclass ``cli.ColorfulApplication``.
+
+.. versionadded:: 1.5
 
 Switch Functions
 ----------------
@@ -444,6 +459,7 @@ Here's an example of running this application::
     committing...
 
 
+
 See Also
 --------
 * `filecopy.py <https://github.com/tomerfiliba/plumbum/blob/master/examples/filecopy.py>`_ example