avi10malhotra/pharmabot

INSY660 Group Project

PillPal

A Pharma Bot for Jean Coutu

---

Welcome to the readme file for the INSY660 Group Project.
This project is designed by:

Avi Malhotra

Syed Ammad Sohail

Moiz Shaikh

Here is a description of what each file does:

---

main.py

This is the main file that runs the program. It is the file that you should run to start the program.

This file contains evokes the functions for each of the 6 use cases demonstrated in the presentation/report. Please note that you may require Python version 3.10 or above to run this project.

---

availability.py

This file contains the function that checks the availability of a medicine in JC stores.

---

fetch_google_forms.py

This file uses the Google API client to extract information about a new user post-registration from Google sheets. Click here to access the registration form.

---

find_nearest_store.py

This file contains the function that finds the nearest JC store to the user's location. It uses the 'pgeocode' library to compute distances between postal codes.

---

google_client_id.json

This file contains the Google API client ID. It is required to run the program. Note that this file is not visible on GitHub for security reasons. However, it is included in the code submission.

---

LogicalModel JC.pdf

This file contains the logical model envisioned for this project (for the extra credit).

---

medicine_dataset.csv

The kaggle dataset used for this project

The dataset contains the following information for each drug:

Drug name

Adverse reactions and side effects

Drug interactions

Drug class

Substitute drugs

Active ingredients

Dataset Related Info.:

There are total of 5 substitutes columns in the dataset.

There are total of 41 Side Effects columns in the dataset. Drugs with less side effects have those columns as blank.

There are total of 5 usage columns in the dataset.

All other columns have their own individual identity.

---

order.py

This file is used to place an order for a medicine. It produces a text file containing the order details for each order.

---

order_details.txt

A sample text file containing the order details for a sample order.

---

prescription_refill.py

This file contains the function that refills a prescription for a user. It requires user authentication to refill an order.

---

README.md

This is the file you are reading right now! :D

---

recommendations.py

This file contains the function that recommends medicines and/or its substitutes to the user based on their symptoms. It uses the rake-nltk library to extract keywords from user input using natural language heuristics. RAKE stands for 'Rapid Automatic Keyword Extraction' and by considering co-occurrence information, the rake algorithm provides a more context-aware approach to keyword extraction.

This file also contains a function that searches the 'medicine_dataset.csv' for available medicine.

---

store_locations.py

This file contains a dictionary of the JC store locations in Montreal. The information is stored in key (zip code) value (address) pairs.

---

token.json

This file stores the user credentials. Note that this file is not visible on GitHub for security reasons. However, it is included in the code submission.

---

user_functions.py

This file contains two helper functions that are used to register a new user and to authenticate an existing user.

---

users.csv

This csv file is the database that stores all user information extracted from Google sheets.