deprecate ledger reportcat - #152
Conversation
There was a problem hiding this comment.
Pull request overview
This PR removes the reportcat reporting surface area and the dataset access ledger functionality from cfa.dataops, and then updates type stubs, tests, docs, and catalog-creation templates to match the reduced scope.
Changes:
- Remove
cfa.dataops.reportingimplementation, templates, examples, and docs, and dropreportcatfrom runtime and typing stubs. - Remove ledger-related configuration/fields/methods (
access_ledger,ledger_entry,_ledger_endpoint, etc.) from the catalog runtime and stubs. - Update stub generation (
type_stubs.py+ mako templates), tests, and catalog-init templates to reflect the new dataset-only API.
Reviewed changes
Copilot reviewed 47 out of 48 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| typings/cfa/dataops/catalog.pyi | Removes reportcat + ledger fields from public stubs. |
| typings/cfa/dataops/init.pyi | Removes reportcat export from type stubs. |
| tests/test_utils_misc.py | Drops tests tied to removed report/reportcat helpers. |
| tests/test_type_stubs.py | Updates stub-generation tests to dataset-only model. |
| tests/test_reporting_catalog.py | Removes reporting catalog test suite. |
| tests/test_datasets_catalog.py | Removes ledger-default assumptions and mocking. |
| tests/test_create_catalog.py | Updates catalog-init expectations (no reports/). |
| tests/test_command.py | Removes ledger endpoint assumptions; renames one test. |
| tests/test_catalog_additional.py | Removes ledger-specific BlobEndpoint behaviors/tests. |
| tests/test_blob_endpoint_save_methods.py | Removes ledger_location test setup. |
| tests/test_blob_endpoint_download.py | Removes ledger-specific download behaviors/tests. |
| tests/fixtures/expected_catalog_stub.pyi | Removes expected stub fixture that included reportcat/ledger. |
| tests/conftest.py | Removes access_ledger from dataset defaults fixture. |
| pyproject.toml | Drops reporting-related dependencies. |
| mkdocs.yaml | Removes report-generation page from nav. |
| examples/reportcat/run_minimal_report.py | Removes reportcat example script. |
| examples/reportcat/publish_report.py | Removes report publishing example script. |
| examples/reportcat/minimal_report.ipynb | Removes minimal report example notebook. |
| docs/reportcat_quickstart.md | Removes reportcat quickstart doc. |
| docs/reportcat_publish_example.md | Removes reportcat publish example doc. |
| docs/report_generation.md | Removes report generation guide. |
| docs/presentations/cfa-division-meeting-20250828.md | Updates roadmap wording away from ledger. |
| docs/presentations/cfa-division-meeting-20250828.html | Updates roadmap wording away from ledger (rendered HTML). |
| docs/managing_catalogs.md | Updates guide to dataset-only unified access. |
| docs/index.md | Updates landing page to remove reporting references. |
| docs/catalog_creation.md | Updates catalog-init guide to remove reports/ledger defaults. |
| cfa/dataops/type_stubs.py | Removes report tree/model generation from stub generator. |
| cfa/dataops/stub_templates/init.pyi.mako | Removes reportcat from generated __init__.pyi. |
| cfa/dataops/stub_templates/catalog.pyi.mako | Removes NotebookEndpoint/reportcat/ledger from generated catalog stub. |
| cfa/dataops/reporting/jupyter_templates/lab/mermaidjs.html.j2 | Removes reporting HTML template asset. |
| cfa/dataops/reporting/jupyter_templates/lab/index.html.j2 | Removes reporting HTML template asset. |
| cfa/dataops/reporting/jupyter_templates/lab/conf.json | Removes reporting HTML template config. |
| cfa/dataops/reporting/jupyter_templates/lab/base.html.j2 | Removes reporting HTML template asset. |
| cfa/dataops/reporting/jupyter_templates/base/null.j2 | Removes reporting HTML template asset. |
| cfa/dataops/reporting/jupyter_templates/base/mathjax.html.j2 | Removes reporting HTML template asset. |
| cfa/dataops/reporting/jupyter_templates/base/jupyter_widgets.html.j2 | Removes reporting HTML template asset. |
| cfa/dataops/reporting/jupyter_templates/base/display_priority.j2 | Removes reporting HTML template asset. |
| cfa/dataops/reporting/jupyter_templates/base/celltags.j2 | Removes reporting HTML template asset. |
| cfa/dataops/reporting/jupyter_templates/base/cell_id_anchor.j2 | Removes reporting HTML template asset. |
| cfa/dataops/reporting/catalog.py | Removes NotebookEndpoint + report namespace code. |
| cfa/dataops/create_catalog/repo_templates/catalog_defaults.toml.mako | Removes access_ledger section from generated defaults. |
| cfa/dataops/create_catalog/repo_files/reports/examples/basics.ipynb | Removes report notebook template from generated repos. |
| cfa/dataops/create_catalog/repo_files/reports/init.py | Removes reports namespace initializer from generated repos. |
| cfa/dataops/create_catalog/repo_files/.gitignore | Minor wording tweak for coverage ignore comment. |
| cfa/dataops/create_catalog/command.py | Stops copying the reports/ module during catalog init. |
| cfa/dataops/catalog.py | Removes report aggregation and ledger plumbing from runtime catalog. |
| cfa/dataops/init.py | Removes reportcat export from runtime API surface. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…ration link Co-authored-by: ryanraaschCDC <150935395+ryanraaschCDC@users.noreply.github.com>
Co-authored-by: ryanraaschCDC <150935395+ryanraaschCDC@users.noreply.github.com>
|
This is a significant PR. I will take a look, but please have one of the engineers comment/approve. |
|
yeah unfortunately the only way to remove everything for ledger and reportcat ends up with a large PR. I'll tag someone else to review too. Thanks |
|
@damonbayer could you check out this PR when you get the time? |
|
@xop5 please review when you get the chance. Thanks! |
damonbayer
left a comment
There was a problem hiding this comment.
Thanks @ryanraaschCDC! Always nice to see a bunch of code removed from a project.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
…DCgov/cfa-dataops into 124-deprecate-ledger-reportcat
No description provided.