summaryrefslogtreecommitdiff
path: root/README.txt
blob: 30837016e95bb7f014a2d0542ddfff74bcbe5933 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
argparse 0.9.1
==============

The argparse module makes writing command line tools in Python easy.
Just briefly describe your command line interface and argparse will
take care of the rest, including:

* parsing the arguments and flags from ``sys.argv``
* converting arg strings into objects for your program
* formatting and printing any help messages
* and much more ... 

For those familiar with the optparse module from the Python standard
library, argparse improves on this module in a number of ways,
including:

    * handling positional arguments
    * supporting sub-commands
    * allowing alternative option prefixes like ``+`` and ``/``
    * handling zero-or-more and one-or-more style arguments
    * producing more informative usage messages
    * providing a much simpler interface for custom types and actions

REQUIREMENTS & INSTALLATION
---------------------------
        
The argparse module requires Python 2.4 or greater, and can be
installed with the standard Python installation procedure:

  python setup.py install


AVAILABILITY & DOCUMENTATION
----------------------------

The latest version of argparse, along with API documentation and
examples can be found at:

  http://code.google.com/p/argparse/