Welcome to redactionator 👋

License: MIT

Simply pdf redaction script

Description

This was supposed to be a simple script to save time redacting sensitive data from pdf files by hand, but instead it turned into a larger than expected project, and probably consumed more time that it would have taken to make those same modifications manually. Anyone would naturally assume there would be an overabundance of tools to remove sensitive data from pdf documents, but this was not found to be true, so we were forced to write our own.

Install

You should be able to use whatever python virtualization solution you prefer. A requirements.txt is provided for you in the repository along with poetry's pyproject.toml. Whichever you prefer.

Installation is easily performed with a poetry install or a pipenv install.

poetry install

Usage

Usage is like it should be, simply prefix the command with whatever python virtual environment solution that you prefer followed by run python redactionator, and then afterwards place your arguements.

The most import arguements that are required for execution are:

1. --sensitive = Which is the document where you should place the actual information you desire to censor.
2. --input = Which is the document that you want to redact the sensitive information from.
3. --output = Which is the document you want to save the redacted version of the document to.

poetry run python redactionator.py --sensitive sensitive.txt --input example.pdf --output example-redacted.pdf

Caveats

One thing we were disappointed with was the failure of the script to resize images that were considerably larger than remainder of the document. Several hours were spend in experimentation, without result. This will have to fixed in future versions, but was not a planned feature of necessity.

Author

👤 Anoduck

• Website: http://anoduck.github.io
• Github: @anoduck

Show your support

Give a ⭐️ if this project helped you!

This README was generated with ❤️ by readme-md-generator