Skip to content

kmzer06/Ai-Email-Summuriser

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

AI Task Assistant

Email triage + PDF/folder summarization + daily digest generator, with optional OpenAI-powered summaries.

Features

  • Fetch recent emails over IMAP (e.g., Gmail).
  • Extract text from PDF attachments and include in summaries.
  • Summarize a single PDF or recursively summarize a folder of PDFs.
  • Optional OpenAI summarization (Api Key required)
  • Basic action item detection from email/document text.

Quick Start

  1. Create & activate a virtual environment
python -m venv .venv
# Windows
.\.venv\Scripts\activate
# macOS/Linux
source .venv/bin/activate
  1. Install requirements
pip install -r requirements.txt
  1. Configure environment
  • open.env and set values. For Gmail IMAP:
    • Turn on 2FA in Google Account.
    • Create an App Password (Mail / your device) and use it as IMAP_PASSWORD.
    • Set IMAP_HOST=imap.gmail.com.
  1. Run examples
# Summarize recent unread emails (top 10) into out/digest_*.md
python -m src.main inbox --unread true --max 10 --out out

# Include PDF attachments parsing + OpenAI summarization if key present
python -m src.main inbox --unread true --max 10 --out out --parse-pdf-attachments

# Summarize a single PDF
python -m src.main pdf --pdf path/to/file.pdf

# Summarize all PDFs in a folder into one digest
python -m src.main folder --folder path/to/folder --out out

# Combined: emails + PDFs into one digest
python -m src.main digest --folder resources/pdfs --max 5 --openai --out out

Notes

  • Keep within your mail provider's usage policies.
  • Output lives in out/ and includes both Markdown and JSON digests.

About

Summarise emails and gives you important parts

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages