Add Windows and Output File Support

- Add ability to execute from windows by dragging CSV file onto progress.py script.
- Add ability to write output to a file.
- Minor cleanup

Author: sgreasby

README.md

@@ -1,21 +1,38 @@
 # Description
-This repository constains a script for generating Scouts BSA progress reports
+This repository constains a python script for generating Scouts BSA progress reports
 
 # Requirements
-The script has been tested with python 3.11.
+The script has been written for python 3.11 and utilizes the pandas and psutil modules.
+
+Before running the script for the first time, ensure python 3.11 or later is installed on your computer and install the requried modules by typing the following from the command line:
+
+`pip install pandas`
+`pip install psutil`
 
 # Usage
-python  {--date=[MM/DD/YYYY]} {--id=[scoutid]} {--cubs} [scoutbook.csv]
+The script can be launched from the command line or from Windows.
+
+To lanuch from windows drag the desired CSV file and drop it onto the progress.py icon. When the script executes, it will prompt the user for all optional arguments.
+
+To launch from the command line type the following, where {} denotes optional portions and [] denotes portions to be specified by the user.
+
+`python progress.py {--date=[MM/DD/YYYY]} {--id=[scoutid]} {--cubs} [scoutbook.csv]`
 
 ## Required Arguments
 ### [scoutbook.csv]
 This outlines the path to the CSV file exported from Scoutbook.
 
+
 ## Optional Arguments
+### {--out=[outfile.txt]}
+Specifies the file name where all output will be written.
+If omitted, output will be displayed to the screen.
 ### --date=[MM/DD/YYYY]
-This defines the date of of the last progress report. All progress made since this date will be considered new.
+Defines the date of of the last progress report. All progress made since this date will be considered new.
+If omitted, a default date of 1/1/1980 wil be used.
 ### --id=[scoutid]
-This is used to tell the script to only generate a progress report for the indicated scout (rather than for all scouts).
+This is used to tell the script to only generate a progress report for a specific scout.
+If omitted, a progress report will be generated for all scouts listed in the CSV file.
 ### --cubs
-This is used to indicate that the progress report is generated for Cub Scouts. When this flag is set, the script will not display progress towards eagle, and will indicate Cub Scout and Webelos specific advancement and awards. 
-
+This is used to indicate that the progress report is generated for Cub Scouts. When this flag is set, the script will not display progress towards eagle, and will indicate Cub Scout and Webelos specific advancement and awards.
+If omitted, only Scouts BSA advancement and awards will be displayed.

progress.py

@@ -8,19 +8,36 @@
 __url__        = "http://github.com/sgreasby/Scout-Progress-Report"
 __maintainer__ = "Steven Greasby"
 ###########################################################
+import os
 import sys
-import pandas
-import re
 import datetime
 import builtins
+import re
+import builtins
 
-warnings=False
+# The following modules are required, tell non python users how to get them.
+try:
+    import pandas
+except:
+    builtins.print("type \"pip install pandas\" from the command line then try again") 
+try:
+    import psutil
+except:
+    builtins.print("type \"pip install psutil\" from the command line then try again") 
+    
+# Figure out if user ran from command line or clicked icon 
+windows= 1 if psutil.Process(os.getpid()).parent().name() == 'py.exe' else 0
 
+# Debugging code
+warnings=False
 PRINT_COLS=50
-
-pandas.set_option('display.max_rows', None)
+# If launched via windows, the window may close before the error can be read
+# If this happens, just set windows=1 and run from the command line to see error.
+#windows=1
+#pandas.set_option('display.max_rows', None)
 #pandas.set_option('display.max_columns', None)
 
+
 eagle_mbs=[['Camping'],
            ['Citizenship in the Community'],
            ['Citizenship in the Nation'],
@@ -81,10 +98,25 @@
                'Life'           :['1','2','3','4','5','6','7','8'],
                'Eagle'          :['1','2','3','4','5','6','7']}
 
+
+####################################
+# Global Variables
+####################################
 indent=0
+scoutbook=pandas.DataFrame()
+cols=pandas.DataFrame()
+last_review="1/1/1980"
+last_review=pandas.to_datetime([last_review])[0]
+specificScout=False
+cubs=False
+outFile=sys.stdout
+
+####################################
+# Functions
+####################################
 def print(*args, **kwargs):
-    builtins.print("  "*indent,end="")
-    return builtins.print(*args, **kwargs)
+    builtins.print("  "*indent,end="",file=outFile)
+    return builtins.print(*args, **kwargs,file=outFile)
 
 def warn(*args, **kwargs):
     if warnings:
@@ -98,59 +130,108 @@ def error(*args, **kwargs):
     return builtins.print(*args, **kwargs)
 
 def usage():
-    builtins.print("Usage: %s {--date=[MM/DD/YYYY]} {--id=[scoutid]} {--cubs} [scoutbook.csv]\n\n" %(sys.argv[0]))
+    if windows:
+        if scoutbook.empty:
+            builtins.print("Drag CSV file on top of %s icon" %(sys.argv[0]))
+        input("\nPress any key to continue...")
+    else:
+        builtins.print("Usage: %s {--out=[outfile.txt]} {--date=[MM/DD/YYYY]} {--id=[scoutid]} {--cubs} [scoutbook.csv]\n\n" %(sys.argv[0]))
     sys.exit()
 
