Skip to content

malihass/SecretSanta

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

30 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SecretSanta SECRETSANTA-CI

Organize Secret Santa by email

Some key features

  • Email adresses are not shared to anyone
  • The host cannot see the result of the match-making
    • The send email are purged after match making
    • The results of the match making are logged (if needed) to pickle file
  • One can specify what match pairs to avoid (avoids having the same match pairs a few years in a row)
  • Partners receive a notification about match making pairs of interest to them so they can sync up their gift

Installing

  1. conda create --name secretSanta
  2. conda activate secretSanta
  3. pip install .

Quick start

  1. python main.py: outputs the match making result for a sample party

  2. Check the test suites in tests

Formatting Code style: black Imports: isort

Code formatting and import sorting are done automatically with black and isort.

Fix imports and format : pip install black isort; bash fixFormat.sh

Spelling is checked but not automatically fixed using codespell

TODO list

  • Add a web interface

Contact

Malik Hassanaly: (malik.hassanaly!at!gmail!com)

Senna Hassanaly: (senna.hassanaly!at!departmentofdogs!com)

About

Organize Secret Santa by email

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published