/Bitcamp2023

A repository for Bitcamp2023

Primary LanguagePythonMIT LicenseMIT

Email Ahoy!

logo

What is Email Ahoy!

Have you ever been overwhelmed by your overflowing inbox? So have we! We developed a companion for your email that incentivizes you to check it more often to defend your pirate friend from email attacks on your time and attention. Fend off email pirates and get your doubloons up with Email Ahoy. We used the Google gmail API so you can protect your inbox in real time.

Developed By

How to Install

First, you need to set up this Python environment:

  1. Download and Install Python 3.11 from the Python Foundation
  2. Clone this repository by clicking the Code button
  3. Set up a virtual environment.
    • Open the directory of this repository on your local machine
    • Run python3.11 -m venv .venv, which creates a new virtual environment
    • Run source .venv/bin/activate, which uses the virtual environment
    • Run pip install -r requirements.txt, which installs the required libraries

After setting up a virtual environment, you have to create a Google Developer application. To do this, do the following:

  1. Go to https://console.cloud.google.com/apis/credentials and log into your Google account
  2. Click Create Credentials and choose OAuth client ID
  3. Set application type to Desktop App and set any name
  4. Click Download JSON
  5. Drag that file into the Bitcamp2023 folder and rename it to client_secret.json

After downloading and renaming the Google API credentials, you can now run the project!

  1. Make sure you are in the Bitcamp2023 directory
  2. Run python src/EmailAhoy.py
  3. Enjoy defeating Email Pirates on the Digital Seas!

How to Use

  • After you've linked your email, open the app and see how many unread emails you have
  • As emails come in, pay attention to the enemies coming your way and read your emails to protect your pirate

Assets Used

Images

Font