speed-friending-matcher

Matching software for speed friending events.


Keywords
csv, matching, processing, python, social, social-network, speed-dating, speed-friending
License
MIT
Install
pip install speed-friending-matcher==0.1.1.dev0

Documentation

Matching Software for Speed Friending Events

Build Status License: MIT

This application is designed to make your life as organizer of speed friending events easier. I created this software for a local speed friending event in Vienna, Austria to give back value to the event organizers. For me, the project additionally serves as a playground for software engineering best practices. The application was implemented in an agile, test-driven development process applying all development best practices so far known to me.

Installing the application

Install the application dependencies using pip:

sudo pip install -r requirements.txt

How to use it

Run the speed-friending-matcher from the command line:

usage: speed-friending-matcher.py [-h] -i INPUT -o OUTPUT

Matchmaking application for speed friending events

optional arguments:
  -h, --help            show this help message and exit
  -i INPUT, --input INPUT
                        Input plugin and parameters e.g. csv:somefile.csv
  -o OUTPUT, --output OUTPUT
                        Output plugins and parameters e.g. todo:mytodo.txt

For example:

./speed-friending-matcher.py -i csv:example/sample.csv -o todo:test.txt

Importer Plugins

  • csv:.csv: imports a CSV file with partipants data

Exporter Plugins

  • todo:.txt: exports a TODO file
  • onexlsx:.xlsx: exports a single Excel sheet containing matching information

Extending the software

You can extend the software by adding new import and export plugins. Take a look the default plugins csvimporter and todoexporter for more details.