Skip to content

Default to parquet + keep_zip=True, refresh README, fix NEXT_DAY URL#96

Closed
nick-gorman wants to merge 1 commit into
masterfrom
keep-zip-default-true
Closed

Default to parquet + keep_zip=True, refresh README, fix NEXT_DAY URL#96
nick-gorman wants to merge 1 commit into
masterfrom
keep-zip-default-true

Conversation

@nick-gorman
Copy link
Copy Markdown
Member

Summary

Seven commits accumulated on the keep-zip-default-true branch since master. Grouped by intent:

Behavioural / default changes

  • 45285d2 (already on remote — origin/keep-zip-default-true tip when this PR was assembled) keep_zip default flipped from False to True for dynamic_data_compiler / cache_compiler. Closes Option to keep .zip not csv #56 — cached zips survive between runs.
  • 1f034a7 fformat default flipped from feather to parquet. Feather still supported via fformat='feather'. Includes README + test-suite updates so the offline suite stays green.

Fixture / source bug fix

  • 6e65ea5 Fix NEXT_DAY_DISPATCHLOAD URL after AEMO renamed the parent directory + bump the recent fixture era to 2026-05-15.
  • fdb0b60 Extend the test fixture matrix with a 2026-04 era so the boundary tests carry general recent-month coverage in the PUBLIC_ARCHIVE# format.

Docs

  • 30eba59 Sync README with the caching defaults already on master (keep_csv=False, keep_zip=True). The previous README still claimed keep_csv=True. Added the keep_csv × keep_zip retention matrix.
  • cea80f0 Fix incorrect "GUI co-use needs keep_csv=True" claim. The GUI reads parquet/feather, not the raw AEMO CSV — keep_csv is purely for external CSV consumers.
  • 679f598 Drop a dangling rationale clause from one matrix row so the matrix is symmetric (just describes contents; the "leanest" / "full" markers stay on rows 2 and 4).
  • 53c1b66 New "Start and end time" subsection documenting the three accepted input forms (string, datetime.datetime, datetime.date) with a code example for each. Includes the date-expansion edge case (end_time as a bare date is inclusive of the whole day).

Test plan

  • CI green on the branch
  • Spot-check the rendered README (matrix, new Start-and-end-time section, TOC anchors)
  • Optional: live smoke test against real AEMO/nemweb for NEXT_DAY_DISPATCHLOAD (offline suite already covers the URL-fix path via fixtures)
  • Confirm dynamic_data_compiler with no explicit fformat now writes parquet to a fresh cache directory

🤖 Generated with Claude Code

Replaces the single-line mention of accepted input forms with a
proper subsection under Dynamic data compiler. Documents all three
forms (string, datetime.datetime, datetime.date) with a concrete
code example for each, and calls out the date-expansion edge case
(end_time as a bare date is inclusive of the whole day, because
parse_datetime_py expands it to 00:00:00 of the next day).

Also switches the two existing datetime() examples in the
headline Dynamic data compiler example and the Accessing
additional table columns example to string literals, since strings
are the simplest form and don't require a datetime import.

Added TOC entry for the new subsection.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@nick-gorman
Copy link
Copy Markdown
Member Author

Closing — branch was behind master, the 6 earlier commits already landed via PR #95. Re-opening as a fresh single-commit PR off the new master tip.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Option to keep .zip not csv

1 participant