EchoScribe

✨ Features

🚀 Quick Start

Installation

# Clone the repository
git clone https://github.com/hatimhtm/EchoScribe.git
cd EchoScribe

# Install with pip
pip install -e .

# Or with Docker
docker build -t echoscribe .

Configuration

# Required
export SLACK_API_TOKEN="xoxb-your-slack-bot-token"
export OPENAI_API_KEY="sk-your-openai-api-key"
export GOOGLE_APPLICATION_CREDENTIALS="/path/to/credentials.json"

# Optional
export SLACK_CHANNEL="#meeting_recordings"
export OPENAI_MODEL="gpt-3.5-turbo"
export LOG_LEVEL="INFO"

Usage

# Check configuration
echoscribe check-config

# Transcribe an audio file
echoscribe transcribe recording.wav -o transcript.txt

# Summarize a transcription
echoscribe summarize transcript.txt --slack

# Full pipeline: transcribe + summarize + post to Slack
echoscribe process recording.wav --channel "#team-meetings"

📁 Project Structure

echoscribe/
├── __init__.py           # Package exports
├── config.py             # Configuration management
├── cli.py                # Typer CLI commands
├── services/
│   ├── transcription.py  # Google Cloud Speech-to-Text
│   ├── summarization.py  # OpenAI summarization
│   ├── slack.py          # Slack integration
│   └── recorder.py       # Audio recording
└── utils/
    └── __init__.py

tests/
├── test_config.py        # Configuration tests
└── test_summarization.py # Summarization tests

🔧 Development

# Install dev dependencies
pip install -e ".[dev]"

# Run tests
pytest

# Run with coverage
pytest --cov=echoscribe

# Format code
black echoscribe tests
ruff check echoscribe tests

🐳 Docker

# Build image
docker build -t echoscribe .

# Run with environment variables
docker run --rm \
  -e SLACK_API_TOKEN="xoxb-..." \
  -e OPENAI_API_KEY="sk-..." \
  -e GOOGLE_APPLICATION_CREDENTIALS="/creds/key.json" \
  -v /path/to/creds:/creds:ro \
  -v /path/to/audio:/audio:ro \
  echoscribe process /audio/meeting.wav

📋 API Reference

SummarizationService

from echoscribe.services.summarization import SummarizationService

service = SummarizationService(api_key="sk-...")
summary = service.summarize("Meeting transcription text...")

print(summary.summary)        # Brief summary
print(summary.action_items)   # List of action items
print(summary.key_points)     # Key discussion points

TranscriptionService

from echoscribe.services.transcription import TranscriptionService

service = TranscriptionService(language_code="en-US")
result = service.transcribe("meeting.wav")

print(result.text)        # Transcribed text
print(result.confidence)  # Confidence score

SlackService

from echoscribe.services.slack import SlackService

slack = SlackService(token="xoxb-...")
slack.post_message("Hello, team!", channel="#general")
slack.upload_file("report.pdf", title="Meeting Report")

📄 License

👤 Author