README.md

Inbox Cleaner

This script helps manage a Gmail inbox by filtering out promotional emails using GPT-3 or GPT-4.

Prerequisites

• Python 3.7 or higher
• Gmail account
• Google Cloud account with Gmail API enabled
• OpenAI API key

Setup

1. Clone this repository:

   git clone https://github.com/isafulf/inbox_cleaner.git
   cd inbox_cleaner
   

2. Install the required Python packages:

   pip install -r requirements.txt
   

3. Set up your Google API credentials:

   • Follow the instructions here to create a new OAuth 2.0 Client ID.
   • Download the JSON file and rename it to credentials.json.
   • Put credentials.json in the inbox_cleaner directory.

4. Set up your OpenAI API key:

   • Follow the instructions here to get your OpenAI API key.

   • Set the key as an environment variable:

     export OPENAI_API_KEY=<your_openai_api_key>
     

Usage

Run the script:

python process_all_unread_emails.py

When prompted, enter your first and last name. The script will then start processing your unread emails.