Merge lp:~clint-fewbar/charm-tools/add-proper-help into lp:~charmers/charm-tools/trunk

[Clint Byrum]

Adding proper --help and the new 'help' command to make accessing them easier. A little cleanup in the output of --help as well.

[Juan L. Negron (negronjl)]

Looks good to me ... can you now do the same for juju itself :)

Approved.

-Juan

review: Approve

=== modified file 'charm'
--- charm	2011-09-23 18:23:55 +0000
+++ charm	2012-05-23 20:56:24 +0000
@@ -9,26 +9,25 @@
 
 usage()
 {
-  echo usage: $1 [ script_name ] >&2
+  echo "usage: $1 [ --help|-h ] [ script_name ]" >&2
   echo script choices are: >&2
-  exec ls $script_home >&2
+  exec ls -1 $script_home|sed -e 's/^/    /' >&2
   exit $2
 }
 
-options=$(getopt -o h -l help -- "$@")
-if [ $? -ne 0 ]; then
-    usage $(basename $0) 1
+# If the options seem invalid, pass thru to underlying scripts
+if options=$(getopt -o h -l help -- "$@") ; then
+    eval set -- "$options"
+
+    while true
+    do
+        case "$1" in
+        -h|--help)  usage $(basename $0) 0;;
+        --) shift 1; break;;
+        *)  break;;
+        esac
+    done
 fi
-eval set -- "$options"
-
-while true
-do
-    case "$1" in
-    -h|--help)  usage $(basename $0) 0;;
-    --) shift 1; break;;
-    *)  break;;
-    esac
-done
 
 script=${1:-""}
 

=== modified file 'scripts/create'
--- scripts/create	2012-05-14 22:42:35 +0000
+++ scripts/create	2012-05-23 20:56:24 +0000
@@ -27,6 +27,7 @@
 import textwrap
 import socket
 import pwd
+import argparse
 from Cheetah.Template import Template
 from stat import ST_MODE
 
@@ -49,21 +50,21 @@
 except ImportError:
     get_maintainer = portable_get_maintainer
 
-try:
-    package=sys.argv[1]
-except:
-    print "Usage: create package_name [ charm_home_dir ]"
-    sys.exit(1)
+parser = argparse.ArgumentParser()
+parser.add_argument('charmname', help='Name of charm to create.')
+parser.add_argument('charmhome', nargs='?', 
+        help='Dir to create charm in. Defaults to CHARM_HOME env var or PWD')
+args = parser.parse_args()
 
-try:
-    charm_home = sys.argv[2]
-except:
+if args.charmhome:
+    charm_home = args.charmhome
+else:
     charm_home = os.getenv('CHARM_HOME','.')
 
 home = path.abspath(path.join(path.dirname(sys.argv[0]), '..'))
 template_dir = path.join(home, 'templates')
-output_dir = path.join(charm_home, package)
-print "Generating template for " + package + " from templates in " + template_dir
+output_dir = path.join(charm_home, args.charmname)
+print "Generating template for " + args.charmname + " from templates in " + template_dir
 print "Charm will be stored in " + output_dir
 
 if path.exists(output_dir):
@@ -72,18 +73,18 @@
 
 shutil.copytree(path.join(template_dir,'charm'), output_dir)
 
