Getting started

Here's how to set up doc-redaction for local development. Please note this documentation assumes you already have uv and Git installed and ready to go.

1. Clone the repository:

git clone https://github.com/deadhand777/doc-redaction.git

1. Now install the environment. Navigate into the directory

cd doc-redaction

Then, install and activate the environment with:

uv sync

1. Install pre-commit to run linters/formatters at commit time:

uv run pre-commit install

Congratulations, now your setup is completed!

1. Run the workflow on a sample PDF document:

uv run src/doc_redaction/workflow.py --key spielbank_rocketbase_vertrag