summaryrefslogtreecommitdiff
path: root/README.txt
diff options
context:
space:
mode:
authorsteven.bethard <devnull@localhost>2009-03-27 16:05:43 +0000
committersteven.bethard <devnull@localhost>2009-03-27 16:05:43 +0000
commit764481166472476a826d3791c1fd4e13a927a526 (patch)
tree231bb2315ec8b4aa90c47c1bb01d6f3c86281976 /README.txt
parentd7a0b852621b4672983d12e6b4ad8425a0bc8cbe (diff)
downloadargparse-764481166472476a826d3791c1fd4e13a927a526.tar.gz
Initial import from python-hosting.com repository.
Diffstat (limited to 'README.txt')
-rw-r--r--README.txt39
1 files changed, 39 insertions, 0 deletions
diff --git a/README.txt b/README.txt
new file mode 100644
index 0000000..4bfd5c5
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,39 @@
+argparse 0.9.0
+==============
+
+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/