Git Product home page Git Product logo

secret-santa's Introduction

Intro

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

pytz pyyaml

Usage

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: [email protected]
PASSWORD: "you're-password"

TIMEZONE: 'US/Pacific'

PARTICIPANTS:
  - Chad <[email protected]>
  - Jen <[email protected]>
  - Bill <[email protected]>
  - Sharon <[email protected]>

# Warning -- if you mess this up you could get an infinite loop
DONT-PAIR:
  - Chad, Jen    # Chad and Jen are married
  - Chad, Bill   # Chad and Bill are best friends
  - Bill, Sharon

# From address should be the organizer in case participants have any questions
FROM: You <[email protected]>

# Both SUBJECT and MESSAGE can include variable substitution for the 
# "santa" and "santee"
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


  This message was automagically generated from a computer. 

  Nothing could possibly go wrong...

  http://github.com/underbluewaters/secret-santa

Once configured, call secret-santa:

python 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:

        $ python secret_santa.py --send

To send the emails, call using the --send argument

python secret_santa.py --send

secret-santa's People

Contributors

underbluewaters avatar a-hammar avatar csg33k avatar

Watchers

 avatar James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.