coffee_match.py

#!/usr/bin/env python3

#####
#
# coffee_match.py - a tool for matching teams at random for coffee breaks
#
# Copyright 2020 by Ben Cotton
# Distributed under the copyleft-next license:
#     https://github.com/copyleft-next/copyleft-next/blob/v0.3.0/Releases/copyleft-next-0.3.0
#
#####

import argparse
import random
import sys

__version__ = 0.2

REMAINDER_STRATEGIES = [ 'skip', 'merge', 'accept' ]

# Set up the parser
parser = argparse.ArgumentParser(prog="coffee_match.py " + str(__version__), epilog="For bugs, visit https://github.com/funnelfiasco/coffee_match/")
parser.add_argument("-f", "--file", dest="rosterFile", metavar="FILE", \
    help="The roster file to use", default="team.txt")
parser.add_argument("--remainder", dest="remainder", default="skip", \
        help="What to do with remainders: skip (default), merge, accept")
parser.add_argument("-s", "--size", dest="groupSize", metavar="NUM", \
        help="The size of matches", default=2, type=int)
options = parser.parse_args()

# Open the roster file
try:
    team = open(options.rosterFile,'r')
except FileNotFoundError:
    sys.exit("COFFEE SPILLED: File %s not found" % options.rosterFile)
except PermissionError:
    sys.exit("COFFEE SPILLED: You cannot open file %s" % options.rosterFile)

# Randomize the list of people
people = []
for person in team:
    # Check to make sure we're getting a person, not a blank line or a comment
    if not (person == '\n' or person.startswith('#')):
        people.append((random.random(), person))
# The sort() makes it so we don't get the same result every time
people.sort()

# Check to make sure the group size makes sense
if options.groupSize <= 1:
    sys.exit("COFFEE SPILLED: Group size %i is too small" % options.groupSize)
elif options.groupSize > len(people):
    sys.exit("COFFEE SPILLED: Group size %i is larger than the roster size %i" % \
            (options.groupSize, len(people)))

# Check to see if the remainder strategy is one we understand
if not options.remainder in REMAINDER_STRATEGIES:
    sys.exit("COFFEE SPILLED: I don't recognize the remainder strategy %s.\nSupported options are %s" % (options.remainder, ', '.join(REMAINDER_STRATEGIES)))


print("The next cycle of coffee break matchups:")

members = []
for _, person in people:
  members.append(person.rstrip())

i = 1
total = 1
lastGroup = False
for person in members:
    if (((total - i) + options.groupSize) > len(members)) and options.remainder == "skip":
        # We don't have enough for a full group, so skip un-full groupings.
        break
    elif (len(members) - total) < options.groupSize and options.remainder == "merge":
        # We will make the last group a little bigger
        lastGroup = True
    if ((i < options.groupSize) or lastGroup) and (total < len(members)):
        print("%s & " % person, end ="")
        i = i + 1
        total = total + 1
    else:
        print("%s" % person)
        i = 1
        total = total + 1