pdf-scout 0.0.3

automatically create bookmarks in a PDF file

pdf_scout

This CLI tool automatically generates PDF bookmarks (also known as an 'outline' or a 'table of contents') for computer-generated PDF documents.

You can install it globally via pip:

pip install pdf_scout
pdf_scout ./my_document.pdf
pip uninstall pdf_scout

This project is a work in progress and will likely only generate accurate bookmarks for documents that conform to the following requirements:

• Single column of text (not multiple columns)
• Font size of header text >= font size of body text
• Header text is justified or left-aligned

Development

This project manages its dependencies using poetry and is only supported for Python ^3.9. After installing poetry and entering the project folder, run the following to install the dependencies:

poetry install

To open a virtualenv in the project folder with the dependencies, run:

poetry shell

To run a script directly, run:

poetry run python ./src/app.py

Tests

There are snapshot tests. Input PDFs are not provided at the moment, so you will have to populate the /pdf folder manually:

poetry run pytest
poetry run pytest --snapshot-update