CommandTool

HomePage: http://jimmyg.org/work/code/commandtool/index.html

Author: James Gardner

Download: https://pypi.python.org/packages/source/C/CommandTool/CommandTool-0.5.3.tar.gz

        CommandTool
+++++++++++


.. contents ::

Summary
=======

Tools for creating command line interfaces involving sub-commands.

Get Started
===========

* Download and install from source

Author
======

James Gardner


Changes
=======

0.5.3
-----

2011-07-11
~~~~~~~~~~

* Support for ``cmd.out`` and ``cmd.err`` functions on the ``cmd`` object

0.5.2
-----

2011-04-24
~~~~~~~~~~

* Added support for extra information in command-specific help, not shown 
  on the command index page
* Added a ``bag`` argument and default alias look up on ``self`` so that  
  commands behave a bit like Marbles
* Added ``instance``, ``raw_args`` and ``raw_opts`` to the ``cmd`` object
  passed to ``run()`` and deprecated the use of ``on_initial_convert()``
* Moved the ``bag`` argument out of ``run()`` and instead it gets passed
  as a service by PipeStack if needed. Can be accessed as ``cmd.service``
  in your ``run()`` function.
* Changed the command structure to be that of a list of tuples, rather than a
  dictionary; nesting now happens by placing a list of tuples as a value

0.5.1
-----

2011-04-04
~~~~~~~~~~

* Added ``requires.txt``
* Added a new ``run()`` method allowing you to use a ``cmd`` object for
  chaining sub commands

0.5.0
-----

* Basic support for nested commands, further refactoring of the new use cases
  may be forthcoming

0.4.1
-----

2010-09-16
~~~~~~~~~~

* Added support for aliases to commands

2010-09-05
~~~~~~~~~~

* Changed terminology from sub-command to command (internally variables
  are still called ``sub_command`` though)
* Added a ``help_option``
* Fixed bad default help desciptions

0.4.0
-----

2010-03-02
~~~~~~~~~~

* Complete restructure, now uses a ``Cmd`` class
* Removed man page and reStructuredText support

0.3.2
-----

2009-12-24
~~~~~~~~~~

* BuildKit compatibility: restructured docs, added doctests.

0.3.1
-----

2009-11-08
~~~~~~~~~~

* Added direct support for a flows setup

2009-10-25
~~~~~~~~~~

* Made docutils optional

0.3.0
-----

2009-07-30
~~~~~~~~~~

* Updated the documentation to be accurate
* Moved the create_man example into the core as commandtool.help
* Removed old comments
* Updated the find example

0.2.1
-----

2009-06-30
~~~~~~~~~~

* Updated the find and create_man programs
* Created the documentation
* Removed metavar handlers

0.2.0
-----

2009-04-28
~~~~~~~~~~

* Added a create_man.py script which extracts docstrings in written in a subset
  of full reStructuredText into both HTML, man and help text formats.

0.1.0
-----
* First version


License
=======
Copyright (C) 2009 James Gardner - http://jimmyg.org/

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.


Download
========