Merge branch 'develop'

File "piped.py", line 7
    from __future__ import with_statement
SyntaxError: from __future__ imports must occur at the beginning of the file

.gitignore

@@ -1,2 +1,4 @@
 .idea
-MANIFEST
+MANIFEST
+*.pyc
+.tox

AUTHORS

@@ -12,4 +12,5 @@ Patches and Suggestions
 
 - Jeff Forcier
 - Morgan Goose
-- Travis Swicegood
+- Travis Swicegood
+- Will Thames

HISTORY.rst

@@ -1,6 +1,30 @@
 History
 -------
 
+0.2.3
++++++
+
+* Only init colors if they are used (iPython compatability)
+* New progress module
+* Various bugfixes
+
+
+0.2.2
++++++
+
+* Auto Color Disabling
+* Progress Namespace Change
+* New Progress Bars
+* textui.puts newline fix
+
+
+0.2.1 (2011-03-24)
+++++++++++++++++++
+
+* Python 2.5 Support
+* List of available colors
+
+
 0.2.0 (2011-03-23)
 ++++++++++++++++++
 

README.rst

@@ -12,16 +12,43 @@ commandline applications.
 **T** ools
 . 
 
-Features:
----------
 
+Clint is awesome. Crazy awesome. It supports colors, but detects if the session is a TTY, so doesn't render the colors if you're piping stuff around. Automagically.
+
+Awesome nest-able indentation context manager. Example: (``with indent(4): puts('indented text')``). It supports custom email-style quotes. Of course, it supports color too, if and when needed.
+
+It has an awesome Column printer with optional auto-expanding columns. It detects how wide your current console is and adjusts accordingly. It wraps your words properly to fit the column size. With or without colors mixed in. All with a single function call.
+
+The world's easiest to use implicit argument system w/ chaining methods for filtering. Seriously. 
+
+
+Run the various executables in examples_ to get a good feel for what Clint offers.
+
+.. _examples: https://github.com/kennethreitz/clint/tree/develop/examples
+
+You'll never want to not use it.
+
+
+
+Current Features:
+-----------------
+- Little Documentation (bear with me for now)
 - CLI Colors and Indents
+- Extremely Simple + Powerful Column Printer
 - Iterator-based Progress Bar
 - Implicit Argument Handling
-- Simple Support for Unix Pipes
+- Simple Support for Incoming Unix Pipes
 - Application Directory management
 
 
+Future Features:
+----------------
+- Documentation!
+- Simple choice system ``Are you sure? [Yn]``
+- Default query system ``Installation Path [/usr/local/bin/]``
+- Suggestions welcome.
+
+
 Example
 -------
 

clint/__init__.py

@@ -19,8 +19,8 @@ from .pipes import piped_in
 
 
 __title__ = 'clint'
-__version__ = '0.2.0'
-__build__ = 0x000200
+__version__ = '0.2.3'
+__build__ = 0x000203
 __author__ = 'Kenneth Reitz'
 __license__ = 'ISC'
 __copyright__ = 'Copyright 2011 Kenneth Reitz'

clint/pipes.py

@@ -9,6 +9,7 @@ This module contains the helper functions for dealing with unix pipes.
 """
 
 from __future__ import absolute_import
+from __future__ import with_statement
 
 import sys
 

clint/resources.py

@@ -10,6 +10,7 @@ This module contains all the application resource features of clint.
 
 
 from __future__ import absolute_import
+from __future__ import with_statement
 
 import errno
 from os import remove, removedirs
@@ -38,7 +39,7 @@ class AppDir(object):
 
     def __repr__(self):
         return '<app-dir: %s>' % (self.path)
-    
+
 
     def __getattribute__(self, name):
 
@@ -52,11 +53,11 @@ class AppDir(object):
         """Raises if operations are carried out on an unconfigured AppDir."""
         if not self.path:
             raise NotConfigured()
-        
+
 
     def _create(self):
         """Creates current AppDir at AppDir.path."""
-        
+
         self._raise_if_none()
         if not self._exists:
             mkdir_p(self.path)
@@ -65,7 +66,7 @@ class AppDir(object):
 
     def open(self, filename, mode='r'):
         """Returns file object from given filename."""
-        
+
         self._raise_if_none()
         fn = path_join(self.path, filename)
 
@@ -120,11 +121,11 @@ class AppDir(object):
             else:
                 raise why
 
-        
+
     def read(self, filename, binary=False):
         """Returns contents of given file with AppDir.
         If file doesn't exist, returns None."""
-        
+
         self._raise_if_none()
         fn = path_join(self.path, filename)
 
