Look at the end of the README to see screenshots from the app being used. This is a trend reports generator primarily designed for generating trend reports on my school's graduating student survey data from Qualtrics. However, it is configurable and can work with any type of data, especially survey data. I have included a sample config and sample data so you can test it.
The project is composed of the following main files:
app.py: This is the main Flask app that handles routes, processes configuration files, and generates the reports.TableGenerator.py: This file contains theTableGeneratorclass, which is responsible for generating data tables based on the provided configurations.- Jinja templates: These are rendered as the HTML pages for the web app, and contain all the javascript that make it work.
To set up the project, follow these steps:
- Clone the repository.
- Install the required dependencies, such as Flask and pandas, using
pip install -r requirements.txt. - Run the Flask app using
python app.py.
- Visit the web app's home page.
- Choose to load an existing configuration or create a new one.
- If creating a new configuration, select the data source and configure the questions, filters, and other settings as needed.
- Save the configuration if desired.
- Generate the report based on the configuration.
- View or export the generated report with the provided tables and statistics.
This application is highly configurable, allowing you to use it with various data sources and formats. You can add new configuration files in the configs directory, and data files in the data directory. The configurations are specified in JSON format and can be easily modified to suit your needs using the web UI.
This project is now part of my student portfolio with my manager's permission and is available for use under the terms of the MIT License.
