agenodrei / mpim-tools

MPIM Toolbox that ingests tables from google forms where participants entered their preferences in potenial partners. This packages automates creating similar matches, ranking them and sending out mails with the best results to each participant.

mpim-tools

Software for Meet people in Maastricht 2021 - Toolbox. Program ingests tables from google forms where participants entered their preferences in potenial partners. This packages automates creating similar matches, ranking them and sending out mails with the best results to each participant.

Installation

Install this tool using pip:

$ pip install mpim-tools

Usage

Setup the tool with the necessary config using this command:

mpim-tools setup <mailgun_domain> <api_key>

Create match suggestions for manual review for each participant, output folder will be created

mpim-tools match <examples_relationships.xlsx> <output_path>

After manual curation, this command creates a matching table automatically

mpim-tools confirm <prv_output_path>

Notify all participants provided you have a file with all the personal information and the previously generated matches:

mpim-tools notify <matches.xlsx> <examples_relationships.xlsx> 

Development

To contribute to this tool, first checkout the code. Then create a new virtual environment:

cd mpim-tools
python -m venv venv
source venv/bin/activate

Or if you are using pipenv:

pipenv shell

Now install the dependencies and test dependencies:

pip install -e '.[test]'

To run the tests:

pytest

ToDo

• Mail automation
  • Add all infos from the google form to the generated mail
  • Get an actual domain for the emails
  • HTML email templates
• Create matching algorithm
  • Based on categorical information
  • Based on personality information
  • Command that generates a match table based on the remaining curated matches
• Create user-friendly configuration for mail/id column names
• Automatically add IDs to inital documents