How matttimms/coles_vs_woolies works
This Python CLI compares grocery offers from Coles, IGA, and Woolworths, with search results available for display or as weekly email deals. The main flow is CLI request → concurrent merchant searches → normalized and similarity-ranked offers → optional email rendering and MailerSend delivery. Supporting layers provide cached HTTP sessions, product display, and date calculations. The README also documents cache clearing and scheduled weekly use. Edges are limited to relationships shown in excerpts, the source index, or README; unsampled details are not inferred.
Main entry points: search.py Product search · base.py Merchant models · __main__.py CLI commands · __init__.py Merchant registry
Components 19
CLI and search
- CLI commands
coles_vs_woolies/__main__.py - Product search
coles_vs_woolies/search.py
Merchant search
- Merchant registry
coles_vs_woolies/merchants/__init__.py - Merchant models
coles_vs_woolies/merchants/base.py - Coles adapter
coles_vs_woolies/merchants/coles.py - IGA adapter
coles_vs_woolies/merchants/iga.py - Woolworths adapter
coles_vs_woolies/merchants/woolworths.py
Weekly email
- Email workflow
coles_vs_woolies/emails/emails.py - Email rendering
coles_vs_woolies/emails/templates/main.py - MailerSend client
coles_vs_woolies/emails/providers/mailer_send.py
Shared utilities
- Cached HTTP session
coles_vs_woolies/utils/session.py - Week date helpers
coles_vs_woolies/utils/wednesday.py - Product similarity
coles_vs_woolies/utils/similarity.py - Result display
coles_vs_woolies/utils/display.py
Other components
- CLI user
- Coles API
- IGA API
- Woolworths API
- MailerSend
Connections 24
- CLI user → CLI commands: runs commands
README.md - CLI commands → Product search: runs search
coles_vs_woolies/__main__.py - CLI commands → Cached HTTP session: clears cache
coles_vs_woolies/__main__.py - CLI commands → Email workflow: runs email
README.md - Product search → Merchant registry: dispatches searches
coles_vs_woolies/search.py - Product search → Cached HTTP session: creates session
coles_vs_woolies/search.py - Product search → Result display: renders results
coles_vs_woolies/search.py - Merchant registry → Coles adapter: registers
coles_vs_woolies/merchants/__init__.py - Merchant registry → IGA adapter: registers
coles_vs_woolies/merchants/__init__.py - Merchant registry → Woolworths adapter: registers
coles_vs_woolies/merchants/__init__.py - Coles adapter → Merchant models: extends models
coles_vs_woolies/merchants/coles.py - IGA adapter → Merchant models: extends models
coles_vs_woolies/merchants/iga.py - Woolworths adapter → Merchant models: extends models
coles_vs_woolies/merchants/woolworths.py - Coles adapter → Coles API: queries
coles_vs_woolies/merchants/coles.py - IGA adapter → IGA API: queries
coles_vs_woolies/merchants/iga.py - Woolworths adapter → Woolworths API: queries
coles_vs_woolies/merchants/woolworths.py - Merchant models → Product similarity: scores matches
coles_vs_woolies/merchants/base.py - Merchant models → Result display: renders page
coles_vs_woolies/merchants/base.py - Email workflow → Product search: runs bulk search
coles_vs_woolies/emails/emails.py - Email workflow → Email rendering: generates HTML
coles_vs_woolies/emails/emails.py - Email workflow → MailerSend client: sends email
coles_vs_woolies/emails/emails.py - MailerSend client → MailerSend: delivers message
coles_vs_woolies/emails/providers/mailer_send.py - MailerSend client → Week date helpers: sets subject
coles_vs_woolies/emails/providers/mailer_send.py - Cached HTTP session → Week date helpers: sets expiry
coles_vs_woolies/utils/session.py