Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
3. ReST Endpoints

About The Project

This repository serves as a microservice built to send a notification email to a student after an instructor leaves feedback for a project.

Built With

• Python - 3.9.5
• PostgreSQL
• Postman

Getting Started

1. Clone this repo
2. Install dependencies: pip3 install -r requirements.txt
3. Local development needs an API key https://sendgrid.com/docs/api-reference/
4. Update your environment with your API key

$echo "export SENDGRID_API_KEY='YOUR_API_KEY'" > sendgrid.env
$echo "sendgrid.env" >> .gitignore
$source ./sendgrid.env

7. Start flask server

#local development server
 $python3 run.py
#production server
 $ gunicorn run:app

Prerequisites

• Python 3.9.5

Endpoints

ReST Endpoints

Put Email

PUT /api/v1/email

• Sends Email to the recipient with the corresponding subject and content. Required parameters to be sent in body request as JSON.

Required Body:

 {
  "to": "test@example.com",  
  "subject": "Test", 
  "content": "This is a test"
  }