This tool executes all scripts used to generate metrics (including tables and charts) for the EducationSuperHighway State of the States (SotS) Report and displays the metrics in a Google Sheet tracker, with the ability to refresh at any time. The tool also tracks the history of all metrics each time it runs so we can see how they evolve over time as the production data becomes more clean/stable.
Please refer to this wiki for how to use the tool to generate a SotS metric.
- The tool is built entirely in python - you should be able to use python 2.7 or 3, but python 2.7 is a safer bet
- You must have Java 8 installed (check using the
java -versioncommand) - You must have R installed
3 credentials and configuration files are needed in order to execute the scripts because we are using Google Sheets and Google Drive APIs. See the Python Quickstart for the Sheets API and the PyDrive docs for the necessary auth setup.
Your .bash_profile and .env should be set up with ESH environment variables - the GITHUB path and DAR database credentials are required at a minimum.
The isl_main.py script found in src/2019/ runs the tool.
Each time you run isl_main.py, there will be a stream of output that you can pipe to a log file. It prints details around every script being run and the errors (if any) that occurred during each script.