-# Parse Arguments
-csv_open=False
-# Use pandas to convert last_review to datetime object
-last_review="1/1/1980"
-last_review=pandas.to_datetime([last_review])[0]
-specificScout=False
-cubs=False
-if len(sys.argv)<2:
-    usage()
-for arg in sys.argv[1:]:
-    if arg.startswith('--date='):
-        junk,last_review = arg.split('=')
-        try:
-            # Use pandas to convert last_review to datetime object
-            last_review=pandas.to_datetime([last_review])[0]
-        except:
-            builtins.print("%s does not appear to be a valid date."%last_review)
-            usage()
-    elif arg.startswith('--id='):
-        junk,specificScout = arg.split('=')
-        try:
-            specificScout=int(specificScout)
-        except:
-            builtins.print("%s does not appear to be a valid scout ID"%specificScout)
-            usage()
-    elif arg == '--cubs':
-        cubs=True
-    elif not arg.startswith('--'):
-        builtins.print("Opening %s" %(arg))
-    
-        try:
-            # First row of CSV contains column names.
-            # However some rows have an undocumnted column
-            # Add dummy column to avoid errors when reading in data
-            cols = pandas.read_csv(arg, nrows=1,header=None).values.flatten().tolist()+['Undocumented']
-        except:
-            builtins.print("Failed to read %s." %(arg))
-            usage()
-        else:
-            csv_open=True
-
+def csv_open(csv_file):
+    col_names=pandas.DataFrame()
+    data=pandas.DataFrame()
+    builtins.print("Opening %s" %(csv_file))
+    try:
+        # First row of CSV contains column names.
+        # However some rows have an undocumnted column
+        # Add dummy column to avoid errors when reading in data
+        col_names = pandas.read_csv(csv_file, nrows=1,header=None).values.flatten().tolist()+['Undocumented']
+    except:
+        builtins.print("Failed to read %s." %(csv_file))
+        usage()
+    else:
         # read the rest of the CSV file
         # Skip first row (col names) and use names determined above
-        scoutbook = pandas.read_csv(arg, skiprows=1,names=cols)
-    else:
+        data = pandas.read_csv(csv_file, skiprows=1,names=col_names)
+    return data,col_names
+
+
+def convert_date(date):
+    try:
+        # Use pandas to convert date to datetime object
+        date=pandas.to_datetime([date])[0]
+    except:
+        error("%s does not appear to be a valid date."%date)
         usage()
+    return date
 
-if not csv_open:
+def id_check(scoutID):
+    try:
+        scoutID=int(scoutID)
+    except:
+        error("%s does not appear to be a valid scout ID"%scoutID)
         usage()
+    return scoutID
+
+def out_check(name):
+    handle=None
+    if os.path.exists(name):
+        error("%s already exists"%name)
+        usage()
+    try:
+        handle=open(name,'a')
+    except:
+        error("Unable to open %s for writing."%name)
+        usage()
+    return handle
+
 
+if len(sys.argv)<2:
+    usage()
+
+if windows:
+    scoutbook,cols=csv_open(sys.argv[1]);        
+
+    response=input("Enter date of last progress report or leave blank for none (MM/DD/YYYY): ")
+    if response:
+        last_review=convert_date(response)
+
+    response=input("Enter ID of a specfic scout or leave blank to run for all scouts: ")
+    if response:
+        specificScout=id_check(response)
+
+    response='unknown'
+    while not response in ['y','Y','n','N','']:
+        response=input("Run script for Cub Scouts? y/N: ")
+
+    if response in ['y','Y']:
+        cubs=True
+
+    response=input("Enter ouput file or leave blank to print to screen: ")
+    if response:
+        outFile=out_check(response)
+
+else:
+    for arg in sys.argv[1:]:
+        if arg.startswith('--out='):
+            junk,value = arg.split('=')
+            outFile=out_check(value)
+        elif arg.startswith('--date='):
+            junk,value = arg.split('=')
+            last_review=convert_date(value)
+        elif arg.startswith('--id='):
+            junk,value = arg.split('=')
+            specificScout=id_check(value)
+        elif arg == '--cubs':
+            cubs=True
+        elif not arg.startswith('--'):
+            scoutbook,cols=csv_open(arg);        
+        else:
+            usage()
+
+    if scoutbook.empty:
+        usage()
 
 #######################################
 # Clean up imported data before using it
@@ -211,6 +292,9 @@ def usage():
     rankup_date = approved_ranks['Date Completed'].max()
     rank = approved_ranks['Advancement'].loc[approved_ranks['Date Completed']==rankup_date].to_string(index=False)
 
+    if outFile != sys.stdout:
+        builtins.print("Processing %s, %s."%(last_name, first_name))
+
     indent=0
     print("%s, %s: %s (%s)" %(last_name,first_name,rank,str(rankup_date.date())))
 
@@ -486,7 +570,7 @@ def usage():
                 else:
                     all_reqs = bsa_rank_reqs[rank[:-17]]
             except:
-                builtins.print("Warning: %s rank not yet supported"%rank[:-17])
+                warn("%s rank not yet supported"%rank[:-17])
             s=set(new_reqs)
             reqs_remaining=[req for req in all_reqs if req not in s]
             s=set(prev_reqs)
@@ -666,3 +750,5 @@ def usage():
     builtins.print("Scout %d not found" % specificScout)
     usage()
 
+if windows:
+    input("\nPress any key to continue...")