Automatically send your attestation letters.

To install, clone this repository:

git pull https://github.com/GuignardLab/attestation.git

and then run:

cd attestation
pip install -e .

Warning 1: You have to have install pdflatex as a command line

Warning 2: You have to use -e to be able to easily modify src/attestation/_template.py (see below). If you don't want to use -e you'll have to pip install . each time you change the template file

After installation you need to modify the first lines of the file src/attestation/_template.py. You will want to modify PI_name, role, address, and you might want to inform signature_path and logo_path as absolute paths.

Setting signature_path or logo_path to the empty string will ignore them.

Once you have modified these variables you can ran the script as follow:

send-attestation --name Name Surname

with Name and Surname being the ones of the student you want to send the attestation for.

By default, the email is sent to the two concerned HR people (Marlène & Jasmina). You can change that with the following command line:

send-attestation --name student_name student_surname --recipients [email protected] [email protected]

Few other parameters can be changed, running the following:

send-attestation --help

which will give you the following:

usage: send-attestation [-h] [-n NAME [NAME ...]] [-g {m,f}] [-t SMTP] [-p PORT] [-u USERNAME]
                        [-r RECIPIENTS [RECIPIENTS ...]] [-ld LAST_DAY] [-ns] [-k] [-pdf PDF_FILE]

Building and sending an "attestation de présence"

optional arguments:
  -h, --help            show this help message and exit
  -n NAME [NAME ...], --name NAME [NAME ...]
  -g {m,f}, --genre {m,f}
  -t SMTP, --smtp SMTP  smtp (default LIS)
  -p PORT, --port PORT  port for email (default 587)
  -u USERNAME, --username USERNAME
                        account for email (default leo.guignard)
  -r RECIPIENTS [RECIPIENTS ...], --recipients RECIPIENTS [RECIPIENTS ...]
                        email where to send the letter (default [email protected] & [email protected])
  -ld LAST_DAY, --last-day LAST_DAY
                        Last day of the stay
  -ns, --no-send        Add this flag to not send the email
  -k, --keep-pdf        Add this flag to keep the generated pdf
  -pdf PDF_FILE, --pdf-file PDF_FILE
                        Path and name of the generate pdf file if kept (ignore if the flag kept-pdf is not present)

should inform you about the possibilities.

The whole script can also be ran programatically the following way:

from attestation import send_attestation

send_attestation(
    name, # Name of the student as a string
    recipients, # List of email addresses
    genre, # Wheter you need "étudiant" or "étudiante"
    day, # Last day of the stay of the student if it is not the end of the month
    smtp_server, # Smtp server to send (optional, default LIS)
    smtp_port, # Smtp port to send (optional)
    smtp_username, # Username for the smtp server
    send, # Bool whether to send or not the email
    keep, # bool whether to keep or not the generated pdf
    pdf_file, # where to save the pdf if saved
)

Typing send_attestation? should also give you a bit more information.

Contributions are very welcome. Tests can be run with tox, please ensure the coverage at least stays the same before you submit a pull request.

Distributed under the terms of the MIT license, "attestation" is free and open source software

If you encounter any problems, please file an issue along with a detailed description.

This library was generated using Cookiecutter and a custom made template based on @napari's cookiecutter-napari-plugin template.