grime 0.1.1

Archival document management as a reusable Django app

grime

Grime is an archival document management platform — a reusable Django app for ingesting scanned documents, running OCR / NER pipelines, and annotating pages with tagged regions.

Quick start

pip install -e ".[dev]"
python manage.py migrate
python manage.py createsuperuser
python manage.py ingest MY_DOCUMENT.pdf
# Should return an endpoint like '/documents/1'

python manage.py runserver
# then visit http://127.0.0.1:8000/documents/1
# or visit http://127.0.0.1:8000/admin, login, and 
# navigate to you document

Management commands

You can run ocr and ner page by page in the document viewer or you can bulk process documents from the command line using the following commands:

python manage.py ocr        --document 42 [--page N] [--textract] [--force] [--dry-run]
python manage.py ner        --document 42 [--page N] [--threshold 0.85] [--force] [--dry-run]
python manage.py match_tags --label "member entry" [--source-document 3] [--target-document 5] \
                            [--create-tags] [--force] [--min-score 0.5] [--tolerance 0.08]

Status

This is an initial scaffold. The admin loads and the management commands run end-to-end, but the embedded document viewer (templates/admin/grime/_document_viewer.html) is read-only: bboxes and tags render on the page image, but interactive editing (OCR correction, tag CRUD, NER label correction) needs AJAX endpoints that have not been implemented yet.