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.
First, you need to set up this Python environment:
- Download and Install Python 3.11 from the Python Foundation
- Clone this repository by clicking the Code button
- 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:
- Go to https://console.cloud.google.com/apis/credentials and log into your Google account
- Click
Create Credentials
and chooseOAuth client ID
- Set application type to
Desktop App
and set any name - Click
Download JSON
- Drag that file into the
Bitcamp2023
folder and rename it toclient_secret.json
After downloading and renaming the Google API credentials, you can now run the project!
- Make sure you are in the
Bitcamp2023
directory - Run
python src/EmailAhoy.py
- Enjoy defeating Email Pirates on the Digital Seas!
- 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
Images
- Swords
- Pirate Graphics Set 1
- Pirate Graphics Set 2
- Pirates of the Caribbean Characters
- Clouds
- Wallpaper
- Wallpaper 2
- Clouds
- Smoke
- [Parrot] (https://www.istockphoto.com/vector/parrot-pixel-icon-pixel-art-old-school-computer-graphic-8-bit-video-game-game-assets-gm941374558-257301971)
Font