kraemer-lab / vneyard

Repository for GRAPEVNE modules
MIT License
0 stars 2 forks source link

I11 - Add a general Email module #12

Closed jsbrittain closed 4 months ago

jsbrittain commented 8 months ago

Module can be used to send emails at various stages of a workflow. Credentials are provided by local file, and email transmission is triggered by the presence/arrival of a trigger-file which can be user configured.

To test the module:

To test the module in grapevne:

jsbrittain commented 4 months ago

I've updated the module to permit glob-matched email attachments, and to support monitoring of successive email 'triggers' to permit multiple sends (these are useful when monitoring long jobs); there is a test config file with short timeouts that can be run as snakemake --cores 4 --configfile config/config_test.yaml.

jsbrittain commented 4 months ago

Squashed the last two commits to remove email from the commit history.

jsbrittain commented 4 months ago

I know this has already been squashed and merged but I have added two relatively minor comments and, also, try as I might I can't get it to work in GRAPEVNE

@rowannicholls Thanks for taking a look at this - I think you've found an issue that was initially overlooked. Although everything seemed to work on my test-bed, trying it on a clean install did raise an unexpected issue when testing in GRAPEVNE (the email standard library module was not being bundled with the packaged python/snakemake environment). I will add this to the new PR.

In the meantime (and just for clarity) to test the module in grapevne:

Here's a screenshot of my setup:

Screenshot 2024-06-25 at 14 09 13