Skip to content

Clarify builder API asymmetry#82

Open
charles-turner-bot wants to merge 1 commit into
ACCESS-NRI:mainfrom
charles-turner-bot:ct/issue-76-alt-source-api
Open

Clarify builder API asymmetry#82
charles-turner-bot wants to merge 1 commit into
ACCESS-NRI:mainfrom
charles-turner-bot:ct/issue-76-alt-source-api

Conversation

@charles-turner-bot

@charles-turner-bot charles-turner-bot commented May 26, 2026

Copy link
Copy Markdown
Contributor

Summary

  • keep the public builder surface explicitly intake-esm-catalog-first for now
  • document the virtual-vs-real asymmetry rather than freezing premature alternate-source entrypoints
  • clarify the two builder roles in the README and API reference

Notes

  • GroupEntry remains an internal seam for future experimentation
  • a virtual builder alternate-source API would likely need source paths plus parser/provenance context
  • a real-data builder dataset convenience path may still make sense later, but this PR intentionally does not add it yet

Testing

  • pixi run python -m pytest -q tests/test_source_build.py -k 'group_entry_from_esm_group or group_entry_requirements or test_iter_esm_groups'

Closes #76

@codecov

codecov Bot commented May 26, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.37%. Comparing base (1fc1e11) to head (87ba518).

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #82   +/-   ##
=======================================
  Coverage   95.37%   95.37%           
=======================================
  Files           9        9           
  Lines         713      713           
=======================================
  Hits          680      680           
  Misses         33       33           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@charles-turner-bot charles-turner-bot force-pushed the ct/issue-76-alt-source-api branch from 3c141e2 to 87ba518 Compare May 26, 2026 10:02
@charles-turner-bot charles-turner-bot changed the title Add alternate-source builder entrypoints Clarify builder API asymmetry May 26, 2026
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.

Define alternate-source builder APIs and virtual-vs-real asymmetry

1 participant