summaryrefslogtreecommitdiff
path: root/README.txt
diff options
context:
space:
mode:
authorsteven.bethard <devnull@localhost>2009-07-26 17:21:37 +0000
committersteven.bethard <devnull@localhost>2009-07-26 17:21:37 +0000
commit891869dfe9cf298950ea1490d846986070b40e2a (patch)
tree983c78b179dd0d9a88509b759c0658832ec3b366 /README.txt
parentb11915a9934a79fc435e502edfd8bcdffec1db1c (diff)
downloadargparse-891869dfe9cf298950ea1490d846986070b40e2a.tar.gz
Tweak readme text.
Diffstat (limited to 'README.txt')
-rw-r--r--README.txt38
1 files changed, 15 insertions, 23 deletions
diff --git a/README.txt b/README.txt
index f651f30..f4235a3 100644
--- a/README.txt
+++ b/README.txt
@@ -1,38 +1,30 @@
argparse 1.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
+The argparse module provides an easy, declarative interface for
+creating command line tools, which knows how to:
+ * parse the arguments and flags from sys.argv
+ * convert arg strings into objects for your program
+ * format and print informative help messages
+ * and much more...
+
+The argparse module improves on the standard library optparse 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.3 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: