3201 Utility

Purpose

The purpose of this project is to make creating documents for EE/CE3201 easier. These documents take the form of Excel files due to the tabular nature of class lists, checkoffs, etc.

It is recommended to create a virtual environment to run this application. You can install the dependencies using pip install -r requirements.txt. Running the setup script ./setup.sh, in a UNIX (or UNIX-like) environment will do this for you.

Use the command python -m 3201_utility --help for detailed information related to running the program. Alternatively, running the scripts in the scripts folder will run the programs in their most basic forms.

Expected File Formats

The input files to this program are all expected to be either CSV or XLS files. Generally, these are expected to be in the format provided by BlackBoard collaborate.

Lab Checkoffs

The file input for the checkoffs expects a single column per set of checkoffs (see the included [3201 checkoff list](checkoff_lists/3201_checkoff_lists.csv) for an example) The first row should be the name of the file and the following rows should be the names of the checkpoints.

Sign-In Sheets

The expected inputs are the BlackBoard class list files. Provide the path to a folder containing the class list for each section (the default folder is called section_lists). The output will be a single Excel file with a different sheet for each section.

Pre-lab Checks

This function checks to ensure that students have turned in an assignment. It requires the same section lists as the sign-in sheets, as well as the download from grade center for the specific assignment. Again, provide the script with the correct path to the assignment files (default is a folder named pre_lab_lists) and the output will be one Excel file per assignment file with a single tab for each section with missing assignments.

Running Basic Scripts

The following terminal commands would create the required folders, then run all commands:

./setup.sh Install virtual environment and create default folder structure

Add required files before running the remaining scripts!

./make_sign_ins.sh Create sign-in sheets for each lab section.

./make_checkoffs.sh "Lab 5" Create checkoff sheets for lab 5 (notice that "Lab 5" is added at the end. This argument should match a column header in the checkoff list file).

./check_prelabs.sh Check for missing pre-lab assignments