Skip to content

README.md

Latest commit

 

History

History
266 lines (192 loc) · 6.36 KB

README.md

File metadata and controls

266 lines (192 loc) · 6.36 KB

Meeting Analyzer

An automated meeting analysis tool that transcribes audio, identifies speakers, extracts action items, and generates detailed reports with personalized email distribution.

Features

  • 🎙️ Audio transcription using Whisper
  • 👥 Speaker identification and verification
  • ✅ Action item and task extraction
  • 📊 Markdown + PDF meeting report generation
  • 📧 Email distribution of personalized summaries
  • 👤 Speaker profile management (with email memory)
  • 🔐 .env support for secure API key + credentials
  • 🌐 Ready for n8n automation via webhooks (coming soon)

🔧 Prerequisites

  1. Python 3.10.9 or later
  2. FFmpeg installed and available in PATH
  3. wkhtmltopdf for PDF generation
  4. OpenAI API key
  5. Gmail account with App Password for email sending

📦 Installation

1. Clone the repository

git clone https://github.com/your-username/meeting-analyzer.git
cd meeting-analyzer

2. Set up a virtual environment

python -m venv whisper-env
.\whisper-env\Scripts\activate  # Windows
source whisper-env/bin/activate  # Linux/Mac

3. Install dependencies

pip install -r requirements.txt

4. Install wkhtmltopdf

  • Download and install: wkhtmltopdf
  • Add the install folder (e.g., C:\Program Files\wkhtmltopdf\bin) to your system PATH

🔐 Configure Credentials

Option 1: Using .env (Recommended)

  1. Copy and rename .env.example:
cp .env.example .env
  1. Open .env and fill in:
OPENAI_API_KEY=your-openai-key
EMAIL_USERNAME[email protected]
EMAIL_PASSWORD=your-app-password
FROM_EMAIL[email protected]
SMTP_SERVER=smtp.gmail.com
SMTP_PORT=587

✅ .env is ignored by Git and keeps your keys safe.

🧠 Usage

▶️ Option 1: Batch Files (Windows only)

run_meeting.bat

Runs the full analysis pipeline with default audio file (Senior Project Demo.mp3)

.\run_meeting.bat

🐍 Option 2: Python Execution (More flexible)

Activate your environment:

.\whisper-env\Scripts\activate

Then run:

python meeting_analyzer.py "your_audio.mp3"

Optionally add:

--email-config email_config.json

Will use .env values unless overridden with --email-config

📁 Output Files

  • meeting_report.md → Markdown summary
  • meeting_report.pdf → Printable version
  • full_transcript.txt → Raw transcript
  • segments.json → Timestamped segments
  • meeting_analysis.log → Execution logs
  • individual_summaries/ → Per-speaker task summaries

⚙️ Key Config Files

File Purpose
.env Main API + email config (recommended)
.env.example Template for .env setup
email_config.json Optional legacy email config
attendees_db.json Stores speaker names + emails
requirements.txt Python dependencies

🔐 Security Notes

  • ✅ .env is excluded from Git
  • ❌ Never commit your credentials
  • 🔒 Use Gmail App Passwords (not your main password)
  • 🔄 You can remove email_config.json if .env is used

🔮 Roadmap (Coming Soon)

  • 🌐 n8n integration via webhooks + JSON payloads
  • 🧠 AI task suggestion templates
  • 🔁 Audio highlight replays
  • 🧑‍💼 Dashboard summaries per participant
  • 📎 Google Calendar or Notion integration

🛠️ Troubleshooting

Issue Fix
❌ PDF not generated Ensure wkhtmltopdf is installed + in PATH
❌ Emails not sending Check app password + Gmail 2FA enabled
❌ Transcription error Check ffmpeg is installed + audio format
❌ Batch file fails Use full path, run as admin if needed

🤝 Contributing

Pull Requests are welcome!
Want to add integrations or custom formats? Fork and build on top!

📜 License

MIT or your license here

📬 Contact

Brendan Bryan & Brian Ford

📄 Email Configuration Options

You have two ways to configure email settings:

  1. Using Environment Variables (Default):
python meeting_analyzer.py "Senior Project Demo.mp3"

This will use the email credentials from your .env file:

  • EMAIL_USERNAME: Your Gmail address
  • EMAIL_PASSWORD: Your Gmail app password
  1. Using JSON Configuration File:
python meeting_analyzer.py "Senior Project Demo.mp3" --email-config email_config.json

This will use settings from email_config.json:

{
    "smtp_server": "smtp.gmail.com",
    "smtp_port": 587,
    "sender_email": "[email protected]",
    "sender_password": "your-app-password"
}

Key Differences:

  • Environment variables are more secure (not stored in files)
  • JSON config is more portable and can be version controlled (without credentials)
  • Using --email-config will try JSON first, then fall back to environment variables if needed
  • The batch file run_meeting.bat uses the JSON config approach

Quick Start

  1. Using the batch file (recommended):
.\run_meeting.bat
  1. Manual execution with environment variables:
python meeting_analyzer.py "Senior Project Demo.mp3"
  1. Manual execution with JSON config:
python meeting_analyzer.py "Senior Project Demo.mp3" --email-config email_config.json

Features

  • Automatic speech-to-text transcription using Whisper
  • Speaker identification and verification
  • Action item extraction
  • Task assignment tracking
  • Automated email summaries to participants
  • PDF and Markdown report generation

Output Files

  • meeting_report.md: Detailed meeting summary in Markdown format
  • meeting_report.pdf: PDF version of the meeting summary
  • full_transcript.txt: Complete meeting transcript
  • segments.json: Detailed segment-by-segment analysis

Troubleshooting

  1. Email Configuration:

    • If using environment variables, check your .env file
    • If using JSON config, verify email_config.json exists and is properly formatted
    • Make sure you're using an App Password for Gmail

  2. Common Issues:

    • "EmailConfig not defined": Make sure you're using the latest version of the code
    • Email authentication errors: Check your credentials and App Password
    • PDF generation fails: Install wkhtmltopdf if not already installed

Contributing

Feel free to submit issues and enhancement requests!