automatically create bookmarks in a PDF file
Project description
pdf_scout
This CLI tool automatically generates PDF bookmarks (also known as an 'outline' or a 'table of contents') for computer-generated PDF documents.
cd pdf_scout
poetry install
poetry run python ./src/app.py
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 populate the /pdf
folder manually:
poetry run pytest
poetry run pytest --snapshot-update
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for pdf_scout-0.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 433ade35794d317a8b1093f50c3eb2a8beecb24b013a937f4abda9d7cd242342 |
|
MD5 | 45aad64773fad34111dcd82562dcf606 |
|
BLAKE2b-256 | fd0986cd769dfbbd1fb48d1ab12697d2ea76f06f840718604d170d6a1f0bc8be |