diff --git a/README b/README index 203677f..133aeb3 100644 --- a/README +++ b/README @@ -9,6 +9,23 @@ Options: Dependencies: bs4 - --- +--- + +Usage: report.py [options] + +Options: + -h, --help show this help message and exit + -i INPUT_SCRIPT, --input-script=INPUT_SCRIPT + input (json) script mapping commands to text + placeholders + -o OUTPUT_FILE, --output-file=OUTPUT_FILE + report file to be generated + -t TEMPLATE_FILE, --template-file=TEMPLATE_FILE + template file from which the report is generated + -a ARCHIVE, --archive=ARCHIVE + the archive dir or file (.json.gz) to produce the + report from (default='nettime-l_2016-12-31.json.gz') + +Dependencies: pandas, matplotlib (for graphs) \ No newline at end of file diff --git a/report.py b/report.py index a407bae..63749d3 100644 --- a/report.py +++ b/report.py @@ -107,10 +107,10 @@ def run(options): if __name__ == "__main__": p = OptionParser(); - p.add_option('-i', '--input-script', action="store", help="..") - p.add_option('-o', '--output-file', action="store", help="..") - p.add_option('-t', '--template-file', action="store", help="..") - p.add_option('-a', '--archive', action="store", help="..", default="nettime-l_2016-12-31.json.gz") + p.add_option('-i', '--input-script', action="store", help="input (json) script mapping commands to text placeholders") + p.add_option('-o', '--output-file', action="store", help="report file to be generated") + p.add_option('-t', '--template-file', action="store", help="template file from which the report is generated") + p.add_option('-a', '--archive', action="store", help="the archive dir or file (.json.gz) to produce the report from (default='nettime-l_2016-12-31.json.gz')", default="nettime-l_2016-12-31.json.gz") options, args = p.parse_args()