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 Incoming Unix Pipes

• Application Directory management

Future Features:

• Documentation!

• Simple choice systemAre you sure? [Yn]

• Suggestions welcome.

Example

I want to indent my console text.

>>> from clint.textui import puts, indent>>> puts('not indented text')>>> with indent(4):>>>     puts('indented text')not indented text    indented text

I want to quote my console text (like email).

>>> puts('not indented text')>>> with indent(4, quote=' >'):>>>     puts('quoted text')>>>     puts('pretty cool, eh?')not indented text >  quoted text >  pretty cool, eh?

I want to color my console text.

>>> from clint.textui import colored, puts>>> puts(colored.red('red text'))red text# It's red in Windows, OSX, and Linux alike.

I want to get data piped to stdin.

>>> clint.piped_in()# if no data was piped in, piped_in returns None

I want to get the first commandline argument passed in.

>>> from clint import arguments>>> args = arguments.Args()>>> args.get(0)# if no argument was passed, get returns None

I want to store a configuration file.

>>> from clint import resources>>> resources.init('Company', 'AppName')>>> resources.user.write('config.ini', file_contents)# OSX: '/Users/appuser/Library/Application Support/AppName/config.ini'# Windows: 'C:\\Users\\appuser\\AppData\\Local\\Company\\AppName\\config.ini'# Linux: '/home/appuser/.config/appname/config.ini'

I want to force color output even if stdout is not a TTY:

$ export CLINT_FORCE_COLOR=1

I want to ask for input.

>>> from clint.textui import prompt, validators>>> path = prompt.query('Installation Path', default='/usr/local/bin/', validators=[validators.PathValidator()])

Installation

To install clint, simply:

$ pip install clint

Or, if you absolutely must:

$ easy_install clint

But, you really shouldn’t do that.

License:

ISC License.

Copyright (c) 2011, Kenneth Reitz <me@kennethreitz.com>Permission to use, copy, modify, and/or distribute this software for anypurpose with or without fee is hereby granted, provided that the abovecopyright notice and this permission notice appear in all copies.THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIESWITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OFMERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FORANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGESWHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN ANACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OFOR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

Contribute

If you’d like to contribute, simply forkthe repository, commit your changesto themaster branch (or branch off of it), and send a pull request. Makesure you add yourself toAUTHORS.

Roadmap

• Unittests

• Sphinx Documentation

History