How sonmezahmet/zoom-poll-analyzer works
Project Type and Purpose
• This project is a Python-based application built as a course project (CSE3063 OOSD Fall 2020). Its main purpose is to analyze, convert, and generate reports and charts from polling data, answer keys, and student lists (all provided in formats such as XLS and TXT).
• The project appears to automate the processing of classroom data (polls, attendance, and various evaluation artifacts) and produce outputs (CSV, XLS, PDF charts) to help analyze student performance or participation.
Analyzing the File Structure
• At the root, you see multiple Python modules (e.g., Analyzer.py, GUI.py, PollAnalyzer.py, PollReport.py, etc.) which indicate that the business logic is broken into several components.
• The existence of files like Config.py and config.json suggests that configuration management is a separate component.
• There are dedicated directories:
• “answerKeys” and “answerKeys_txt” for source answer data.
• “artifacts” containing design and documentation files from iterations (these show the evolution of the design).
• “outputs” with subdirectories for anomalies, attendance charts/reports, and poll reports which show that the system generates various output artifacts.
• “pollReports” and “studentList” directories house raw CSV and XLS data that likely feed into the analysis.
• The file names themselves (AnswerKeyConverter, PollAnalyzer, etc.) suggest a modular design where each module has a distinct responsibility (data ingestion, analysis, conversion, and reporting).
Extracting Details from the README
• The README is minimal and primarily identifies the project as a group project for an Object Oriented Software Development course. This informs the design by implying that object-oriented principles (such as modularization and separation of concerns) are used.
Components
a. Main Entry and Configuration:
• “main.py” should be shown as the starting point. It likely handles initialization, reading config.json (managed by Config.py), and orchestrating the workflow.
b. Data Ingestion and Pre-processing:
• Modules and directories that read input files: “answerKeys”, “answerKeys_txt”, “pollReports”, and “studentList”.
• AnswerKey.py and AnswerKeyConverter.py as components converting raw answer data into structured formats.
c. Domain Model and Business Logic:
• Domain objects such as Student (Student.py), Question (Question.py), and Poll (Poll.py), which encapsulate the core business entities.
• Analysis components: Analyzer.py, PollAnalyzer.py, PollOutput.py, PollReport.py, and PollReportRow.py. These implement the business logic for processing polling data and computing reports.
d. User Interface:
• GUI.py module as the user interface layer, which might allow users to interact with the application (e.g., selecting files, triggering report generation).
e. Output Generation:
• Outputs component, representing the subdirectories that contain the generated CSV, PDF, and XLS files (outputs/anomalies, outputs/attendanceCharts, outputs/charts, etc.). This reflects the reporting and visualization part of the system.
Architectural Relationships and Data Flow
• Next, channel input data from file directories (answerKeys, pollReports, studentList) into the ingestion modules (AnswerKey, AnswerKeyConverter, etc.).
• That the processed data flows into the reporting modules (PollReport, PollOutput, PollReportRow) that generate structured reports.
• Finally, indicate that these outputs are written to the “outputs” directories (and similar for charts and attendance reports).
• That the GUI interacts with the core layer to both trigger processes and possibly display results, forming a feedback loop.
Design Principles and Patterns
• Separation of concerns:
• Input/Output is separated from the processing logic.
• The design follows an object-oriented approach, as encouraged by the course.