ArgparseHelpTable

Script for generating a nicely-formatted text table listing information about the arguments to a Python script that uses the argparse module.

Usage

The arguments to the makeHelpTable.py script are (as generated by makeHelpTable.py itself):

=============================================================================================================
| PARAMETER NAME          | REQUIRED/DEFAULT   | DESCRIPTION                                                |
=============================================================================================================
|-s/--script              | REQUIRED           |Path to script for which argument table should be generated |
-------------------------------------------------------------------------------------------------------------
|-m/--method              | get_parser         |Name of (0-argument) method that returns                    |
|                         |                    |argparse.ArgumentParser                                     |
-------------------------------------------------------------------------------------------------------------
|-nw/--name_width         | 25                 |Number of characters for parameter name column              |
-------------------------------------------------------------------------------------------------------------
|-rw/--required_width     | 20                 |Number of characters for required/default column            |
-------------------------------------------------------------------------------------------------------------
|-dw/--description_width  | 60                 |Number of characters for description column                 |
-------------------------------------------------------------------------------------------------------------