ammirsm / llm-email-cleaner

LLM Email Cleaner

LLM Email Cleaner

In the digital age, one of the significant challenges we face is managing the overwhelming volume of emails in our inboxes. The task of cleaning and organizing these emails can be time-consuming and tedious. The LLM Email Cleaner project aims to address this issue by providing a tool that can efficiently clean up your cluttered inbox and organize your emails with an effective labeling system. The primary beneficiary of this project is myself, as I developed it to address my own needs. However, I believe that this tool can be beneficial to many others facing the same issue. Therefore, I have decided to make it open source, allowing others to use and contribute to it. This project is based on the Django framework. I will provide a video demonstrating how to run it on your local machine. For the LLM component, we will utilize fast and lightweight LLMs on the local machine, ensuring that no data is shared with external parties.

Getting Started

These instructions will get your copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

You need to have Python 3.9 installed on your machine. You also need pip for installing the dependencies. It usually comes with Python.

Installing

After cloning the repository and navigating into the directory, install the dependencies using pip: A step by step series of examples that tell you how to get a development environment running

pip install -r requirements.txt

Then, install the pre-commit hooks:

pre-commit install

Finally, run the migrations:

python manage.py migrate

Running the tests

python manage.py test

Running the server

python manage.py runserver

Run Celery:

celery -A core worker -P gevent -c 1000 --loglevel=info

Run Celery Beats:

celery -A core beat --loglevel=info

Deployment

Add additional notes about how to deploy this on a live system

-- TBD

Built With

• Django - The web framework used
• PostgreSQL - The database used

Contributing

TBD Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

TBD We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Amir Mehr - Initial work - ammirsm

See also the list of contributors who participated in this project.

License

TBD This project is licensed under the [LICENSE NAME] License - see the LICENSE.md file for details

Acknowledgments

TBD

What to run:

1. Add your account to database with scripts/add_your_account.py
2. Fill up messages table with scripts/fill_up_messages.py
3. Fill up messages data asynchronously with scripts/fill_up_messages_data.py

Remained TODOs

• Video Tutorial