-v={'package': package,
+v={'package': args.charmname,
    'maintainer': '%s <%s>' % get_maintainer() }
 
 try:
     c = apt.Cache()
     c.open()
-    p = c[package]
-    print "Found " + package + " package in apt cache, as a result charm contents have been pre-populated based on package metadata."
+    p = c[args.charmname]
+    print "Found " + args.charmname + " package in apt cache, as a result charm contents have been pre-populated based on package metadata."
     v['summary'] = p.summary
     v['description'] = textwrap.fill(p.description,width=72, subsequent_indent='  ')
 except:
-    print "Failed to find " + package + " in apt cache, creating an empty charm instead."
+    print "Failed to find " + args.charmname + " in apt cache, creating an empty charm instead."
     v['summary'] = '<Fill in summary here>'
     v['description'] = '<Multi-line description here>'
 

=== modified file 'scripts/get'
--- scripts/get	2012-01-19 20:28:23 +0000
+++ scripts/get	2012-05-23 20:56:24 +0000
@@ -1,8 +1,8 @@
 #!/bin/bash
 
-if [ -z "$1" ] ; then
+if [ -z "$1" -o "$1" = "--help" ] ; then
     echo "Retrieves official charm branches from https://launchpad.net/charm" >&2
-    echo "usage: charm get name_of_charm [ local_charm_repo ]" >&2
+    echo "usage: charm get [ --help ] name_of_charm [ local_charm_repo ]" >&2
     exit 1
 fi
 

=== modified file 'scripts/getall'
--- scripts/getall	2011-09-23 18:23:55 +0000
+++ scripts/getall	2012-05-23 20:56:24 +0000
@@ -4,6 +4,7 @@
 usage()
 {
     echo "usage: getall path_to_charms" >&2
+    echo "retrieves all charms from launchpad using mr and bzr"
     exit $1
 }
 

=== added file 'scripts/help'
--- scripts/help	1970-01-01 00:00:00 +0000
+++ scripts/help	2012-05-23 20:56:24 +0000
@@ -0,0 +1,11 @@
+#!/bin/sh
+usage() {
+    echo usage: `basename $0` command_name
+    echo shows help for the given command.
+}
+if [ "$1" = "--help" ] ; then
+    usage
+    exit 0
+fi
+home=`dirname $0`
+$home/$1 --help

=== modified file 'scripts/list'
--- scripts/list	2012-01-19 20:28:23 +0000
+++ scripts/list	2012-05-23 20:56:24 +0000
@@ -1,6 +1,14 @@
 #!/usr/bin/env python
 
 from launchpadlib.launchpad import Launchpad
+import sys
+
+if len(sys.argv) > 1:
+    print('usage: list [ --help ]')
+    if sys.argv[1] == '--help':
+        sys.exit(0)
+    else:
+        sys.exit(1)
 
 lp = Launchpad.login_anonymously('charm-tools', 'production', version='devel')
 charm = lp.distributions['charms']

=== modified file 'scripts/proof'
--- scripts/proof	2012-05-15 23:33:54 +0000
+++ scripts/proof	2012-05-23 20:56:24 +0000
@@ -25,6 +25,7 @@
 import yaml
 import re
 import email.utils
+import argparse
 
 exit_code = 0
 
@@ -47,8 +48,15 @@
   """ Ignorable but sometimes useful """
   print "I: " + msg
 
-if len(sys.argv) >= 2:
-    charm_name = sys.argv[1]
+
+parser = argparse.ArgumentParser(
+        description='Performs static analysis on charms')
+parser.add_argument('charm_name', nargs='?',
+        help='path of charm dir to check. Defaults to PWD')
+args = parser.parse_args()
+
+if args.charm_name:
+    charm_name = args.charm_name
 else:
     charm_name = os.getcwd()
 

=== modified file 'scripts/review-queue'
--- scripts/review-queue	2012-05-23 17:38:12 +0000
+++ scripts/review-queue	2012-05-23 20:56:24 +0000
@@ -4,6 +4,7 @@
 from operator import itemgetter
 import datetime
 import itertools
+import argparse
 
 def calculate_age(from_date = None):
     if not from_date:
@@ -121,6 +122,9 @@
     return(sorted(queue, key=lambda k: k['date_created']))
 
 def main():
+    parser = argparse.ArgumentParser(
+            description="Shows items needing the attention of ~charmers")
+    parser.parse_args()
     review_queue = charm_review_queue()
     keys = ['date_created', 'age', 'summary', 'item', 'status' ]
     headers = ['Date Created', 'Age', 'Summary', 'Item', 'Status']

=== modified file 'scripts/search'
--- scripts/search	2012-01-11 11:26:08 +0000
+++ scripts/search	2012-05-23 20:56:24 +0000
@@ -1,5 +1,11 @@
 #!/bin/bash
 
+if [ "$1" = "--help" ] ; then
+  echo "usage: `basename $0` grep_pattern"
+  echo "greps the list of charms"
+  exit 0
+fi
+
 [ -z "${1}" ] && echo "Search parameter required" && exit 1
 
 charm list | grep "${1}"