@@ -160,11 +161,11 @@ log = AppDir()
 def init(vendor, name):
 
     global user, site, cache, log
-    
+
     ad = AppDirs(name, vendor)
 
     user.path = ad.user_data_dir
-    
+
     site.path = ad.site_data_dir
     cache.path = ad.user_cache_dir
     log.path = ad.user_log_dir

clint/textui/__init__.py

@@ -8,8 +8,8 @@ This module provides the text output helper system.
 
 """
 
-from __future__ import absolute_import
-
 
 from . import colored
-from .core import *
+from . import progress
+
+from core import *

clint/textui/colored.py

@@ -16,18 +16,18 @@ import sys
 
 from ..packages import colorama
 
-DISABLE_COLOR = False
-
-if sys.stdout.isatty():
-    colorama.init(autoreset=True)
-
-
 __all__ = (
     'red', 'green', 'yellow', 'blue',
     'black', 'magenta', 'cyan', 'white',
     'clean', 'disable'
 )
 
+COLORS = __all__[:-2]
+DISABLE_COLOR = False
+
+if not sys.stdout.isatty():
+    DISABLE_COLOR = True
+
 
 class ColoredString(object):
     """Enhanced string for __len__ operations on Colored output."""
@@ -39,6 +39,7 @@ class ColoredString(object):
     @property
     def color_str(self):
         if sys.stdout.isatty() and not DISABLE_COLOR:
+            colorama.init(autoreset=True)
             return '%s%s%s' % (
                 getattr(colorama.Fore, self.color), self.s, colorama.Fore.RESET)
         else:
@@ -47,25 +48,25 @@ class ColoredString(object):
 
     def __len__(self):
         return len(self.s)
-        
+
     def __repr__(self):
         return "<%s-string: '%s'>" % (self.color, self.s)
-        
+
     def __str__(self):
         return self.__unicode__().encode('utf8')
-        
+
     def __unicode__(self):
         return self.color_str
-        
+
     def __add__(self, other):
         return str(self.color_str) + str(other)
-        
+
     def __radd__(self, other):
         return str(other) + str(self.color_str)
-        
+
     def __mul__(self, other):
         return (self.color_str * other)
-        
+
     def split(self, x=' '):
         return map(self._new, self.s.split(x))
 

clint/textui/core.py

@@ -13,13 +13,12 @@ from __future__ import absolute_import
 
 import sys
 
-from .progress import progressbar
 from .formatters import max_width, min_width
 from .cols import columns
 from ..utils import tsplit
 
 
-__all__ = ('puts', 'puts_err', 'indent', 'progressbar', 'columns', 'max_width', 'min_width')
+__all__ = ('puts', 'puts_err', 'indent', 'columns', 'max_width', 'min_width')
 
 
 STDOUT = sys.stdout.write
@@ -63,14 +62,14 @@ class Writer(object):
 
 
     def __call__(self, s, newline=True, stream=STDOUT):
-        
+
         if newline:
             s = tsplit(s, NEWLINES)
             s = map(str, s)
             indent = ''.join(self.shared['indent_strings'])
-            
+
             s = (str('\n' + indent)).join(s)
-        
+
         _str = ''.join((
             ''.join(self.shared['indent_strings']),
             str(s),
@@ -79,14 +78,14 @@ class Writer(object):
         stream(_str)
 
 
-def puts(s, newline=True):
+def puts(s='', newline=True, stream=STDOUT):
     """Prints given string to stdout via Writer interface."""
-    Writer()(s, stream=STDOUT)
+    Writer()(s, newline, stream=stream)
 
 
-def puts_err(s, newline=True):
+def puts_err(s='', newline=True, stream=STDERR):
     """Prints given string to stderr via Writer interface."""
-    Writer()(s, stream=STDERR)
+    Writer()(s, newline, stream=stream)
 
 
 def indent(indent=4, quote=''):

clint/textui/progress.py

@@ -12,21 +12,57 @@ from __future__ import absolute_import
 
 import sys
 
+STREAM = sys.stderr
 
-def progressbar(it, prefix='', size=32, hide=False):
+BAR_TEMPLATE = '%s[%s%s] %i/%i\r'
+BAR_EMPTY_CHAR = '-'
+BAR_FILLED_CHAR = '='
+
+DOTS_CHAR = '.'
+
+
+def bar(it, label='', width=32, hide=False):
     """Progress iterator. Wrap your iterables with it."""
-    count = len(it)
-    if count:
-        def _show(_i):
-            x = int(size*_i/count)
-            if not hide:
-                sys.stdout.write("%s[%s>%s] %i/%i\r" % (prefix, "="*x, "-"*(size-x), _i, count))
-                sys.stdout.flush()
 
+    def _show(_i):
+        x = int(width*_i/count)
+        if not hide:
+            STREAM.write(BAR_TEMPLATE % (
+                label, BAR_FILLED_CHAR*x, BAR_EMPTY_CHAR*(width-x), _i, count))
+            STREAM.flush()
+
+    count = len(it)
+
+    if count:
         _show(0)
+
     for i, item in enumerate(it):
+
         yield item
         _show(i+1)
+
     if not hide:
-        sys.stdout.write("\n")
-        sys.stdout.flush()
+        STREAM.write('\n')
+        STREAM.flush()
+
+
+def dots(it, label='', hide=False):
+    """Progress iterator. Prints a dot for each item being iterated"""
+
+    count = 0
+
+    if not hide:
+        STREAM.write(label)
+
+    for item in it:
+        if not hide:
+            STREAM.write(DOTS_CHAR)
+            sys.stderr.flush()
+
+        count += 1
+
+        yield item
+
+    STREAM.write('\n')
+    STREAM.flush()
+

clint/utils.py

@@ -9,6 +9,7 @@ Various Python helpers used within clint.
 """
 
 from __future__ import absolute_import
