Compare plugin initial integration

compare-plugin/README.md

@@ -0,0 +1,54 @@
+# CompareResults
+
+The configuration assessment tool (CAT) see [here](https://github.com/Appdynamics/config-assessment-tool) provides metrics on how well your applications are instrumented based on some of the field best practices.
+
+The CompareResults project piggy backs on to the output of the CAT, by allowing us to compare previous output against current output for APM only - these are workbooks ending with "-MaturityAssessment-apm.xlsx"
+
+## Requirements
+
+- Python 3.x
+
+# Setup!
+
+## Setup Instructions
+
+1. Unzip the `CompareResults` folder.
+
+2. On mac - open a terminal and navigate to the `CompareResults` directory:
+    cd path/to/unzipped/CompareResults
+
+3. Run the setup script using bash:
+    ./setup.sh
+
+4. After the bash script has complete and if all modules have been installed - run the following commands 1 after the other:
+    source venv/bin/activate
+    python3 compare_results/core.py
+
+5. The UI should automatically launch with an address of: http://127.0.0.1:5000/ - see considerations for upload. 
+    - The only CAT report we can compare at this time is the APM output - ending with "-MaturityAssessment-apm.xlsx" 
+    - The previous and current APM report has to be from the same controller - otherwise the script will terminate
+    - For best results ensure the previous APM report is dated before the Current APM report
+
+
+
+## If bash will not run:
+
+- chmod +x setup.sh
+
+## Module Not Found Errors
+Modules should be installed as part of setup.sh, however, if you get Module Not Found Errors when running core.py (Error: ModuleNotFoundError: No module named 'openpyxl') you will have to install each Module.
+
+Below is a list of the modules needed:
+- Flask
+- pandas
+- openpyxl
+- python-pptx
+
+Install Module as follows:
+- pip3 install <<module>> or pip install <<module>>
+- Example if you receive: Error: ModuleNotFoundError: No module named 'openpyxl' - enter pip3 install openpyxl 
+
+
+To help with a successful comparison, see below: 
+1. Only one workbook "{jobName}-MaturityAssessment-apm.xlsx" can be compared for now
+2. The xlsx files to be compared have to be from the same controller 

compare-plugin/config.json

@@ -0,0 +1,10 @@
+{
+    "upload_folder": "uploads",
+    "result_folder": "results",
+    "previous_file": "previous.xlsx",
+    "current_file": "current.xlsx",
+    "output_file": "comparison_result.xlsx",
+    "previous_sum_file": "previous_sum.xlsx",
+    "current_sum_file": "current_sum.xlsx",
+    "comparison_sum_file": "comparison_sum.xlsx"
+}