I maintain a number of different songbook PDFs the source of which are typically a folder
containing a set of mostly single page PDFs for each song.
I use pdftk to compile these song
files into the songbook. However I would like to generate a table of contents listing the songs and
their page numbers to be included in the songbook. This python script meets that requirement by
consuming the list of song files, using the file names as the song titles, and outputing a set of
TOC PDFs to the same folder.
The script makes certain assumptions about the structure of the song filenames. These assumptions along with tool's general usage are detailed in the script's help. You can access this help by running
# Linux
docker run --rm msb140610/toc:$VERSION --help# Windows
docker run --rm msb140610/toc:$env:VERSION --helpNote that the current version is
# Linux
VERSION=0.3# Windows
$env:VERSION=0.3Note also that a Docker compose script project has been
created that orchestrates songbook creation using this project, along with
rclone and pdftk.
Change requests are welcomed for this project. Once you have checked out the project and made your changes, to test these changes locally before you make the CR you can run the script with docker using
# Linux
docker run --rm -u $(id -u):$(id -g) -v $PWD:/app msb140610/toc:$VERSION /app/example# Windows
docker run --rm -v ${pwd}:/app msb140610/toc:$env:VERSION /app/exampleThis will run the script against the song files in the local example sub-folder
and output the TOC pdf in the same folder.
Alternatively, if you are making dependency changes, you can build your own docker image using
docker build -t toc-dev ... and then run the script using
# Linux
sdocker run --rm -u $(id -u):$(id -g) -v $PWD:/app toc-dev /app/example# Windows
docker run --rm -v ${pwd}:/app toc-dev /app/exampleTo maintain code quality you should also run mypy and
flake8 to check for warnings/errors as follows
# Linux
docker run --rm --entrypoint flake8 -v $PWD:/app toc-dev
docker run --rm --entrypoint mypy -v $PWD:/app toc-dev *.py# Windows
docker run --rm --entrypoint flake8 -v ${pwd}:/app toc-dev
docker run --rm --entrypoint mypy -v ${pwd}:/app toc-dev .