File tree 1 file changed +19
-2
lines changed
1 file changed +19
-2
lines changed Original file line number Diff line number Diff line change @@ -6,12 +6,29 @@ It uses [this implementation of Munkres](https://github.com/bmc/munkres) to find
6
6
7
7
## Scoring
8
8
9
- Full details of how the matches are calculated can be read in the code itself.
9
+ Full details of how the matches are calculated can be read in the code itself. Customisable configurations are on the
10
+ roadmap but are not planned for any upcoming releases.
10
11
11
12
## Installation
12
13
13
14
You can install this project with ` python -m pip install mentor-match `
14
15
15
16
## Use
16
17
17
- [ TODO]
18
+ To use this library, first install it (see above). You may need to munge your data for the system to be happy with it.
19
+ Use the attached CSV files as guides for your mentor and mentee data, then put them together in the same folder.
20
+
21
+ Here is a snippet that outlines a minimal use:
22
+
23
+ ``` python
24
+ from matching import process
25
+
26
+ data_folder = " Documents/mentoring-data"
27
+ mentors, mentees = process.conduct_matching_from_file(data_folder)
28
+
29
+ output_folder = data_folder / " output"
30
+ process.create_mailing_list(mentors, output_folder)
31
+ process.create_mailing_list(mentees, output_folder)
32
+ ```
33
+ This creates a mailing list according to a set template, ready for processing by your favourite/enterprise mandated
34
+ email solution
You can’t perform that action at this time.
0 commit comments