CI / test (pull_request) Successful in 46s
The threshing-reddit scraper (DragonKind/threshing-reddit) reads the runs riders describe in the r/fourthwing megathreads and delivers them here by pull request as data/public/reddit_comments.json: each run is the "Report a run" answers (option labels of collection/specs/report_form.yaml), with the comment id and day only; no usernames, no comment text. - pipeline.yaml: a reddit_comments source of extract kind "delivered" (the atlas fetches nothing; `update` skips it with a note) - runs.py: the coder, sharing one answers_row() with the reported coder; every row is flagged as read from a Reddit comment (and "not checked by hand" until corrected); a result page a comment already carries is not counted twice as a "reddit thread" row - collection/manual/reddit_comments.yaml: reject / fix / add, applied at build time - dictionary, SOURCES, README, croissant: the new source The route model and statistics do not use the source until it is named in planner/policy.yaml / analysis/stats/measures.yaml. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
58 lines
4.9 KiB
Markdown
58 lines
4.9 KiB
Markdown
# collection
|
|
|
|
Getting data in, as a strict **extract → transform → load** pipeline. Every source is declared in
|
|
[`pipeline.yaml`](pipeline.yaml); the code only carries those declarations out.
|
|
|
|
```
|
|
python -m collection update # every source: extract, then transform + load if it changed; then build
|
|
python -m collection update --source reported --source register
|
|
python -m collection update --file reddit_spreadsheet=~/Downloads/export.xlsx # a local file instead of the download
|
|
python -m collection build # code every public source file into data/public/runs_clean.csv
|
|
python -m collection build --check # nothing written; exit 1 if anything is out of date (CI runs this)
|
|
```
|
|
|
|
## The stages
|
|
|
|
| Stage | Does | Never does |
|
|
|---|---|---|
|
|
| **extract** (`etl/extract.py`) | Fetches the source as it is now into `data/raw/<source>/current.<ext>`. The version it replaces becomes `previous.<ext>`; nothing older is kept. `data/manifest.json` records the current raw file's sha256 and the day it last changed. | Change the data. |
|
|
| **transform** (`etl/transform/`) | Turns the raw file into the public source file, applying the source's privacy rules. A pure function of the raw file: no network, no clock. | Write files. |
|
|
| **validate** (`etl/validate.py`) | Checks the combined runs against `data/dictionary.yaml` (types, every value listed, unique ids). A failure stops the load and is reported. | Fix anything silently. |
|
|
| **load** (`etl/load.py`) | The only stage that writes public files. Byte-stable: the same input always gives the same bytes, and a file is only rewritten when its bytes change. | Publish anything raw. |
|
|
|
|
`build` then codes every public source file into one run per row (`etl/runs.py`, one coder per source) and writes
|
|
`data/public/runs_clean.csv`, plus the files generated from the specs: the "Report a run" issue form, the bot
|
|
crosswalk inside `core/graph.js`, and `data/croissant.json`. Every input to `build` is committed, so CI rebuilds
|
|
it exactly.
|
|
|
|
## The sources
|
|
|
|
| `source` in runs_clean.csv | Pipeline source | Extract | Public source file |
|
|
|---|---|---|---|
|
|
| reddit spreadsheet | `reddit_spreadsheet`: u/ClumsyBadger's Threshing Routes form and spreadsheet, linked from the megathreads | the sheet's .xlsx export | `data/public/form_responses.json` (emails redacted), coded by `core/spec/form.yaml` |
|
|
| reddit thread | `reddit_thread`: dragonkind.com result pages posted in the r/fourthwing megathreads | the threads, through the official Reddit API (needs `REDDIT_CLIENT_ID` / `REDDIT_CLIENT_SECRET`) | `manual/reddit_results.yaml`, checked by hand; the extract lists result links not in it yet |
|
|
| reddit comment | `reddit_comments`: runs riders describe in the megathread comments | not extracted here: the [threshing-reddit](https://git.kenschiano.net/DragonKind/threshing-reddit) scraper reads the threads every 6 hours and opens (or updates) a pull request that changes the public file | `data/public/reddit_comments.json`: each comment read into the "Report a run" answers, no usernames or text; corrections by hand in `manual/reddit_comments.yaml` |
|
|
| reported | `reported`: the Atlas's "Report a run" form (a GitHub issue form, `specs/report_form.yaml`) | issues labelled `run report`, through the GitHub API | `data/public/reports.json` (answers only, no usernames) |
|
|
| bot | `bot`: Ken's DragonKind bot | a local copy of the bot's private repo (`DRAGONKIND_BOT_DIR`) | `data/bot/scenes.json`, `data/bot/trajectories-<date>.jsonl` (no prose, accounts hashed with `DK_ACCOUNT_SALT`; `specs/bot.yaml`) |
|
|
| reddit pdf | `reddit_pdf`: the community route PDF | the PDF | `data/derived/pdf_fingerprint.json` only: hashes, never the text |
|
|
| — | `register`: the Unofficial Dragon Register | the sheet's .xlsx export | `data/public/register.json` (rider names and photos dropped) |
|
|
|
|
The route PDF is a flowchart of the choices, not a log of runs, so it adds no rows to `runs_clean.csv`; its
|
|
fingerprint tells us when the routes it documents change. The register lists bonded dragons without the route that
|
|
led there, so it adds no rows either.
|
|
|
|
## Raw files and privacy
|
|
|
|
`data/raw/` is git-ignored and never published. It holds the current raw file of each source and the one before
|
|
it; older versions are not kept. The daily workflow keeps that store between runs in the Actions cache, encrypted
|
|
with the `RAW_ARCHIVE_KEY` secret (see `docs/REPO_SETTINGS.md`). Privacy rules sit with each source in
|
|
`pipeline.yaml`: emails redacted, register names and photos dropped, the bot's fields refused if they look like
|
|
prose or account ids, GitHub and Reddit usernames never kept.
|
|
|
|
## Adding a source
|
|
|
|
1. Add a block to `pipeline.yaml` (extract kind, transform, privacy, load target, and `run_source` / `runs` if it
|
|
has runs).
|
|
2. If it needs a new transform or coder, add one module to `etl/transform/` and one function to `etl/runs.py`.
|
|
3. Add its `source` value to `data/dictionary.yaml`, then `python -m collection build` and `npm test`.
|