Add STATUS.md + DataHub batch publishing guide
Browse filesSTATUS.md tracks shipped / in-progress / deferred per CLAUDE.md convention.
docs/datahub-batch.md lists the 25 history-bearing Root Dir paths to paste
into DataHub's Create-Post form. Other registry instructions (Hugging Face,
Kaggle, Zenodo) included for the next iteration.
- STATUS.md +63 -0
- docs/datahub-batch.md +74 -0
STATUS.md
ADDED
|
@@ -0,0 +1,63 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# calcfi-open-data — STATUS
|
| 2 |
+
|
| 3 |
+
_Last updated: 2026-05-19 (initial scaffold + first push + 34 datasets generated)_
|
| 4 |
+
|
| 5 |
+
## Shipped
|
| 6 |
+
|
| 7 |
+
### Repo + scaffold
|
| 8 |
+
- Public repo at https://github.com/jerehere/calcfi-open-data
|
| 9 |
+
- README with primary-source matrix, quick-start (curl/Python/R), licensing, mirroring notes
|
| 10 |
+
- LICENSE.md: CC0 on scaffold, CC BY 4.0 on data
|
| 11 |
+
- Daily refresh workflow `.github/workflows/refresh.yml` at 06:00 UTC (after CalcFi's 05:00 UTC pull)
|
| 12 |
+
- Frictionless Data Package per subdir (`datapackage.json` + `data.csv` + `README.md`)
|
| 13 |
+
- Topics: open-data, personal-finance, dataset, frictionless-data, datapackage, economic-data, financial-data, fred, cc-by, public-data
|
| 14 |
+
|
| 15 |
+
### Dataset coverage (34 series across 11 categories)
|
| 16 |
+
- 25 series with full history (117k+ rows total)
|
| 17 |
+
- 9 series with current-snapshot placeholders (history still accumulating on CalcFi side)
|
| 18 |
+
|
| 19 |
+
| Category | Series | Status |
|
| 20 |
+
|---|---|---|
|
| 21 |
+
| Mortgage rates | 30-year-fixed, 15-year-fixed, 10-year-treasury | full history |
|
| 22 |
+
| Interest rates | federal-funds-rate, prime-rate, 2-year-treasury | full history |
|
| 23 |
+
| Inflation | cpi, pce | full history |
|
| 24 |
+
| Employment | unemployment-rate, labor-force-participation, avg-hourly-earnings | full history |
|
| 25 |
+
| Energy | crude-oil-wti, crude-oil-brent, us-regular-gas-price | full history |
|
| 26 |
+
| FX | usd-eur, usd-gbp, usd-jpy | full history |
|
| 27 |
+
| Credit | credit-card-apr, personal-loan-rate-24mo | full history |
|
| 28 |
+
| Commodities | copper-price, corn-price | full history |
|
| 29 |
+
| Global | us-gdp-per-capita, world-unemployment, eurozone-gdp-per-capita | annual history |
|
| 30 |
+
| Crypto | bitcoin, ethereum, solana | snapshot only (history TBD) |
|
| 31 |
+
| Deposit rates | savings-national-rate, money-market, cd-3mo, cd-12mo, cd-60mo | snapshot only |
|
| 32 |
+
| Credit (auto) | auto-loan-rate-48mo | snapshot only |
|
| 33 |
+
| Global (extra) | world-inflation | snapshot only |
|
| 34 |
+
|
| 35 |
+
## In progress
|
| 36 |
+
|
| 37 |
+
### Registry publishing (manual, user-driven)
|
| 38 |
+
- DataHub.io: 25 history-bearing subdirs to publish (one post per Root Dir, see `docs/datahub-batch.md`)
|
| 39 |
+
- Hugging Face Datasets: mirror via `huggingface-cli upload` (deferred)
|
| 40 |
+
- Kaggle Datasets: one-time CSV upload per series (deferred)
|
| 41 |
+
- Zenodo: connect repo, tag a release, get DOI (deferred)
|
| 42 |
+
- re3data.org: registry form once 5+ external mirrors exist
|
| 43 |
+
|
| 44 |
+
## Deferred (backlog)
|
| 45 |
+
|
| 46 |
+
### Empty series — wait for CalcFi history accumulation
|
| 47 |
+
- bitcoin, ethereum, solana (CoinGecko snapshots not archived yet)
|
| 48 |
+
- savings/money-market/CD rates (FDIC manual update, no daily archive)
|
| 49 |
+
- auto-loan-rate-48mo (FRED series available, not yet wired to history.csv endpoint)
|
| 50 |
+
- world-inflation (World Bank, slow cadence)
|
| 51 |
+
|
| 52 |
+
These will auto-populate on next daily refresh once CalcFi's history endpoint returns rows for them. No repo-side work needed.
|
| 53 |
+
|
| 54 |
+
### Out of scope
|
| 55 |
+
- Real-time intraday data (CalcFi is daily/weekly/monthly cadence by design)
|
| 56 |
+
- Currency triangulation series (only majors USD-EUR/GBP/JPY)
|
| 57 |
+
- US state-level CSVs (separate `calcfi.app/api/maps/{category}/csv` surface; could mirror later as `datasets/maps/{category}/` if useful)
|
| 58 |
+
|
| 59 |
+
## Hard rules
|
| 60 |
+
- No data transformations — mirror primary-source values verbatim
|
| 61 |
+
- Provenance headers preserved in every CSV (#-prefixed lines)
|
| 62 |
+
- License CC BY 4.0 always; attribution to CalcFi + primary source
|
| 63 |
+
- Refresh workflow read-only against calcfi.app (no auth, no rate-limit gate)
|
docs/datahub-batch.md
ADDED
|
@@ -0,0 +1,74 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# DataHub.io batch publishing
|
| 2 |
+
|
| 3 |
+
DataHub.io requires one **post** per dataset, but all posts can point at the same GitHub repo (`jerehere/calcfi-open-data`) with different **Root Dir** values.
|
| 4 |
+
|
| 5 |
+
## Form fields (every post uses these)
|
| 6 |
+
|
| 7 |
+
- **Post Type:** Standard Dataset
|
| 8 |
+
- **GitHub Account:** jerehere
|
| 9 |
+
- **Repository:** calcfi-open-data
|
| 10 |
+
- **Branch:** main
|
| 11 |
+
- **Root Dir:** see batch list below (paste exactly, no trailing slash)
|
| 12 |
+
|
| 13 |
+
## Batch list — 25 datasets with full history (publish these first)
|
| 14 |
+
|
| 15 |
+
```
|
| 16 |
+
datasets/30-year-fixed
|
| 17 |
+
datasets/15-year-fixed
|
| 18 |
+
datasets/10-year-treasury
|
| 19 |
+
datasets/federal-funds-rate
|
| 20 |
+
datasets/prime-rate
|
| 21 |
+
datasets/2-year-treasury
|
| 22 |
+
datasets/cpi
|
| 23 |
+
datasets/pce
|
| 24 |
+
datasets/unemployment-rate
|
| 25 |
+
datasets/labor-force-participation
|
| 26 |
+
datasets/avg-hourly-earnings
|
| 27 |
+
datasets/crude-oil-wti
|
| 28 |
+
datasets/crude-oil-brent
|
| 29 |
+
datasets/us-regular-gas-price
|
| 30 |
+
datasets/usd-eur
|
| 31 |
+
datasets/usd-gbp
|
| 32 |
+
datasets/usd-jpy
|
| 33 |
+
datasets/credit-card-apr
|
| 34 |
+
datasets/personal-loan-rate-24mo
|
| 35 |
+
datasets/copper-price
|
| 36 |
+
datasets/corn-price
|
| 37 |
+
datasets/us-gdp-per-capita
|
| 38 |
+
datasets/world-unemployment
|
| 39 |
+
datasets/eurozone-gdp-per-capita
|
| 40 |
+
```
|
| 41 |
+
|
| 42 |
+
## Defer until CalcFi history accumulates (9 datasets, currently snapshot-only)
|
| 43 |
+
|
| 44 |
+
```
|
| 45 |
+
datasets/bitcoin
|
| 46 |
+
datasets/ethereum
|
| 47 |
+
datasets/solana
|
| 48 |
+
datasets/savings-national-rate
|
| 49 |
+
datasets/money-market-national-rate
|
| 50 |
+
datasets/cd-3mo-national-rate
|
| 51 |
+
datasets/cd-12mo-national-rate
|
| 52 |
+
datasets/cd-60mo-national-rate
|
| 53 |
+
datasets/auto-loan-rate-48mo
|
| 54 |
+
datasets/world-inflation
|
| 55 |
+
```
|
| 56 |
+
|
| 57 |
+
## Recommended publishing cadence
|
| 58 |
+
|
| 59 |
+
- Day 1: top 5 highest-traffic series (30-year-fixed, cpi, federal-funds-rate, unemployment-rate, 10-year-treasury)
|
| 60 |
+
- Day 2-3: remaining 20 history-bearing series
|
| 61 |
+
- Day 7+: re-run `node scripts/refresh.mjs` locally to see which deferred series now have history; publish those
|
| 62 |
+
|
| 63 |
+
## After publishing
|
| 64 |
+
|
| 65 |
+
Each DataHub post auto-syncs from GitHub on every push. The daily refresh workflow will keep all datasets current with zero manual work.
|
| 66 |
+
|
| 67 |
+
## Other registries to mirror
|
| 68 |
+
|
| 69 |
+
Same repo, different platforms:
|
| 70 |
+
|
| 71 |
+
- **Hugging Face Datasets:** `huggingface-cli upload jerehere/calcfi-30y-mortgage datasets/30-year-fixed/data.csv`
|
| 72 |
+
- **Kaggle:** create new dataset, upload `data.csv`, paste README content
|
| 73 |
+
- **Zenodo:** connect repo, tag a release (`gh release create v0.1.0`), Zenodo creates DOI automatically
|
| 74 |
+
- **re3data.org:** registry submission form once 3+ external mirrors exist
|