docs/index.rst
author Alexander Solovyov <piranha@piranha.org.ua>
Mon, 13 Jul 2009 18:23:42 +0300
changeset 33 e82b3f5c36d9
child 35 dc7f13ea0f09
permissions -rw-r--r--
documentation

=============
 Finaloption
=============

::

  If that's the Final Option,
  I'm gonna choose it.
                   Die Krupps 

.. toctree::
   :maxdepth: 2

   overview
   api

Finaloption is a command line parser, indented to make writing command line
applications easy and painless. It uses built-in Python types (lists,
dictionaries, etc) to define options, which makes configuration clear and
concise. Additionally it contains possibility to handle subcommands (i.e.
``hg commit`` or ``svn update``).

JFYI: name is derived from Die Krupps' song Final Option, featured in epigraph.

Features
--------

 - parsing arguments from sys.argv or custom strings
 - converting from string to appropriate Python objects
 - generating help message
 - positional and named arguments
 - subcommands support
 - short, clean and concise definitions
 - ability to shorten names of subcommand and long options