Skip to content

feat: add CleanReport JSON export - #182

Merged
JohnnyWilson16 merged 2 commits into
FreshCode-Org:mainfrom
WilliamK112:feat/clean-report-json-export
Aug 20, 2026
Merged

feat: add CleanReport JSON export#182
JohnnyWilson16 merged 2 commits into
FreshCode-Org:mainfrom
WilliamK112:feat/clean-report-json-export

Conversation

@WilliamK112

@WilliamK112 WilliamK112 commented Aug 20, 2026

Copy link
Copy Markdown
Contributor

Summary

  • add first-class CleanReport.to_json(**kwargs) and CleanReport.write_json(path, **kwargs) helpers without changing the existing to_dict() payload
  • cover JSON-string options and a UTF-8 file round-trip using a real cleaning report
  • update the batch CSV example, quickstart, and Unreleased changelog to use the official API

Closes #21.

Validation

  • pytest tests/test_report.py --no-cov — 12 passed
  • ruff check . — passed
  • mypy src/freshdata/report.py — passed (with NumPy 2.4; the latest 2.5 stubs require a newer mypy target than this repository's configured Python 3.10 target)
  • python examples/08_csv_automation.py — completed and wrote 3 JSON audit logs
  • git diff --check — passed
  • full required fast lane with .[dev,ml]: 4,054 passed, 6 skipped, 12 deselected; 93.16% aggregate coverage (93% required)

The new serialization lines are exercised by the focused tests; src/freshdata/report.py measured 96% coverage in the full run.

@strix-security

Copy link
Copy Markdown
Contributor

Strix is installed on this repository, but we couldn't run this PR security review because this workspace's trial has ended. Add a card to resume code reviews here.

So far, Strix has reviewed 36 pull requests, surfaced 3 security issues (1 critical/high) and blocked 1 risky merge across this workspace.

@coderabbitai

coderabbitai Bot commented Aug 20, 2026

Copy link
Copy Markdown
Contributor

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 91714d35-bda5-4ca0-8cce-51f1738a9a56


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 2189ffe3f3

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread src/freshdata/report.py

@JohnnyWilson16 JohnnyWilson16 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @WilliamK112,

Thanks for another great PR!

Really appreciate how thorough you were here—not just adding to_json and write_json, but also handling non-primitive serialization defaults (default=str for timestamps in metadata), updating the quickstart and example script, and adding solid round-trip tests. It makes exporting clean audit logs so much smoother.

Everything looks super clean and ready to go. Merging this in! 🚀

@JohnnyWilson16
JohnnyWilson16 merged commit a79f941 into FreshCode-Org:main Aug 20, 2026
17 checks passed
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.

[Architecture/Feature - Mid Level] Add first-class JSON export for CleanReport

2 participants