# howie6879/weekly architecture

> Architecture diagram of the GitHub repository howie6879/weekly, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-01). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/howie6879/weekly
- Repository: https://github.com/howie6879/weekly

## Overview

This repository is a curated technology-resource weekly: the editor records and organizes recommendations, which are retained as Markdown and a SQLite database, then exposed through the website, RSS, a randomized “today’s recommendation,” and Telegram. The sampled code confirms database ingestion and several output paths; README documents the reader-facing channels. Some website publishing mechanics and unsampled subsystems are not shown, so their internal wiring is omitted.

Main entry points: [`docs/2025`](https://github.com/howie6879/weekly/tree/main/docs/2025) (Weekly Markdown), [`main.py`](https://github.com/howie6879/weekly/blob/main/main.py) (Update runner), [`src/db.py`](https://github.com/howie6879/weekly/blob/main/src/db.py) (Markdown ingestion), [`src/rss.py`](https://github.com/howie6879/weekly/blob/main/src/rss.py) (RSS feed)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_content["Editorial content"]
  node_weekly_md["Weekly Markdown"]
end

subgraph group_data["Storage and reuse"]
  node_intake["Markdown ingestion<br/>[db.py]"]
  node_weekly_db[("Weekly database<br/>[weekly.db]")]
  node_bootstrap["Update runner<br/>[main.py]"]
  node_export["JSON export<br/>[export_data.py]"]
end

subgraph group_channels["Reader channels"]
  node_randomizer["Today recommendation<br/>[random_weekly.py]"]
  node_site["Weekly website<br/>[index.md]"]
  node_rss["RSS feed<br/>[rss.py]"]
  node_sitemap["Sitemap generation<br/>[gen_sitemap.py]"]
  node_pdf["PDF compilation<br/>[gen_pdf.py]"]
end

subgraph group_delivery["Sharing"]
  node_telegram_parser["Telegram item parser<br/>[tg_utils.py]"]
  node_telegram_sender["Telegram sender<br/>[tg_sender.py]"]
end

node_editor(("Editor"))
node_telegram(("Telegram channel"))
node_reader(("Reader"))
node_submitter(("Resource submitter"))

node_editor -.->|"edits issues"| node_weekly_md
node_weekly_md -->|"parses entries"| node_intake
node_bootstrap -->|"runs ingestion"| node_intake
node_intake -->|"writes records"| node_weekly_db
node_export -->|"loads records"| node_weekly_db
node_randomizer -->|"queries items"| node_weekly_db
node_randomizer -->|"writes recommendation"| node_site
node_weekly_md -->|"reads issues"| node_rss
node_bootstrap -->|"runs generation"| node_rss
node_weekly_md -->|"compiles issues"| node_pdf
node_bootstrap -->|"imports generator"| node_sitemap
node_telegram_parser -->|"supplies items"| node_telegram_sender
node_telegram_sender -->|"sends messages"| node_telegram
node_site -.->|"serves content"| node_reader
node_rss -.->|"provides feed"| node_reader
node_telegram -.->|"shares updates"| node_reader

click node_weekly_md "https://github.com/howie6879/weekly/tree/main/docs/2025"
click node_intake "https://github.com/howie6879/weekly/blob/main/src/db.py"
click node_weekly_db "https://github.com/howie6879/weekly/blob/main/weekly.db"
click node_bootstrap "https://github.com/howie6879/weekly/blob/main/main.py"
click node_export "https://github.com/howie6879/weekly/blob/main/src/export_data.py"
click node_randomizer "https://github.com/howie6879/weekly/blob/main/random_weekly.py"
click node_site "https://github.com/howie6879/weekly/blob/main/docs/index.md"
click node_rss "https://github.com/howie6879/weekly/blob/main/src/rss.py"
click node_sitemap "https://github.com/howie6879/weekly/blob/main/src/gen_sitemap.py"
click node_pdf "https://github.com/howie6879/weekly/blob/main/src/gen_pdf.py"
click node_telegram_parser "https://github.com/howie6879/weekly/blob/main/src/sender/tg_utils.py"
click node_telegram_sender "https://github.com/howie6879/weekly/blob/main/src/sender/tg_sender.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_weekly_md toneBlue
class node_intake,node_weekly_db,node_bootstrap,node_export toneAmber
class node_randomizer,node_site,node_rss,node_sitemap,node_pdf toneMint
class node_telegram_parser,node_telegram_sender toneRose
class node_editor,node_telegram,node_reader,node_submitter toneIndigo
```

## Components

### Editorial content

- [Weekly Markdown](https://github.com/howie6879/weekly/tree/main/docs/2025): `docs/2025`

### Storage and reuse

- [Markdown ingestion](https://github.com/howie6879/weekly/blob/main/src/db.py): `src/db.py`
- [Weekly database](https://github.com/howie6879/weekly/blob/main/weekly.db): `weekly.db`
- [Update runner](https://github.com/howie6879/weekly/blob/main/main.py): `main.py`
- [JSON export](https://github.com/howie6879/weekly/blob/main/src/export_data.py): `src/export_data.py`

### Reader channels

- [Today recommendation](https://github.com/howie6879/weekly/blob/main/random_weekly.py): `random_weekly.py`
- [Weekly website](https://github.com/howie6879/weekly/blob/main/docs/index.md): `docs/index.md`
- [RSS feed](https://github.com/howie6879/weekly/blob/main/src/rss.py): `src/rss.py`
- [Sitemap generation](https://github.com/howie6879/weekly/blob/main/src/gen_sitemap.py): `src/gen_sitemap.py`
- [PDF compilation](https://github.com/howie6879/weekly/blob/main/src/gen_pdf.py): `src/gen_pdf.py`

### Sharing

- [Telegram item parser](https://github.com/howie6879/weekly/blob/main/src/sender/tg_utils.py): `src/sender/tg_utils.py`
- [Telegram sender](https://github.com/howie6879/weekly/blob/main/src/sender/tg_sender.py): `src/sender/tg_sender.py`

### Other components

- **Editor**
- **Telegram channel**
- **Reader**
- **Resource submitter**

## Connections

- Editor → Weekly Markdown: edits issues (evidence: `README.md`)
- Weekly Markdown → Markdown ingestion: parses entries (evidence: `src/db.py`)
- Update runner → Markdown ingestion: runs ingestion (evidence: `main.py`)
- Markdown ingestion → Weekly database: writes records (evidence: `src/db.py`)
- JSON export → Weekly database: loads records (evidence: `src/export_data.py`)
- Today recommendation → Weekly database: queries items (evidence: `random_weekly.py`)
- Today recommendation → Weekly website: writes recommendation (evidence: `random_weekly.py`)
- Weekly Markdown → RSS feed: reads issues (evidence: `src/rss.py`)
- Update runner → RSS feed: runs generation (evidence: `main.py`)
- Weekly Markdown → PDF compilation: compiles issues (evidence: `src/gen_pdf.py`)
- Update runner → Sitemap generation: imports generator (evidence: `main.py`)
- Telegram item parser → Telegram sender: supplies items (evidence: `src/sender/tg_sender.py`)
- Telegram sender → Telegram channel: sends messages
- Weekly website → Reader: serves content (evidence: `README.md`)
- RSS feed → Reader: provides feed (evidence: `README.md`)
- Telegram channel → Reader: shares updates (evidence: `README.md`)
