Skip to content

Latest commit

 

History

History
48 lines (32 loc) · 1.14 KB

README.md

File metadata and controls

48 lines (32 loc) · 1.14 KB

Anonymizer

⚠️ Disclaimer ⚠️: This is a prototype. Do not use for anything critical.

A Python module that provides multiple anonymization techniques for text.

Tests Black & Flake8 Code style: Black

Install requirements

You can install all requirements using:

pip install -r requirements.txt

Compared to installation with setup.py, requirements.txt additionally installs developer dependencies.

To install the package using setup.py run:

pip install .

Install the pre-commit hooks for developing

pre-commit install
git config --bool flake8.strict true  # Makes the commit fail if flake8 reports an error

To run the hooks:

pre-commit run --all-files

Testing

The tests can be executed with:

pytest --doctest-modules --cov-report term --cov=anonymizer

License

MIT