Skip to content

Commit 46e2a18

Browse files
chore: update README.md
1 parent 9ab2163 commit 46e2a18

7 files changed

Lines changed: 2065 additions & 7 deletions

File tree

README.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,12 @@ An algorithm to form mentorship groups between student mentees and mentors.
55
## Algorithmic Overview
66
Provided the availability of mentees and mentors, fix a time for a mentor to have a mentorship group based on their availability (phase one), and assign mentees to that mentorship group if it is also in their availability. We let availability denote a collection of one hour timeslots on a specific day.
77

8-
## Abstract Datatypes
9-
- Person
10-
- Group
11-
128
## Development Setup
13-
The project uses `ruff`, `mypy`, and `pre-commit` for linting, formatting, type-checking, and code consistency checks. You can install all of these tools using `uv tool install` and run them on the project where the respective tool configurations are stored in the `pyproject.toml`.
9+
The project uses `ruff`, `ty`, and `pre-commit` for linting, formatting, type-checking, and code consistency checks. You can install all of these tools using `uv tool install` and run them on the project where the respective tool configurations are stored in the `pyproject.toml`.
1410

1511
Setup the virtual environment:
1612
```
17-
uv venv
13+
uv sync
1814
```
1915

2016
Setup testing:
@@ -32,4 +28,4 @@ pre-commit run -a
3228
## Program Usage
3329
```
3430
uv run src/mentor_match
35-
```
31+
```
Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
[
2+
{
3+
"first_name": "Sarah",
4+
"preferred": "",
5+
"last_name": "Osment",
6+
"username": "",
7+
"email": "sosment@uchicago.edu",
8+
"availability": ["10:00am - 11:30am", "3:00pm - 4:30pm"]
9+
},
10+
{
11+
"first_name": "Lawrence",
12+
"preferred": "",
13+
"last_name": "Chamunorwa",
14+
"username": "",
15+
"email": "ltc2@princeton.edu",
16+
"availability": ["8:30am - 10:00am"]
17+
},
18+
{
19+
"first_name": "Lawrence",
20+
"preferred": "",
21+
"last_name": "Chamunorwa",
22+
"username": "",
23+
"email": "ltc2@princeton.edu",
24+
"availability": ["10:00am - 11:30am"]
25+
},
26+
{
27+
"first_name": "Thomas",
28+
"preferred": "",
29+
"last_name": "Lambert",
30+
"username": "prof_thomas_lambert",
31+
"email": "iamtlamb@gmail.com",
32+
"availability": ["8:30am - 10:00am", "10:00am - 11:30am", "3:00pm - 4:30pm"]
33+
},
34+
{
35+
"first_name": "Bernard",
36+
"preferred": "BJ",
37+
"last_name": "Lillis",
38+
"username": "bj.jb",
39+
"email": "bjlillis4@gmail.com",
40+
"availability": ["10:00am - 11:30am", "3:00pm - 4:30pm"]
41+
},
42+
{
43+
"first_name": "Sakinah",
44+
"preferred": "",
45+
"last_name": "Hofler",
46+
"username": "",
47+
"email": "sh0685@princeton.edu",
48+
"availability": ["10:00am - 11:30am"]
49+
},
50+
{
51+
"first_name": "Janet",
52+
"preferred": "",
53+
"last_name": "Kay",
54+
"username": "",
55+
"email": "jekay@princeton.edu",
56+
"availability": ["10:00am - 11:30am"]
57+
},
58+
{
59+
"first_name": "Samuel",
60+
"preferred": "Sam",
61+
"last_name": "Garcia",
62+
"username": "",
63+
"email": "sjgarcia1212@gmail.com",
64+
"availability": ["3:00pm - 4:30pm"]
65+
},
66+
{
67+
"first_name": "Megan",
68+
"preferred": "",
69+
"last_name": "Tusler",
70+
"username": "",
71+
"email": "mtusler@alumnae.mills.edu",
72+
"availability": ["10:00am - 11:30am", "3:00pm - 4:30pm"]
73+
},
74+
{
75+
"first_name": "Zhuolun",
76+
"preferred": "",
77+
"last_name": "Xie",
78+
"username": "Zhuolun Xie",
79+
"email": "zx4117@princeton.edu",
80+
"availability": ["8:30am - 10:00am"]
81+
},
82+
{
83+
"first_name": "Zhuolun",
84+
"preferred": "",
85+
"last_name": "Xie",
86+
"username": "Zhuolun Xie",
87+
"email": "zx4117@princeton.edu",
88+
"availability": ["10:00am - 11:30am"]
89+
},
90+
{
91+
"first_name": "Catherine",
92+
"preferred": "",
93+
"last_name": "Young",
94+
"username": "",
95+
"email": "",
96+
"availability": ["8:30am - 10:00am", "10:00am - 11:30am"]
97+
}
98+
]

0 commit comments

Comments
 (0)