Skip to content

Latest commit

 

History

History
99 lines (65 loc) · 3.96 KB

README.md

File metadata and controls

99 lines (65 loc) · 3.96 KB

zomato_email_alerts

Email alerts for negative reviews on Zomato. Checks for new reviews every Monday and Thursday and sends and email alert if negative reviews are present.

Everything gets logged in MySQL tables under database 'zomato_alerts'. Access table 'LOGS' to look at the logs generated while fetching, dumping and processing reviews. Access table 'REVIEWS' to look at reviews dumped for the restaurant IDs mentioned in the config file. Reviews are uniquely identified by a hash and a processed tag identifies if a review has already been processed. Each time the script is run, reviews are processed incrementally and it is made sure that already processed reviews are neither processed again nor are taken into consideration for sending alerts.

The email alert tells the percentage of negative reviews present in all the reviews that have been processed. The body of the email contains how many reviews were processed, number of reviews that were classified as negative, and a few negative reviews.

Dependency

  • python-pip

  • python-dev

  • libmysqlclient-dev

  • MySQL

    Please install and setup MySQL and use the username and password in the config file.

    Make sure mysql server is up and running before moving further.

Update config file

  • Get Zomato API key
  • Get SendGrid API key
  • Edit the config file and add the API keys
  • Add/Delete Zomato Restaurant IDs, if desired.
  • Edit the config file to change the email sender and recipient
  • Edit the config file to add MySQL username and password

Configure and setup the repository

Unix

Run the following commands on a Unix Shell

  • pip install virtualenv

Create a new virtual environment

  • python -m virtualenv </path/to/virtualenv/virtualenvname>
  • cd </path/to/virtualenv/virtualenvname>
  • source bin/activate

Copy the cloned repository in the virtualenv folder just created using the following -

  • cd <cloned_repository>/scripts

Copy the Sendgrid API key in the command below -

  • echo "export SENDGRID_API_KEY= '<YOUR_API_KEY>' " > sendgrid.env

  • crontab -e

    Copy and paste the following in the editor that opens up after editing wherever required. -

    MAILTO = ''

    0 0 * * 1,4 source </path/to/virtualenv/virtualenvname>/bin/activate

    0 0 * * 1,4 </path/to/virtualenv/virtualenvname>/bin/python </path/to/virtualenv/virtualenvname>/<cloned_repository>/scripts/get_reviews.py > /tmp/cron.log 2>&1

  • sudo apt-get install python-pip python-dev libmysqlclient-dev

  • pip install -r requirements.txt

  • python get_reviews.py

Windows

  • Set up a virtual environment and activate it.

  • Copy the cloned repository to the virtual env folder just created. Change to the scripts directory within the project.

  • Install the dependencies stated above.

  • Create a file named sendgrid.env and copy paste the following after inserting your SendGrid API key.

    export SENDGRID_API_KEY= '<YOUR_API_KEY>'

  • Install requirements.txt (pip install -r requirements.txt)

  • Set up a mechanism to run get_reviews.py periodically, within the virtual environment

  • Run the following command

    python get_reviews.py

MacOS

  • Set up a virtual environment and activate it.

  • Copy the cloned repository to the virtual env folder just created. Change to the scripts directory within the project.

  • Install the dependencies stated above.

  • Create a file named sendgrid.env and copy paste the following after inserting your SendGrid API key.

    export SENDGRID_API_KEY= '<YOUR_API_KEY>'

  • Install requirements.txt (pip install -r requirements.txt)

  • Set up a mechanism to run get_reviews.py periodically, within the virtual environment. Could setup crontab as mentioned in the Unix section above.

  • Run the following command

    python get_reviews.py

Enhancements

  • Fetch only new reviews from Zomato
  • Update the database with new reviews only
  • Improve the format of the SendGrid email body