What's Changed

• Add fraction symbol normalization by @jftuga in #16

Full Changelog: v1.3.1...v1.3.2

What's Changed

• Use single quotes inside a double-quoted f-string by @danielmlow in #14
• add support for 'her' object pronoun by @jftuga in #15

New Contributors

• @danielmlow made their first contribution in #14

Full Changelog: v1.3.0...v1.3.1

add --exclude option

Add ability to exclude entities from de-identification with -x, --exclude.

• This uses a comma as the delimiter to allow for multiple entities.
• Comma can be overridden by setting the DEIDENTIFY_EXCLUDE_DELIM environment variable.

The Python API can also use this option be setting a DeidentificationConfig.excluded_entities option to a Python set data type.

Improve Python API

• reset all internal variables at the beginning of the deidentify method
• lower-case all config.excluded_entities
• added API testing with api_test.py

prepare for PiPY deployment

• create and/or update files for PyPI
• Created Makefile and get_project_name.py to deploy to test and prod PyPI servers
• updated install instructions in README.md
• set minimum Python version to 3.10

allow for multiple languages

• allow for multiple languages in the future by making GENDER_PRONOUNS a dict which uses the DeidentificationLanguages Enum-style class as keys
• moved helper classes to deidentification_constants.py to avoid a circular dependency
• DeidentificationLanguages now maps the default DeidentificationConfig.replacement word to a language-specific noun, such as PERSON

Model Download

• When a spaCy model has not been downloaded, advise the user on how to manually download it.

Small Bug Fixes

• get_identified_elements() will now always return pronouns
• • If multiple passes were needed in deidentify(), then get_identified_elements() would not have returned any pronouns.
• use self.text instead of self.replaced_text in get_identified_elements()
• Include small refinements to README.md

CLI Improvements

• added third-party VeryPrettyTable module as a dependency
• documented the CLI program, deidentify in README.md
• added -t to save detected entities to a JSON file to the CLI
• added -d for debug mode to the CLI
• use the third-party chardet module to detect file character encodings for input files
• updated Deidentification class to accommodate these CLI options