A personal or professional email signature generator.
- Python 3.11 or higher
- An editor that supports yaml files like Visual Studio Code.
- An editor that supports HTML and XML files like NotePad on Windows or TextEdit on MacOs (with the option to display the code activated).
To use this template, you can either download the zip file or clone the repository:
git clone https://github.com/MorganKryze/Email-Signature-Generator.git
In addition, you will need to install the following libraries in your python environment:
cd Email-Signature-Generator
pip install -r requirements.txt
Once installed, it's pretty much it, just edit the options.yml
file to your liking and execute this command to apply your changes:
python src
To change the photo displayed in the signature, just replace the link with your own link, or the path to your custom image in the assets
folder. (I recommend using 120px by 120px images or svg files)
logo: https://raw.githubusercontent.com/MorganKryze/Email-Signature-Generator/main/src/assets/icons/fablab.svg
#photo: https://raw.githubusercontent.com/MorganKryze/Signature-Generator/main/src/assets/default.jpg
Note
You can switch between a photo or a logo by commenting out the line you don't want to use with a #
. Even more, if you do not want any of these, just comment out both lines.
Warning
the photo will be displayed by default if both are uncommented.
Here, DO NOT put a #
at the beginning of the lines, just replace the text with your own. The organization url will be put in the logo and the email will be put in the mailto link.
name: Your name
title: Your title
organization_name: Your organization
organization_url: https://example.com
workplace: Your workplace address
email: address@example.com
To change the social media links, just replace the links with your own. If you don't want to display a social media, just comment it out with a #
or replace the link with None
.
social_media:
website: https://example.com
github: https://github.com/example
# instagram: https://instagram.com/example
linkedin: https://linkedin.com/in/example
slack: https://slack.com/example
facebook: https://facebook.com/example
youtube: None
twitter: https://twitter.com/example
Note
You can switch the order of the social media by changing the order of the lines.
- Website
- Github
- Slack
- Youtube
This project is licensed under the MIT License - see the LICENSE.md file for details.