Skip to content

adampao/GmailSumm

Repository files navigation

Gmail Summarizer - AI-Powered Email Processing ⚡

Production-ready AI email summarizer with cross-platform support and privacy-first local processing options.

🚀 Quick Start

Download & Run (Recommended)

  1. Download ZIP package for your platform:

    • macOS: GmailSumm-macOS.zip
    • Windows: GmailSumm-Windows.zip
    • Linux: GmailSumm-Linux.zip
  2. Extract and run:

    • macOS/Linux: Double-click GmailSumm executable
    • Windows: Double-click GmailSumm.bat
  3. Access in browser: Opens automatically at http://localhost:5001

Developer Setup

git clone [your-repo-url]
cd GmailSumm
source venv/bin/activate  # On Windows: venv\Scripts\activate
python main.py

⚙️ Configuration

Gmail API Setup

  1. Create Google Cloud Project
  2. Enable Gmail API
  3. Create OAuth 2.0 credentials (Web application)
  4. Add credentials through the app's Gmail setup modal

AI Providers (Choose One or More)

  • 🔓 Ollama: 100% local processing (no API key needed)
  • 🧠 Claude: Best quality summaries (sk-ant-...)
  • ⚡ OpenAI: Fast and reliable (sk-...)
  • 🔍 Gemini: Google's AI model (API key)
  • 🚀 Grok: xAI alternative (xai-...)

✨ Features

✅ Working Features

  • Multi-AI Provider Support: Switch between Claude, OpenAI, Gemini, Grok, Ollama
  • Smart Email Filtering: All emails, newsletters, work, personal, custom workflows
  • Export Options: Markdown, JSON, CSV, TXT, Word formats
  • Scan History: Track and revisit past summaries with pagination
  • Gmail OAuth Integration: Secure authentication with Google
  • Privacy Mode: Local processing with Ollama (no data leaves your computer)
  • Cross-Platform: Works on macOS, Windows, Linux

🎨 UI Features

  • Professional Interface: Clean, modern design
  • Real-time Progress: Live scanning feedback
  • Persistent Settings: API keys and preferences saved
  • Responsive Design: Works on desktop and mobile browsers
  • Error Handling: Clear, helpful error messages

🔒 Privacy & Security

  • Local Processing: Ollama keeps all data on your computer
  • Secure Storage: API keys saved in .env files
  • Gmail Read-Only: Never modifies your emails
  • No Telemetry: No usage tracking or data collection

📁 Project Structure

GmailSumm/
├── main.py                 # Flask application entry point
├── requirements.txt        # Python dependencies
├── dist/                   # Distribution packages
├── packaging/              # Platform-specific launchers
├── src/                    # Core Python modules
├── static/                 # Web assets (CSS, JS)
├── templates/              # HTML templates
├── routes/                 # Flask API routes
├── config/                 # Configuration files
└── utils/                  # Utility functions

🎯 Use Cases

  • Content Creators: Summarize industry newsletters efficiently
  • Busy Professionals: Process email overload with AI assistance
  • Researchers: Extract key insights from email subscriptions
  • Privacy-Conscious Users: Local processing with Ollama option

🛠️ Technical Details

  • Backend: Python Flask with Socket.IO for real-time updates
  • Frontend: Modern HTML/CSS/JavaScript with responsive design
  • AI Integration: Multi-provider support with fallback chains
  • Email Processing: Gmail API with OAuth 2.0 authentication
  • Export Engine: Multiple format support with smart content formatting

📊 Development Status

✅ Production Ready - All critical issues resolved:

  • API key persistence across provider switches
  • Cross-provider contamination eliminated
  • Error handling improved
  • UI/UX polished
  • Cross-platform packages tested

📞 Support

  • Issues: Create GitHub issue with details
  • Features: Submit feature request via issues
  • Questions: Check documentation first

Created by Adam VisuAl+ - Professional AI-powered productivity tools