feat: pin uk-bank-statement-anonymiser to 0.2.3 and sync docs - #161
Merged
Conversation
- 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>
Owner
Author
|
all tests pass locally |
Contributor
There was a problem hiding this comment.
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-anonymiseroptional dependency to==0.2.3. - Add
retain_descriptionsparameter to theanonymise_pdfshim 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.
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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Changes
pyproject.toml
src/bank_statement_parser/modules/anonymise.py
SECURITY.md
README.md
docs/guides/anonymisation.md
Testing