How meetbryce/open-source-slack-ai works
Project type and purpose
• This is a full-stack, event-driven Slack integration service (“The Open-Source Slack AI App”) written in Python.
• Its core purpose is to receive slash-command events and message events from Slack, summarize threads or channels using OpenAI (GPT-3.5/4) and spaCy, then post results back into Slack.
File structure
• Top-level:
• .github/, CONTRIBUTING.md, LICENSE.md, .gitignore, CI workflows (poetry-package.yml, python-app.yml)
• README.md, example.env, manifest.yaml, pyproject.toml, pytest.ini
• ossai/ – main application package
• tests/ – unit tests for each module
• Under ossai/:
• slack_server.py – FastAPI app that exposes HTTP endpoints Slack invokes
• handlers.py – Orchestrates command routing (thread summary, channel summary, etc.)
• summarizer.py & topic_analysis.py – Implements LLM calls and spaCy analysis
• slack_context.py – Wraps Slack WebClient for posting responses, rich attachments
• decorators/ – Error-handling (DM user on exception), PDF-conversion utilities
• utils.py & logging_config.py – Helper functions and logging setup
• No dedicated database; state is ephemeral or maintained by Slack.
README for additional insights
• Describes four main slash commands (/tldr_thread, /tldr_overview, /tldr_since, /tldr_extended).
• Shows technology stack: Python 3.9+, FastAPI (uvicorn), Poetry, OpenAI API, spaCy, Slack App.
• Specifies Slack App manifest (manifest.yaml) and use of ngrok for local tunneling.
Elements
• Labels: e.g., “Slack API”, “ngrok Tunnel”, “FastAPI Server”, “Handler Module”, “Summarizer Service”, “OpenAI API”
• Slack → FastAPI (webhook)
• FastAPI → Handler → Summarizer → OpenAI/spaCy → Handler → SlackContext → Slack
• Internal modules (FastAPI, handlers, summarizer) in another
• Cross-cutting utilities (decorators, utils) in a distinct style