Skip to main content

Rule-based daily Gmail inbox triage. Zero LLM, read-only, Windows-friendly.

Project description

morning-brief

PyPI Python License codecov

Rule-based daily Gmail inbox triage. Zero LLM, read-only, Windows-friendly.

Classifies recent mail into HIGH / MEDIUM / LOW / SPAM from a YAML rules file, writes a markdown digest, and pops a desktop toast. Scan your inbox in thirty seconds instead of thirty minutes.

Why not an LLM-based tool

Paid-LLM triage tools like mailtrim and gmail-digest work, but cost money per run and fail silently when the API is down. For a personal inbox, most of the signal lives in sender domain plus a handful of subject keywords. Rules handle that case reliably and for free.

Install

pip install morning-brief

Windows users also want the toast helper:

pip install "morning-brief[windows]"

One-time setup

  1. Create a Google Cloud project, enable the Gmail API, create an OAuth 2.0 Client ID of type Desktop app, and download the JSON as credentials.json.
  2. Run morning-brief init to scaffold ~/.morning-brief/.
  3. Drop credentials.json into ~/.morning-brief/.
  4. Edit ~/.morning-brief/rules.yaml to match your senders.
  5. Run morning-brief run. First run opens your browser for read-only consent and writes token.json locally.

Sub-day windows

morning-brief run --hours 4    # last four hours instead of last day
morning-brief run --hours 1    # quick post-lunch sweep

--hours overrides the default --days 1. Maps directly to Gmail's newer_than:Nh query.

Thread collapse

Conversations that fan out across many messages collapse to one digest entry annotated with (N msgs). On by default; pass --no-collapse-threads to keep the v0.2.0 one-line-per-message behaviour.

Debug your rules

morning-brief preview --sender "hr@canonical.com" --subject "Interview Tuesday"
# Bucket: HIGH
# Reason: high_sender:@canonical.com

morning-brief why <message-id>
# From:    notifications@github.com
# Subject: Review requested on PR #42
# Stored:  HIGH
# Now:     HIGH
# Reason:  high_keyword:review requested

preview answers "what would happen if I added this rule?" without calling Gmail. why looks up a stored message and shows whether your current rules.yaml would still classify it the same way.

Daily run

Windows Task Scheduler, WSL cron, or macOS launchd can each fire the command once a day at 8am.

Windows Task Scheduler: create a basic task triggered daily at 08:00 running morning-brief run.

WSL cron:

0 8 * * * /home/you/.local/bin/morning-brief run >> /tmp/morning-brief.log 2>&1

For toast notifications from WSL cron, install wsl-notify-send; morning-brief will pick it up automatically.

Rules

rules.yaml uses case-insensitive substring matching. The starter generated by morning-brief init covers GitHub notifications, common spam patterns, and a placeholder high-priority sender list.

Classification precedence: spam wins first, then high, then github-low, then medium (default).

Scope

  • Read-only Gmail access. The tool never marks, labels, moves, or deletes mail.
  • Writes digests to ~/.morning-brief/digests/YYYY-MM-DD.md.
  • Tracks processed message IDs locally for 7 days so reruns are idempotent.

Status

Alpha. Classifier is covered by unit tests; integration tests for the Gmail client come next.

License

MIT.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

morning_brief-0.3.0.tar.gz (16.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

morning_brief-0.3.0-py3-none-any.whl (15.0 kB view details)

Uploaded Python 3

File details

Details for the file morning_brief-0.3.0.tar.gz.

File metadata

  • Download URL: morning_brief-0.3.0.tar.gz
  • Upload date:
  • Size: 16.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for morning_brief-0.3.0.tar.gz
Algorithm Hash digest
SHA256 d5e84aa1e0b815fc105e828b8334bd0ed9317b0fee8a743e9a88639019a59548
MD5 2966211db8e71533ca7ae39b351bc6e5
BLAKE2b-256 8b9d6b3fb5be8a1bf427842123092cacd8eb4d50de5832fb3b4d014dafa2cfb7

See more details on using hashes here.

File details

Details for the file morning_brief-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: morning_brief-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 15.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for morning_brief-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 fd6caca14b0de2dc8106893001edcc20ccf1ec8b12c05c29fd26859ce310c720
MD5 1c74d1b2e4c9eb5fdf64ad5901a107a7
BLAKE2b-256 e7dd2dc1cff7713907c0448a8b01e0a9392caef6a2024e0c57f0b9877994b82f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page