GPT-Gmail

A tool to categorize, summarize, and manage gmail inboxes
Explore the docs »

· Report Bug · Request Feature

Table of Contents

1. Getting Started
   • Prerequisites
   • Installation
2. Usage
3. Roadmap
4. Contributing
5. License
6. Contact
7. Acknowledgments

About The Project

This project was created for me to familizarize myself with the OpenAI API as well as Google's Gmail API. I wanted to create a tool to help me auto organize my emails in a way that was concise and easy to read. This can be done with a variety of options like autocategorizing below. Here is an example output, this is after the emails are categorized and flagged as important.

(back to top)

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

• python3

Installation

1. Get an API Key at https://platform.openai.com/api-keys
2. Create a .env file with the following:

   OPENAI_KEY='YOUR KEY'

3. Install python packages

   pip install -r requirements.txt

4. Run the program!

   python main.py

(back to top)

Usage

This project should be used as a personal tool to make going through your emails easier.

(back to top)

Roadmap

• Daily summary feature: create a daily summary of the most important emails and email it to your account
• More settings: allow each profile to customize their settings
  • Allow each profile to control how far back emails are feteched, two days, one week, etc.
  • Allow for custom categorization labels, users can organize emails into their own categories
• More categorizing options:
  • Let the program automatically move irrelevant emails out of primary
  • Let the program automatically check important emails and recategorize if they are irrelevant

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Ryan Wong - [email protected]

Project Link: Repo

(back to top)

Acknowledgments

(back to top)