added placeholder readme file
[coldcallbot-discord.git] / coldcall.py
1 #!/usr/bin/env python3
2
3 from collections import defaultdict
4 from datetime import datetime
5 from random import choices
6 from os import listdir
7 from csv import DictReader
8
9 import os.path
10 import re
11 import discord
12
13 class ColdCall():
14     def __init__ (self):
15         self.today = str(datetime.date(datetime.now()))
16         # how much less likely should it be that a student is called upon?
17         self.weight = 2 
18
19         # filenames
20         self.__fn_studentinfo = "data/student_information.tsv"
21         self.__fn_daily_calllist = f"data/call_list-{self.today}.tsv"
22         self.__fn_daily_attendance = f"data/attendance-{self.today}.tsv"
23
24     def __load_prev_questions(self):
25         previous_questions = defaultdict(int)
26
27         for fn in listdir("./data/"):
28             if re.match("call_list-\d{4}-\d{2}-\d{2}.tsv", fn):
29                 with open(f"./data/{fn}", 'r') as f:
30                     for row in DictReader(f, delimiter="\t"):
31                         if not row["answered"] == "FALSE":
32                             previous_questions[row["discord_name"]] += 1
33
34         return previous_questions
35     
36     def __get_preferred_name(self, selected_student):
37         # translate the discord name into the preferred students name,
38         # if possible, otherwise return the discord name
39
40         preferred_names = {}
41         with open(self.__fn_studentinfo, 'r') as f:
42             for row in DictReader(f, delimiter="\t"):
43                 preferred_names[row["Your username on the class Discord server"]] = row["Name you'd like to go by in class"]
44
45         if selected_student in preferred_names:
46             return preferred_names[selected_student]
47         else:
48             return None
49
50     def __select_student_from_list (self, students_present):
51         prev_questions = self.__load_prev_questions()
52         
53         # created a weighted list by starting out with everybody 1
54         weights = {s : 1 for s in students_present}
55         
56         for s in students_present:
57             for i in range(0, prev_questions[s]):
58                 # reduce the weight by a factor of 1/weight each time the student has been called upon
59                 weights[s] = weights[s] / self.weight
60
61         # choose one student from the weighted list
62         print(weights)
63         return choices(list(weights.keys()), weights=list(weights.values()), k=1)[0]
64
65     def __record_attendance(self, students_present):
66         # if it's the first one of the day, write it out
67         if not os.path.exists(self.__fn_daily_attendance):
68             with open(self.__fn_daily_attendance, "w") as f:
69                 print("\t".join(["timestamp", "attendance_list"]), file=f)
70
71         # open for appending the student
72         with open(self.__fn_daily_attendance, "a") as f:
73             print("\t".join([str(datetime.now()),
74                              ",".join(students_present)]),
75                   file=f)
76
77     def __record_coldcall(self, selected_student):
78         # if it's the first one of the day, write it out
79         if not os.path.exists(self.__fn_daily_calllist):
80             with open(self.__fn_daily_calllist, "w") as f:
81                 print("\t".join(["discord_name", "timestamp", "answered", "assessment"]), file=f)
82
83         # open for appending the student
84         with open(self.__fn_daily_calllist, "a") as f:
85             print("\t".join([selected_student, str(datetime.now()),
86                              "MISSING", "MISSING"]), file=f)
87
88     def coldcall(self, students_present):
89         selected_student = self.__select_student_from_list(students_present)
90
91         # record the called-upon student in the right place
92         self.__record_attendance(students_present)
93         self.__record_coldcall(selected_student)
94
95         preferred_name = self.__get_preferred_name(selected_student)
96         if preferred_name:
97             coldcall_message = f"{preferred_name} (@{selected_student}), you're up!"
98         else:
99             coldcall_message = f"@{selected_student}, you're up!"
100         return coldcall_message
101
102 # cc = ColdCall()
103  
104 # test_student_list = ["jordan", "Kristen Larrick", "Madison Heisterman", "Maria.Au20", "Laura (Alia) Levi", "Leona Aklipi", "anne", "emmaaitelli", "ashleylee", "allie_partridge", "Tiana_Cole", "Hamin", "Ella Qu", "Shizuka", "Ben Baird", "Kim Do", "Isaacm24", "Sam Bell", "Courtneylg"]
105 # print(cc.coldcall(test_student_list))
106
107 # test_student_list = ["jordan", "Kristen Larrick", "Mako"]
108 # print(cc.coldcall(test_student_list))
109
110 # test_student_list = ["jordan", "Kristen Larrick"]
111 # print(cc.coldcall(test_student_list))

Community Data Science Collective || Want to submit a patch?