python/lib/argparse/README.txt

   1 The argparse module makes it easy to write user friendly command line
   2 interfaces.
   3
   4 The program defines what arguments it requires, and argparse will figure out
   5 how to parse those out of sys.argv. The argparse module also automatically
   6 generates help and usage messages and issues errors when users give the
   7 program invalid arguments.
   8
   9 As of Python >= 2.7 and >= 3.2, the argparse module is maintained within the
  10 Python standard library. For users who still need to support Python < 2.7 or
  11 < 3.2, it is also provided as a separate package, which tries to stay
  12 compatible with the module in the standard library, but also supports older
  13 Python versions.
  14
  15 argparse is licensed under the Python license, for details see LICENSE.txt.
  16
  17
  18 Compatibility
  19 -------------
  20
  21 argparse should work on Python >= 2.3, it was tested on:
  22
  23 * 2.3.5, 2.4.4, 2.5.5, 2.6.5 and 2.7
  24 * 3.1, 3.2
  25
  26
  27 Installation
  28 ------------
  29
  30 Try one of these:
  31
  32     python setup.py install
  33
  34     easy_install argparse
  35
  36     pip install argparse
  37
  38     putting argparse.py in some directory listed in sys.path should also work
  39
  40
  41 Bugs
  42 ----
  43
  44 If you find a bug, please try to reproduce it with python 2.7.
  45
  46 If it happens there also, please file a bug in the python.org issue tracker.
  47 If it does not happen in 2.7, file a bug in the argparse package issue tracker.
  48