Skip to content

Commit d4e5706

Browse files
authored
Output to HTML
- Modified script to output to HTML files rather than to the screen or to .txt files. - Eliminated parameter to define output file. This is no longer needed. An output folder is now created, and an HTML file is created for every scout. - Eliminated parameter to allow progress report for individual scouts. This is no longer needed since individual HTML files are created for each scout. - Added parameter to define CSS file. The script uses a default style by default but users can define their own CSS file to override this style. - Minor bug fixes.
1 parent 2ac132e commit d4e5706

File tree

2 files changed

+530
-536
lines changed

2 files changed

+530
-536
lines changed

README.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Description
2-
This repository constains a tool for for generating Scouts BSA progress reports
2+
This repository constains a tool for for generating Scouts BSA progress reports.
33

44
The tool comes in the form of a windows executable or a python script. While I encourage all users to run the python version of the script so they can see what it is doing, I also realize many people may not have even heard of python. As a result, I have also generated a windows executable for those users.
55

@@ -15,34 +15,32 @@ Before running the script for the first time, ensure python 3.11 or later is ins
1515

1616
`pip install pandas`
1717
`pip install psutil`
18+
`pip install dominate`
1819

1920
# Usage
2021
## Windows Executable
21-
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. See the definition of all arguements in the "Python Script" section below.
22+
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. See the definition of all arguements in the "Python Script" section below. The script will generate HTML files in an "output" folder where the .exe file is located.
2223

2324
## Python Script
24-
The script can be launched from the command line or from Windows.
25+
The script can be launched from the command line or from Windows. The script will generate HTML files in an "output" folder where the script file is located.
2526

2627
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.
2728

2829
To launch from the command line type the following, where {} denotes optional portions and [] denotes portions to be specified by the user.
2930

30-
`python progress.py {--date=[MM/DD/YYYY]} {--id=[scoutid]} {--cubs} [scoutbook.csv]`
31+
`python progress.py {--date=[MM/DD/YYYY]} {--cubs} [scoutbook.csv]`
3132

3233
### Required Arguments
3334
#### [scoutbook.csv]
3435
This outlines the path to the CSV file exported from Scoutbook.
3536

3637
### Optional Arguments
37-
#### {--out=[outfile.txt]}
38-
Specifies the file name where all output will be written.
39-
If omitted, output will be displayed to the screen.
4038
#### --date=[MM/DD/YYYY]
4139
Defines the date of of the last progress report. All progress made since this date will be considered new.
4240
If omitted, a default date of 1/1/1980 wil be used.
43-
### --id=[scoutid]
44-
Tells the script to only generate a progress report for a specific scout.
45-
If omitted, a progress report will be generated for all scouts listed in the CSV file.
41+
#### --css=[style.css]
42+
Defines the CSS style sheet to customize the look of the progress reports.
43+
If omitted, a default style will be applied.
4644
#### --cubs
4745
Indicates 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.
4846
If omitted, only Scouts BSA advancement and awards will be displayed.

0 commit comments

Comments
 (0)