Welcome to the Automatic Birthday Wisher through Email! This project sends personalized birthday wishes via email, ensuring that your friends and loved ones always feel special on their special day.
- Automated Emails: Sends personalized birthday greetings automatically.
- Customizable Messages: Modify the message content to suit your style.
- Scheduling: Set specific times for the emails to be sent.
- Secure: Uses environment variables to keep email credentials safe.
To run this project, you'll need the following:
- Python 3.7 or later
- An email account (Gmail, Outlook, etc.)
- A list of contacts with their birthdays and email addresses
-
Clone the repository:
git clone https://github.com/your-username/automatic-birthday-wisher.git cd automatic-birthday-wisher
-
Install the required packages:
pip install -r requirements.txt
-
Set up environment variables: Create a
.env
file in the root directory with the following content:EMAIL_HOST=smtp.your-email-provider.com EMAIL_PORT=your-email-port EMAIL_ADDRESS=your-email@example.com EMAIL_PASSWORD=your-email-password
Note: Use a dedicated email account or an app-specific password for security.
-
Prepare your contact list: Create a
contacts.csv
file with the following format:name,email,year,month,day Test,test@email.com,1983,06,01 [Fill this in!]
-
Customize your message: Edit the letter templates to personalize the email content.
To run the birthday wisher, use the following command:
python main.py
This will send out emails to the contacts whose birthdays match the current date.
For any questions, feel free to reach out:
- Email: shyamkolisetty@gmail.com
- GitHub: @Shyam-18
Feel free to adjust the sections and content to better fit your project specifics. The key is to provide clear instructions and make the README user-friendly.