Metadata-Version: 2.3
Name: grade-analysis
Version: 1.0.1
Summary: Tool for analyzing grading analysis data
License: GPL-3.0-or-later
Author: Mario Marku
Author-email: mariom@fordham.edu
Requires-Python: >=3.12,<4.0
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: Requests
Requires-Dist: matplotlib
Requires-Dist: mplcursors
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: prompt_toolkit
Requires-Dist: scikit_learn
Requires-Dist: seaborn
Requires-Dist: tabulate
Requires-Dist: ttkwidgets
Requires-Dist: webcolors
Project-URL: Homepage, https://www.cis.fordham.edu/edmlab/software/grade-analysis-tool
Project-URL: Repository, https://github.com/Fordham-EDM-Lab/Grading-Analysis-Tool/issues
Description-Content-Type: text/markdown

# Grading Analysis Tool

This tool was created by **[Mario Marku](https://www.linkedin.com/in/mario-marku-384732247/)** with advisement from **[Dr. Gary Weiss](https://storm.cis.fordham.edu/~gweiss/)** and **[Dr. Daniel Leeds](https://storm.cis.fordham.edu/leeds/)** to simplify grading data analysis for educators without requiring programming or data analytics skills. Its intuitive interface streamlines the process of exploring student and course performance data.

---
## Prerequisites

1.  **Install Python 3**
    * **Windows**: [https://www.python.org/downloads/windows/](https://www.python.org/downloads/windows/)
    * **macOS**: [https://www.python.org/downloads/macos/](https://www.python.org/downloads/macos/)
    * **Linux**: Use your distro’s package manager or download from [https://www.python.org/downloads/](https://www.python.org/downloads/)

2.  **(Recommended) Create a Virtual Environment**
    * This prevents conflicts with system-wide packages:
        ```bash
        python3 -m venv venv
        # On Windows:
        venv\Scripts\activate
        # On macOS/Linux:
        source venv/bin/activate
        ```
    * If you **choose not** to use a virtual environment (not recommended), you can install system-wide.
        If pip refuses to install due to potential conflicts, add:
        ```bash
        pip install -e . --break-system-packages
        ```
        This **overrides** pip’s default protections, and may affect system packages.

---

## Installation

1.  **Clone or Download this Repository**
    ```bash
    git clone [https://github.com/Fordham-EDM-Lab/Grading-Analysis-Tool](https://github.com/Fordham-EDM-Lab/Grading-Analysis-Tool)
    ```
2.  **Install Dependencies (Inside the Virtual Environment, if created)**
    ```bash
    pip install -e .
    ```
    Or (if you want to bypass warnings about system packages):
    ```bash
    pip install -e . --break-system-packages
    ```

## After Installation

Simply run:

```bash
grade-analysis
```

Or

```bash
python3 -m src.gradeAnalysisGUI
```

