Overview

Here is a small project to send e-mails for a friendly Secret Santa. It is working in python3 and use a personnal e-mail and password to send them. Have a look to Credits to see the repos who made it possible.

Getting Started

Begin by cloning this repository using :

git clone git@github.com:lmunier/secret_santa.git

Assuming you already have python3 installed

Recommended - Source the virtual environment using :

source .venv/bin/activate

Not Recommended - Installing python packages on host computer :

pip install -r requirements.txt

Run

First of all, to use custom data, change the private_folder configuration inside global_config file.

Then simply use python3 command to run main.py and follow the instructions. You have to fill the correct files to have a custom behavior, see the folder example to check all the files to modify.

Usage

To use this project, modify the global_config.yaml file to include your private folder path. Take a look in the example folder to know the arborescence and what to put in your config.yaml file.

Credits

This repo do use the library ruamel.yaml to manage YAML v1.2 files which is Licensing as MIT license : ruamel

It also use the library which is under BSD-3-Clause license reportlab

License

This work can be used under BSD-3-Clause License, see file LICENSE.

Maintainers

• Louis Munier - lmunier@protonmail.com