cshelper

cshelper

cshelper helps us organize the secret santa over on /r/ClosetSanta.

Features

Available Commands:
  help        Help about any command
  list        Print the list of users parsed from the CSV file
  match       Generate a list of pairings
  pm          Send PMs to user(s)

Flags:
      --csv-path string   path to the CSV list with the form results (default ".cshelper/ulist.csv")
      --debug             print debug logs
  -h, --help              help for cshelper
      --ignore            ignore ulist.toml, if found

Use "cshelper [command] --help" for more information about a command.

Using

To use cshelper you need to take a few steps of preparation:

Create a file called cshelper.toml in a directory .cshelper:

[bot]
useragent = ""
username = ""
password = ""
clientId = ""
clientSecret = ""

The bot configuration contains the same elements as described here.

Building

cshelper relies on a modified version of clphub/munkres. The change is can be found in the patch here.

To patch the dependency in the vendor/ directory run the following commands:

$ dep ensure
$ go generate && go build