getschomp / secret-santa

Python script for emailing secret santa participants

Last Updated: 2018-11-24 10:48 @matthew-cox

Table of Contents

• secret-santa
  • Dependencies
  • Configuration
  • Usage

secret-santa

secret-santa can help you manage a list of secret santa participants by randomly assigning pairings and sending emails. It can avoid pairing couples to their significant other, and allows custom email messages to be specified.

Dependencies

Python 3, version must be lower than 3.10

Non-core dependencies:

• PyYAML
• pytz

To installed the needed dependencies:

pip install -r ./requirements.txt

Configuration

Copy config.yml.template to config.yml and enter in the connection details for your outgoing mail server. Modify the participants and couples lists and the email message if you wish.

cd secret-santa/
cp config.yml.template config.yml

Here is the example configuration unchanged:

# Required to connect to your outgoing mail server. Example for using gmail:
# gmail
SMTP_SERVER: smtp.gmail.com
SMTP_PORT: 587
USERNAME: [e-mail]
PASSWORD: "your-password"

TIMEZONE: 'US/Eastern'

PARTICIPANTS:
  - name: Chad
    email: [e-mail]
    wish_list: amazon.com/something/something
    dont_pair:
    - Jen
  - name: Jen
    email: [e-mail]
    wish_list: amazon.com/something/something
    dont_pair:
      - Chad
  - name: Bill
    email: [e-mail]
    wish_list: amazon.com/something/something
    dont_pair:
      - Chad
  - name: Sharon
    email: [e-mail]
    wish_list: amazon.com/something/something
    dont_pair:
      - Bill

# From address should be the organizer in case participants have any questions
FROM: [e-mail]

# Both SUBJECT and MESSAGE can include variable substitution for the
# "santa" and "santee" as well "wish_list"
SUBJECT: Your secret santa recipient is {santee}
MESSAGE: "Dear {santa},


This year you are {santee}'s Secret Santa!. Ho Ho Ho!


The maximum spending limit is $50.00


Provided wish list information:


    {wish_list}

"

Usage

./secret_santa.py -h

usage: secret_santa.py [-h] [-l {debug,info,warning,error,critical}] [-f] [-s]

To use, fill out config.yml with your own participants. You can also specify DONT-PAIR so that people don't get assigned their significant other. You'll also need to specify
your mail server settings. An example is provided for routing mail through gmail. For more information, see README.

optional arguments:
  -h, --help            show this help message and exit
  -l {debug,info,warning,error,critical}, --log-level {debug,info,warning,error,critical}
                        Logging verbosity. Default: WARNING
  -f, --fake
  -s, --send

Once configured, call secret-santa:

$ ./secret_santa.py

Calling secret-santa without arguments will output a test pairing of participants:

    Test pairings:

    🎅          🎁
    Chad   ---> Bill
    Jen    ---> Sharon
    Bill   ---> Chad
    Sharon ---> Jen

To send out emails with new pairings, call with the --send argument:

$ ./secret_santa.py --send