Eric / Implemented Script For Automating Email Outreach Information

[EricWeng23]

Summary

UPDATE 2:
Added the additional column 'Has course/professor use QMI before' to the output CSV file

• Populated the column cells using data from past semester tracker csv (SP24)
  • Past semester csv located in scripts/tracker folder called past_semester.csv
• Blacklisted courses that are not interested in using QMI

As documented the code for the status of columns are as follows:

• 2 indicates that both the course and professor have used QMI before
• 1 indicates that professor used QMI before
• 0 indicates that course used QMI before
• -1 indicates that neither the course nor the professor have used QMI before

Implementation Logic:

1. If one of the professors teaching this semester has taught the course in the past, check whether the course decided to use QMI that past semester
   • If the course decided to use QMI, return 2 (since both professor and course used QMI)
   • If the course decided not to use QMI, then return the original status
2. If a new professor teaching the course this semester, check if the course previously used QMI
   • If the course has decided to use QMI in the past semester, return 0 (course has used QMI, maybe not prof)
   • If the course decided not to use QMI, but historically the course or the past professors used QMI (0 or 2) return 0

Return -1 if the course is not tracked in spreadsheet.

UPDATE:
Additional Filtering Logic implemented:

1. Filtered out Academic Support
2. Filtered out Independent Research and Studies
3. Filtered out Graduate Level courses
4. Filtered out Cornell Tech Courses
5. Filtered out courses with < 3 credits
   I still kept the bar for class level for <5000 because some 4k classes still has high demand for OH. Filtered out the Independent Research and PRJ instead.

From Nidhi's Comment regarding the Professor teaching multiple courses, it would happen under 2 cases:

1. Professor ACTUALLY teaches 2 courses
2. A course is crosslisted with other subject fields
   A check is implemented to combine these courses into one like below:

This PR focuses on implementing a script to automate and compile all the course informations (Course Number, Professors, Emails, etc) into a csv file. The data are fetched from the class roster API to retrieve the JSON files for all the relevant courses that QMI is tracking.

API URL: https://classes.cornell.edu/api/2.0/config/rosters.json
Note: The semester rosters are sorted in chronological order with the last element being the most recent SP25

Supply the appropriate URL parameters to get the corresponding data (e.g specify the subject)

NOTE: Class roster API does not supply the total class size of the course, so we are unable to filter with this property. Researched Course-Grab github repo, but its seems like they are only fetching the status code (open, closed, waitlist) of the courses instead of class sizes. Thus, course grab does not apply to our use case. An alternative is to webscrape from Student Center, but this is extremely difficult to implement as I had experimented already.

This only compiles the csv with the subjects courses we discussed, did not implement much of the filtering logic (only filtered out some graduate courses)

Test Plan

Tested locally via the terminal and verified that contents are written to the output csv file

Notes

Breaking Changes

None

• I have updated the documentation accordingly.
• My PR adds a @ts-ignore

[dti-github-bot]

[diff-counting] Significant lines: 434.

[NIDHI2023]

Thanks for making such a speedy PR, it looks really good so far and the formatting for the csv seems to work out for most cases! I think other filter ideas could be setting the location to Ithaca instead of Cornell Tech, and some of the class levels could probably be lower since the 4000s tend to be research/project courses.
One other small note, in general when making branches, I'd suggest naming them like 'eric/"your task here"'

[NIDHI2023]

Logic + csv file looks good, great work finishing up this PR! Before merging, just add INFO/CS 4152 to the blacklisted courses and the word "Thesis" to irrelevant_courses, I think that'd be useful for one last filtering edit