Skip to content

feat: pin uk-bank-statement-anonymiser to 0.2.3 and sync docs - #161

Merged
boscorat merged 3 commits into
masterfrom
feat/pin-anonymiser-0.2.3
Aug 5, 2026
Merged

feat: pin uk-bank-statement-anonymiser to 0.2.3 and sync docs#161
boscorat merged 3 commits into
masterfrom
feat/pin-anonymiser-0.2.3

Conversation

@boscorat

@boscorat boscorat commented Aug 5, 2026

Copy link
Copy Markdown
Owner

Summary

  • Pin in
  • Add parameter to shim
  • Update with caveat
  • Update features section
  • Regenerate docs via

Changes

pyproject.toml

  • Changed to

src/bank_statement_parser/modules/anonymise.py

  • Added parameter
  • Updated docstring with parameter description and raises section
  • Passed to upstream function

SECURITY.md

  • Added note about disabling scrambling

README.md

  • Updated PDF anonymisation feature description to mention

docs/guides/anonymisation.md

  • Regenerated to include parameter documentation

Testing

  • All 62 datamart tests pass
  • All 30 CLI and docs tests pass
  • Ruff checks pass on modified files

- Pin uk-bank-statement-anonymiser==0.2.3 in pyproject.toml
- Add retain_descriptions parameter to anonymise.py shim
- Update SECURITY.md with retain_descriptions caveat
- Update README.md features section
- Regenerate docs via scripts/generate_docs.py

Signed-off-by: Jason Farrar <stillwaters.technology@gmail.com>
@boscorat

boscorat commented Aug 5, 2026

Copy link
Copy Markdown
Owner Author

all tests pass locally

Copilot AI 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.

Pull request overview

Pins the optional uk-bank-statement-anonymiser dependency and updates the bank_statement_parser.modules.anonymise shim + documentation to support a new retain_descriptions mode when anonymising PDFs.

Changes:

  • Pin uk-bank-statement-anonymiser optional dependency to ==0.2.3.
  • Add retain_descriptions parameter to the anonymise_pdf shim and forward it to the upstream anonymiser.
  • Sync security/readme/docs guidance to document the new parameter and its caveats.

Reviewed changes

Copilot reviewed 5 out of 6 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
pyproject.toml Pins the anonymiser optional dependency version.
src/bank_statement_parser/modules/anonymise.py Extends the anonymisation shim API to accept/forward retain_descriptions and documents its behavior.
SECURITY.md Documents the security caveat of preserving transaction descriptions.
README.md Updates feature description to mention retain_descriptions=True option.
docs/guides/anonymisation.md Regenerates guide content to include the new parameter and Raises docs.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread src/bank_statement_parser/modules/anonymise.py Outdated
Comment thread pyproject.toml Outdated
boscorat and others added 2 commits August 5, 2026 20:18
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Jason Farrar <farrar.jason1@gmail.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Jason Farrar <farrar.jason1@gmail.com>
@boscorat
boscorat merged commit d09e01c into master Aug 5, 2026
4 of 5 checks passed
@boscorat
boscorat deleted the feat/pin-anonymiser-0.2.3 branch August 5, 2026 19:25
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.

2 participants