obp-epub-fixup

Collection of scripts to fix epub files programmatically

Work in progress

Run with docker

docker run --rm \
  -v /path/to/local.epub:/ebook_automation/epub_file.epub \
  -v /path/to/output:/ebook_automation/output \
  openbookpublishers/obp-epub-fixup

Alternatively you may clone the repo, build the image using docker build . -t some/tag and run the command above replacing openbookpublishers/obp-epub-fixup with some/tag.

Run locally

Setup

This software requires epubcheck, python3-bs4 and python-lxml to be installed on your system. On Debian (or Debian-based distributions) this package can be installed via

apt-get install epubcheck python3-bs4 python-lxml

You can check the requirements being met by running:

bash setup

Run

To run the process, place a copy of the epub edition of the book in the obp-epub-fixup folder. Finally, run:

bash run prefix

where prefix is the name of the book; i.e.: bash run Screpanti-Labour-Value.

-c and --check flags are available to verify if the newly produced ePub validates.

bash run -c prefix

Contents

These scripts refer specifically to our InDesing -> ePub workflow. Assumptions given here might be inaccurate in different settings.

./src/fix_toc_xhtml.py

As sections in toc.xhtml are named after filenames, this script parse each section of the book, looking for the content of <h1 class="heading1"> tags and write these back to the toc file.

Special sections (such as the copyright page) which might not include <h1> tags are named after pre-determined, convectional terms (hardcoded in a python dictionary).

./src/fix_toc_ncx.py

This script follows the same principle as ./src/fix_toc_xhtml.py, but changes apply to toc.ncx files. To ensure consistency, section names are parsed from the toc.xhtml file rather than fish out <h1 class="heading1"> tags from the book sections a second time.

./src/fix_title_tag.py

The content of the <title> tag is updated with the more accurate string stored in toc.xhtml. This process is repeated for all the book sections which appear in the toc.xhtml file.

Development

Use pre-commit.sh as a pre commit git hook to build a test image that will run flake8 to enforce PEP8 style.

ln -sf ../../pre-commit.sh .git/hooks/pre-commit