+from __future__ import with_statement
 
 import sys
 import errno
@@ -28,7 +29,7 @@ def mkdir_p(path):
     """Emulates `mkdir -p` behavior."""
     try:
         makedirs(path)
-    except OSError as exc: # Python >2.5
+    except OSError, exc: # Python >2.5
         if exc.errno == errno.EEXIST:
             pass
         else:

examples/colors_all.py

@@ -12,5 +12,5 @@ text = 'THIS TEXT IS COLORED %s!'
 
 if __name__ == '__main__':
 
-	for color in colored.__all__:
+	for color in colored.COLORS:
 		print getattr(colored, color)(text % color.upper())

examples/colors_indent.py

@@ -1,6 +1,9 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 
+from __future__ import with_statement
+
+
 import sys
 import os
 

examples/indents.py

@@ -1,6 +1,8 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 
+from __future__ import with_statement
+
 import sys
 import os
 

examples/newline_indent.py

@@ -1,6 +1,8 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 
+from __future__ import with_statement
+
 import sys
 import os
 

examples/piped.py

@@ -1,6 +1,8 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 
+from __future__ import with_statement
+
 import sys
 import os
 
@@ -21,4 +23,4 @@ if __name__ == '__main__':
             with indent(5, quote=colored.red(' |')):
                 puts(in_data)
         else:
-            puts(colored.red('Warning: ') + 'No data was piped in.')
+            puts(colored.red('Warning: ') + 'No data was piped in.')

examples/progressbar.py

@@ -8,12 +8,13 @@ sys.path.insert(0, os.path.abspath('..'))
 
 from time import sleep
 from random import random
-from clint.textui import progressbar
+from clint.textui import progress
 
 
 if __name__ == '__main__':
-    for i in progressbar(range(100)):
+    for i in progress.bar(range(100)):
         sleep(random() * 0.2)
 
-    
+    for i in progress.dots(range(100)):
+        sleep(random() * 0.2)
     

setup.py

@@ -6,6 +6,9 @@ import sys
 
 from distutils.core import setup
 
+import clint
+
+
 
 def publish():
     """Publish to PyPi"""
@@ -19,7 +22,7 @@ required = []
 
 setup(
     name='clint',
-    version='0.2.0',
+    version=clint.__version__,
     description='Python Command-line Application Tools',
     long_description=open('README.rst').read() + '\n\n' +
                      open('HISTORY.rst').read(),
@@ -29,7 +32,6 @@ setup(
     packages= [
         'clint',
         'clint.textui',
-
         'clint.packages', 'clint.packages.colorama'
     ],
     install_requires=required,
@@ -40,7 +42,7 @@ setup(
         'Natural Language :: English',
         'License :: OSI Approved :: ISC License (ISCL)',
         'Programming Language :: Python',
-        # 'Programming Language :: Python :: 2.5',
+        'Programming Language :: Python :: 2.5',
         'Programming Language :: Python :: 2.6',
         'Programming Language :: Python :: 2.7',
         # 'Programming Language :: Python :: 3.0',

tox.ini

@@ -0,0 +1,12 @@
+[tox]
+envlist = py25,py26,py27,py3
+
+[testenv]
+commands=py.test --junitxml=junit-{envname}.xml
+deps = pytest
+
+[testenv:pypy]
+basepython=/usr/bin/pypy-c
+
+[testenv:py3]
+basepython=/usr/bin/python3