madgrades / api.madgrades.com

A REST interface for UW Madison course data.

madgrades-extractor

This project reads UW Madison grade distribution and course report PDF files (published by the UW Madison Office of the Registrar) and converts them into CSV or SQL dump files.

You will find published, update-to-date datasets at Kaggle.

Conversion

The conversion process for a single term is as follows:

1. Open DIR report for the term.

   a. Extract table from PDF (using tabula)

   b. Read each row, adding new section per row.

   c. Collate section info as necessary (i.e. 2 instructors for 1 single section)

   d. Collate courses which appear to be cross-listed (based on similarity between sections offered)

2. Open grades report for the term.

   a. Extract table from PDF

   b. Read each row, add add each section grade data to course data added by the DIR report process

Typically all terms are extracted so this process repeats for each term.

Command Line Usage

Build it yourself with mvn clean install or grab a release from the releases page.

Usage: <main class> [options]
  Options:
    -d, -download
      Download the PDF reports instead of extracting data
      Default: false
    -e, -exclude
      Comma-separated list of term codes to exclude (ex. -e 1082)
    -f, -format
      The output format
      Default: CSV
      Possible Values: [CSV, MYSQL]
    -l, -list
      Output list of terms to extract
      Default: false
    -out, -o
      Output directory path for exported files (ex. -o ../data)
      Default: ./
    -t, -terms
      Comma-separated list of term codes to run (ex. -t 1082,1072)

Examples:

• java -jar madgrades-final-1.0-SNAPSHOT.jar: will fetch every term and output files to the current directory
• java -jar madgrades-final-1.0-SNAPSHOT.jar -t 1082: will fetch just term 1082
• java -jar madgrades-final-1.0-SNAPSHOT.jar -o ../ -t 1082,1072: will fetch terms 1072 and 1082, output to ../

Relational Diagram

The CSV or SQL dumps are in the format of a collection of relational entities modeled something like this:

api.madgrades.com's Issues

Instructor name correction request

Correction to name for instructor 4833809.

Docker-ify

Bundle this app into a Dockerfile, maybe include elastic search and other dependencies for simplicity?

Instructor deletion request

Tracking these requests, instructor id is 3220968.

Correct instructor name SARA KARPUKHIN

Correction to teaching

Instructor 5444001 did not teach in course ce2189ea-6319-33c5-a127-388c6ccb0031 for term code 1204.

Sign in with GitHub on the API page doesn't work.

I am signed in with GitHub, and I'm not provided a key after clicking the sign-in button.