https://github.com/ttwag/p7_good_morning

Automate Python to send a good morning email every day.
https://github.com/ttwag/p7_good_morning

api automation email-sender python scheduler

Last synced: 9 days ago
JSON representation

Automate Python to send a good morning email every day.

• Host: GitHub
• URL: https://github.com/ttwag/p7_good_morning
• Owner: ttwag
• Created: 2023-12-15T04:49:09.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2023-12-16T03:00:07.000Z (11 months ago)
• Last Synced: 2023-12-16T23:54:24.766Z (11 months ago)
• Topics: api, automation, email-sender, python, scheduler
• Language: Python
• Homepage:
• Size: 123 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# P7_Good_Morning

Automate Python to send a good morning email every day, and the email contains a quote fetched from API.

![Figure1](./Figure1.png)

## Installation

Simply clone the repository or download the zip file.

## How to Use This Program?

### Execution

To use this program to send the quote to a desired email address, you would need

to modify the following items in morning.py to: 

* ```"EMAIL_ADDRESS"```  -> the email address of the sender 

* ```"EMAIL_PASSWORD"``` -> the app password to log in to the sender's email account

* ```"RECEIVER"``` -> the receiver's email address

* ```"QUOTE_API"``` -> the API of the quote provider. I used https://api-ninjas.com/api/quotes.

### Schedule

I used the cron scheduler on macOS to schedule the task to run every morning.

To do so, open terminal and enter ```crontab -e```, then you would see the vim file editor.

This file contains all of your scheduled jobs.

To add one, click ```i``` on the keyboard to start editing and 

follow the template below: 

```

* * * * * command

* - minute (0-59)

* - hour (0-23)

* - day of the month (1-31)

* - month (1-12)

* - day of the week (0-6, 0 is Sunday)

command - command to execute

(from left-to-right)

```

For example, if I want to schedule morning.py to run every morning at 6:00 am on every day of the year, I would write

```0 6 * * * /opt/homebrew/bin/python3.11 $HOME/Desktop/Project/P7_Good_Morning/morning.py```

After the editing is done, hit ```etc``` then enter ```:wq``` to save and exit the vim editor.  

## Dependencies and File Structure

Running this program requires a python interpreter.

morning.py also depends on the **dotenv** library, so you may need to install it.

## Development Environment

This python code was developed using PycharmCE 2023.1.3, and the crontab was written through vim in macOS terminal.

## Note

If you use a gmail account to send the email, enable that gmail address to use app password to log in and input 

that app password to the program as stated in How to Use This Program section.