v13 release notes (2)

It seems that chocolately doesn't put gswin[32,64]c on PATH anymore,
so compensate.

.docker/Dockerfile

@@ -0,0 +1,80 @@
+# OCRmyPDF
+#
+
+FROM ubuntu:21.04 as base
+
+ENV LANG=C.UTF-8
+ENV TZ=UTC
+RUN echo 'debconf debconf/frontend select Noninteractive' | debconf-set-selections
+
+RUN apt-get update && apt-get install -y --no-install-recommends \
+  python3 \
+  libqpdf-dev \
+  zlib1g \
+  liblept5
+
+FROM base as builder
+
+# Note we need leptonica here to build jbig2
+RUN apt-get update && apt-get install -y --no-install-recommends \
+  build-essential autoconf automake libtool \
+  libleptonica-dev \
+  zlib1g-dev \
+  python3-dev \
+  python3-distutils \
+  libffi-dev \
+  ca-certificates \
+  curl \
+  git
+
+# Get the latest pip (Ubuntu version doesn't support manylinux2010)
+RUN \
+  curl https://bootstrap.pypa.io/get-pip.py | python3
+
+# Compile and install jbig2
+# Needs libleptonica-dev, zlib1g-dev
+RUN \
+  mkdir jbig2 \
+  && curl -L https://github.com/agl/jbig2enc/archive/ea6a40a.tar.gz | \
+  tar xz -C jbig2 --strip-components=1 \
+  && cd jbig2 \
+  && ./autogen.sh && ./configure && make && make install \
+  && cd .. \
+  && rm -rf jbig2
+
+COPY . /app
+
+WORKDIR /app
+
+RUN pip3 install --no-cache-dir .[test,webservice,watcher]
+
+FROM base
+
+RUN apt-get update && apt-get install -y --no-install-recommends \
+  ghostscript \
+  img2pdf \
+  libsm6 libxext6 libxrender-dev \
+  pngquant \
+  tesseract-ocr \
+  tesseract-ocr-chi-sim \
+  tesseract-ocr-deu \
+  tesseract-ocr-eng \
+  tesseract-ocr-fra \
+  tesseract-ocr-por \
+  tesseract-ocr-spa \
+  unpaper \
+  && rm -rf /var/lib/apt/lists/*
+
+WORKDIR /app
+
+COPY --from=builder /usr/local/lib/ /usr/local/lib/
+COPY --from=builder /usr/local/bin/ /usr/local/bin/
+
+COPY --from=builder /app/misc/webservice.py /app/
+COPY --from=builder /app/misc/watcher.py /app/
+
+# Copy minimal project files to get the test suite.
+COPY --from=builder /app/setup.cfg /app/setup.py /app/README.md /app/
+COPY --from=builder /app/tests /app/tests
+
+ENTRYPOINT ["/usr/local/bin/ocrmypdf"]

.dockerignore

@@ -0,0 +1,44 @@
+# dotfiles
+.*
+!.coveragerc
+!.dockerignore
+!.git_archival.txt
+!.gitattributes
+!.gitignore
+!.pre-commit-config.yaml
+!.readthedocs.yml
+
+# Dev scratch
+*.ipynb
+**/*.pyc
+/*.pdf
+/*.qdf
+/*.png
+/scratch.py
+IDEAS
+log/
+tests/resources/private/
+tmp/
+venv*/
+/debug_tests.py
+*.traineddata
+/private
+
+# Package building
+*.egg-info/
+build/
+dist/
+wheelhouse/
+pip-wheel-metadata/
+
+# Code coverage
+htmlcov/
+
+# Docker specific
+bin/
+docs/
+include/
+lib/
+
+# Docker include .git/
+!.git/

.git_archival.txt

@@ -0,0 +1 @@
+ref-names: $Format:%D$

.gitattributes

@@ -5,4 +5,10 @@
 # (binary is a macro for -text -diff)
 *.jar	binary
 *.pdf	binary
-*.PDF	binary
+*.PDF	binary
+*.png	binary
+*.jpg	binary
+*.bin   binary
+*.afdesign  binary
+
+.git_archival.txt  export-subst

.github/FUNDING.yml

@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: # Replace with a single Patreon username
+open_collective: james-barlow
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

.github/ISSUE_TEMPLATE/1-general-issues.md

@@ -0,0 +1,32 @@
+---
+name: General issues
+about: Installation, packages, dependencies, "nothing works", test suite failures...
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+What's the problem?
+
+**To Reproduce**
+Steps to reproduce the behavior.
+
+**Expected behavior**
+What did you expected to happen?
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**System (please complete the following information):**
+ - OS:
+ - Python version:
+ - OCRmyPDF version:
+
+**Installation**
+How did you install OCRmyPDF? Did you install it from your operating system's
+package manager, or using pip?
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/2-problem-with-a-specific-input-file.md

@@ -0,0 +1,40 @@
+---
+name: Problem with a specific input file
+about: Something went wrong while trying to OCR a specific file
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+What command line or API call were you trying to run?
+
+```bash
+ocrmypdf  ...arguments... input.pdf output.pdf
+```
+
+Run with verbosity or higher `-v1` to see more detailed logging. This information may be helpful.
+
+**Example file**
+If your issue is a problem that affects only certain files, and we will require an input file (PDF or image) that demonstrates your issue.
+
+Please provide an input file with no personal or confidential information. At your option you may [GPG-encrypt the file](https://github.com/jbarlow83/OCRmyPDF/wiki) for OCRmyPDF's author only.
+
+Links to files hosted elsewhere are perfectly acceptable. You could also look in ``tests/resources`` and see if any of those files reproduce your issue.
+
+*(Issues without example files usually cannot be resolved. It's like reporting an issue against a web browser without providing a URL.)*
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**System**
+ - OS: [e.g. Linux, Windows, macOS]
+ - OCRmyPDF Version: ``ocrmypdf --version``
+ - How did you install ocrmypdf? Did you use a system package manager, `pip`, or a Docker image?

.github/ISSUE_TEMPLATE/3-feature_request.md

@@ -0,0 +1,27 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered. Please include the versions of OCRmyPDF and other supporting programs (Tesseract OCR, Ghostscript) - maybe an alternative already exists in a newer version.
+
+**Example file**
+If your issue concerns how OCRmyPDF processes certain files, and please provide an example file that helps illustrate how OCRmyPDF's output could be improve.
+
+Please provide an input file with no personal or confidential information. At your option you may [GPG-encrypt the file](https://github.com/jbarlow83/OCRmyPDF/wiki) for OCRmyPDF's author only.
+
+Links to files hosted elsewhere are perfectly acceptable. You could also look in ``tests/resources`` and see if any of those files reproduce your issue.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/workflows/build.yml

@@ -0,0 +1,302 @@
+name: Test and deploy
+
+on:
+  push:
+    branches:
+      - master
+      - ci
+      - release/*
+      - feature/*
+    tags:
+      - v*
+    paths-ignore:
+      - README*
+  pull_request:
+
+jobs:
+  test_linux:
+    name: Test ${{ matrix.os }} with Python ${{ matrix.python }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        include:
+          - os: ubuntu-18.04
+            python: 3.7
+          - os: ubuntu-20.04
+            python: 3.8
+          - os: ubuntu-20.04
+            python: 3.9
+          - os: ubuntu-latest
+            python: 3.9
+          - os: ubuntu-latest
+            python: "pypy-3.7"
+          - os: ubuntu-latest
+            python: 3.9
+            tesseract5: true
+
+    env:
+      OS: ${{ matrix.os }}
+      PYTHON: ${{ matrix.python }}
+
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: "0" # 0=all, needed for setuptools-scm to resolve version tags
+
+      - uses: actions/setup-python@v2
+        name: Install Python
+        with:
+          python-version: ${{ matrix.python }}
+
+      - name: Install Tesseract 5
+        if: matrix.tesseract5
+        run: |
+          sudo add-apt-repository ppa:alex-p/tesseract-ocr-devel
+
+      - name: Install common packages
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y --no-install-recommends \
+            curl \
+            ghostscript \
+            img2pdf \
+            libffi-dev \
+            libsm6 libxext6 libxrender-dev \
+            pngquant \
+            poppler-utils \
+            tesseract-ocr \
+            tesseract-ocr-deu \
+            tesseract-ocr-eng \
+            tesseract-ocr-osd \
+            unpaper \
+            zlib1g
+
+      - name: Install Ubuntu 18.04 packages
+        if: matrix.os == 'ubuntu-18.04'
+        run: |
+          sudo apt-get install -y --no-install-recommends \
+            libexempi3
+
+      - name: Install Ubuntu 20.04 packages
+        if: matrix.os == 'ubuntu-20.04' || matrix.os == 'ubuntu-latest'
+        run: |
+          sudo apt-get install -y --no-install-recommends \
+            libexempi8
+
+      - name: Install Ubuntu packages for PyPy
+        if: startsWith(matrix.python, 'pypy')
+        run: |
+          sudo apt-get install -y --no-install-recommends \
+            libxml2-dev \
+            libxslt1-dev \
+            pypy3-dev
+
+      - name: Install Python packages
+        run: |
+          python -m pip install --upgrade pip wheel
+          python -m pip install .[test]
+
+      - name: Report versions
+        run: |
+          tesseract --version
+          gs --version
+          pngquant --version
+          unpaper --version
+          img2pdf --version
+
+      - name: Test
+        run: |
+          python -m pytest --cov-report xml --cov=ocrmypdf --cov=tests/ -n0 tests/
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v1
+        with:
+          files: ./coverage.xml
+          env_vars: OS,PYTHON
+
+  test_macos:
+    name: Test macOS
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [macos-latest]
+        python: ["3.9"]
+
+    env:
+      OS: ${{ matrix.os }}
+      PYTHON: ${{ matrix.python }}
+
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: "0" # 0=all, needed for setuptools-scm to resolve version tags
+
+      - uses: actions/setup-python@v2
+        name: Install Python
+        with:
+          python-version: ${{ matrix.python }}
+
+      - name: Install Homebrew deps
+        run: |
+          brew update
+          brew install \
+            exempi \
+            ghostscript \
+            jbig2enc \
+            openjpeg \
+            pngquant \
+            tesseract
+
+      - name: Install Python packages
+        run: |
+          python -m pip install --upgrade pip wheel
+          python -m pip install .[test]
+
+      - name: Report versions
+        run: |
+          tesseract --version
+          gs --version
+          pngquant --version
+          img2pdf --version
+
+      - name: Test
+        run: |
+          python -m pytest --cov-report xml --cov=ocrmypdf --cov=tests/ -n0 tests/
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v1
+        with:
+          files: ./coverage.xml
+          env_vars: OS,PYTHON
+
+  test_windows:
+    name: Test Windows
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [windows-latest]
+        python: ["3.9"]
+
+    env:
+      OS: ${{ matrix.os }}
+      PYTHON: ${{ matrix.python }}
+
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: "0" # 0=all, needed for setuptools-scm to resolve version tags
+
+      - uses: actions/setup-python@v2
+        name: Install Python
+        with:
+          python-version: ${{ matrix.python }}
+
+      - name: Install system packages
+        run: |
+          choco install --yes --no-progress --pre tesseract
+          choco install --yes --no-progress ghostscript
+          choco install --yes --no-progress pngquant
+
+      - name: Install Python packages
+        run: |
+          python -m pip install --upgrade pip wheel
+          python -m pip install .[test]
+
+      - name: Test
+        run: |
+          python -m pytest --cov-report xml --cov=ocrmypdf --cov=tests/ -n0 tests/
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v1
+        with:
+          files: ./coverage.xml
+          env_vars: OS,PYTHON
+
+  wheel_sdist_linux:
+    name: Build sdist and wheels
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: "0" # 0=all, needed for setuptools-scm to resolve version tags
+
+      - uses: actions/setup-python@v2
+        name: Install Python
+        with:
+          python-version: "3.7"
+
+      - name: Make wheels and sdist
+        run: |
+          python -m pip install --upgrade pip wheel
+          python setup.py sdist
+          python setup.py bdist_wheel
+
+      - uses: actions/upload-artifact@v2
+        with:
+          path: |
+            ./dist/*.whl
+            ./dist/*.tar.gz
+
+  upload_pypi:
+    name: Deploy artifacts to PyPI
+    needs: [wheel_sdist_linux, test_linux, test_macos, test_windows]
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags/v')
+    steps:
+      - uses: actions/download-artifact@v2
+        with:
+          name: artifact
+          path: dist
+
+      - uses: pypa/gh-action-pypi-publish@master
+        with:
+          user: __token__
+          password: ${{ secrets.TOKEN_PYPI }}
+          # repository_url: https://test.pypi.org/legacy/
+
+  docker:
+    name: Build Docker images
+    needs: [wheel_sdist_linux, test_linux, test_macos, test_windows]
+    runs-on: ubuntu-latest
+    if: github.event_name != 'pull_request'
+    steps:
+      - name: Set image tag to release or branch
+        run: echo "DOCKER_IMAGE_TAG=${GITHUB_REF##*/}" >> $GITHUB_ENV
+
+      - name: If master, set to latest
+        run: echo 'DOCKER_IMAGE_TAG=latest' >> $GITHUB_ENV
+        if: env.DOCKER_IMAGE_TAG == 'master'
+
+      - name: Set Docker Hub repository to username
+        run: echo "DOCKER_REPOSITORY=jbarlow83" >> $GITHUB_ENV
+
+      - name: Set image name
+        run: echo "DOCKER_IMAGE_NAME=ocrmypdf" >> $GITHUB_ENV
+
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: "0" # 0=all, needed for setuptools-scm to resolve version tags
+
+      - name: Login to Docker Hub
+        uses: docker/login-action@v1
+        with:
+          username: jbarlow83
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v1
+
+      - name: Set up Docker Buildx
+        id: buildx
+        uses: docker/setup-buildx-action@v1
+
+      - name: Print image tag
+        run: echo "Building image ${DOCKER_REPOSITORY}/${DOCKER_IMAGE_NAME}:${DOCKER_IMAGE_TAG}"
+
+      - name: Build
+        run: |
+          docker buildx build \
+            --push \
+            --platform linux/arm64/v8,linux/amd64  \
+            --tag "${DOCKER_REPOSITORY}/${DOCKER_IMAGE_NAME}:${DOCKER_IMAGE_TAG}" \
+            --file .docker/Dockerfile .

.gitignore

@@ -1,17 +1,45 @@
-tmp/
-log/
-*.pyc
-tests/output/
-.ruffus_history.sqlite
-*.sublime-*
+# dotfiles
+.*
+!.coveragerc
+!.dockerignore
+!.git_archival.txt
+!.gitattributes
+!.gitignore
+!.pre-commit-config.yaml
+!.readthedocs.yaml
+!.github/
+!.docker/
+
+# Dev scratch
+*.ipynb
+**/*.pyc
 /*.pdf
+/*.qdf
+/*.png
+/scratch.py
+IDEAS
+log/
+tests/resources/private/
+tmp/
+venv*/
+/debug_tests.py
+*.traineddata
+/private
+/coverage.xml
+
+# Package building
+*.egg-info/
 build/
 dist/
-*.egg-info/
-venv/
-*/test/output
-bin/
-include/
-lib/
-pip-selfcheck.json
-pyvenv.cfg
+wheelhouse/
+pip-wheel-metadata/
+
+# Code coverage
+htmlcov/
+
+# Automatically generated files
+docs/_build/
+docs/_static/
+docs/_templates/
+docs/Makefile
+ocrmypdf/lib/_*.py

.pre-commit-config.yaml

@@ -0,0 +1,37 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.0.1
+    hooks:
+      - id: check-case-conflict
+      - id: check-merge-conflict
+      - id: check-toml
+      - id: check-yaml
+      - id: debug-statements
+  - repo: https://github.com/pycqa/isort
+    rev: 5.9.3
+    hooks:
+      - id: isort
+        args: ["--profile", "black"]
+  - repo: https://github.com/psf/black
+    rev: 21.9b0
+    hooks:
+      - id: black
+        language_version: python
+  - repo: https://github.com/asottile/setup-cfg-fmt
+    rev: v1.19.0
+    hooks:
+      - id: setup-cfg-fmt
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v2.29.0
+    hooks:
+      - id: pyupgrade
+        args: ["--py37-plus"]
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v0.910-1
+    hooks:
+      - id: mypy
+        additional_dependencies:
+          - types-toml
+          - types-setuptools
+          - types-requests
+          - types-Pillow

.readthedocs.yaml

@@ -0,0 +1,22 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# Optionally build your docs in additional formats such as PDF
+formats:
+  - pdf
+
+# Optionally set the version of Python and requirements required to build your docs
+python:
+  version: 3.7
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs

LICENSE

@@ -0,0 +1,373 @@
+Mozilla Public License Version 2.0
+==================================
+
+1. Definitions
+--------------
+
+1.1. "Contributor"
+    means each individual or legal entity that creates, contributes to
+    the creation of, or owns Covered Software.
+
+1.2. "Contributor Version"
+    means the combination of the Contributions of others (if any) used
+    by a Contributor and that particular Contributor's Contribution.
+
+1.3. "Contribution"
+    means Covered Software of a particular Contributor.
+
+1.4. "Covered Software"
+    means Source Code Form to which the initial Contributor has attached
+    the notice in Exhibit A, the Executable Form of such Source Code
+    Form, and Modifications of such Source Code Form, in each case
+    including portions thereof.
+
+1.5. "Incompatible With Secondary Licenses"
+    means
+
+    (a) that the initial Contributor has attached the notice described
+        in Exhibit B to the Covered Software; or
+
+    (b) that the Covered Software was made available under the terms of
+        version 1.1 or earlier of the License, but not also under the
+        terms of a Secondary License.
+
+1.6. "Executable Form"
+    means any form of the work other than Source Code Form.
+
+1.7. "Larger Work"
+    means a work that combines Covered Software with other material, in
+    a separate file or files, that is not Covered Software.
+
+1.8. "License"
+    means this document.
+
+1.9. "Licensable"
+    means having the right to grant, to the maximum extent possible,
+    whether at the time of the initial grant or subsequently, any and
+    all of the rights conveyed by this License.
+
+1.10. "Modifications"
+    means any of the following:
+
+    (a) any file in Source Code Form that results from an addition to,
+        deletion from, or modification of the contents of Covered
+        Software; or
+
+    (b) any new file in Source Code Form that contains any Covered
+        Software.
+
+1.11. "Patent Claims" of a Contributor
+    means any patent claim(s), including without limitation, method,
+    process, and apparatus claims, in any patent Licensable by such
+    Contributor that would be infringed, but for the grant of the
+    License, by the making, using, selling, offering for sale, having
+    made, import, or transfer of either its Contributions or its
+    Contributor Version.
+
+1.12. "Secondary License"
+    means either the GNU General Public License, Version 2.0, the GNU
+    Lesser General Public License, Version 2.1, the GNU Affero General
+    Public License, Version 3.0, or any later versions of those
+    licenses.
+
+1.13. "Source Code Form"
+    means the form of the work preferred for making modifications.
+
+1.14. "You" (or "Your")
+    means an individual or a legal entity exercising rights under this
+    License. For legal entities, "You" includes any entity that
+    controls, is controlled by, or is under common control with You. For
+    purposes of this definition, "control" means (a) the power, direct
+    or indirect, to cause the direction or management of such entity,
+    whether by contract or otherwise, or (b) ownership of more than
+    fifty percent (50%) of the outstanding shares or beneficial
+    ownership of such entity.
+
+2. License Grants and Conditions
+--------------------------------
+
+2.1. Grants
+
+Each Contributor hereby grants You a world-wide, royalty-free,
+non-exclusive license:
+
+(a) under intellectual property rights (other than patent or trademark)
+    Licensable by such Contributor to use, reproduce, make available,
+    modify, display, perform, distribute, and otherwise exploit its
+    Contributions, either on an unmodified basis, with Modifications, or
+    as part of a Larger Work; and
+
+(b) under Patent Claims of such Contributor to make, use, sell, offer
+    for sale, have made, import, and otherwise transfer either its
+    Contributions or its Contributor Version.
+
+2.2. Effective Date
+
+The licenses granted in Section 2.1 with respect to any Contribution
+become effective for each Contribution on the date the Contributor first
+distributes such Contribution.
+
+2.3. Limitations on Grant Scope
+
+The licenses granted in this Section 2 are the only rights granted under
+this License. No additional rights or licenses will be implied from the
+distribution or licensing of Covered Software under this License.
+Notwithstanding Section 2.1(b) above, no patent license is granted by a
+Contributor:
+
+(a) for any code that a Contributor has removed from Covered Software;
+    or
+
+(b) for infringements caused by: (i) Your and any other third party's
+    modifications of Covered Software, or (ii) the combination of its
+    Contributions with other software (except as part of its Contributor
+    Version); or
+
+(c) under Patent Claims infringed by Covered Software in the absence of
+    its Contributions.
+
+This License does not grant any rights in the trademarks, service marks,
+or logos of any Contributor (except as may be necessary to comply with
+the notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+
+No Contributor makes additional grants as a result of Your choice to
+distribute the Covered Software under a subsequent version of this
+License (see Section 10.2) or under the terms of a Secondary License (if
+permitted under the terms of Section 3.3).
+
+2.5. Representation
+
+Each Contributor represents that the Contributor believes its
+Contributions are its original creation(s) or it has sufficient rights
+to grant the rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+
+This License is not intended to limit any rights You have under
+applicable copyright doctrines of fair use, fair dealing, or other
+equivalents.
+
+2.7. Conditions
+
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
+in Section 2.1.
+
+3. Responsibilities
+-------------------
+
+3.1. Distribution of Source Form
+
+All distribution of Covered Software in Source Code Form, including any
+Modifications that You create or to which You contribute, must be under
+the terms of this License. You must inform recipients that the Source
+Code Form of the Covered Software is governed by the terms of this
+License, and how they can obtain a copy of this License. You may not
+attempt to alter or restrict the recipients' rights in the Source Code
+Form.
+
+3.2. Distribution of Executable Form
+
+If You distribute Covered Software in Executable Form then:
+
+(a) such Covered Software must also be made available in Source Code
+    Form, as described in Section 3.1, and You must inform recipients of
+    the Executable Form how they can obtain a copy of such Source Code
+    Form by reasonable means in a timely manner, at a charge no more
+    than the cost of distribution to the recipient; and
+
+(b) You may distribute such Executable Form under the terms of this
+    License, or sublicense it under different terms, provided that the
+    license for the Executable Form does not attempt to limit or alter
+    the recipients' rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+You may create and distribute a Larger Work under terms of Your choice,
+provided that You also comply with the requirements of this License for
+the Covered Software. If the Larger Work is a combination of Covered
+Software with a work governed by one or more Secondary Licenses, and the
+Covered Software is not Incompatible With Secondary Licenses, this
+License permits You to additionally distribute such Covered Software
+under the terms of such Secondary License(s), so that the recipient of
+the Larger Work may, at their option, further distribute the Covered
+Software under the terms of either this License or such Secondary
+License(s).
+
+3.4. Notices
+
+You may not remove or alter the substance of any license notices
+(including copyright notices, patent notices, disclaimers of warranty,
+or limitations of liability) contained within the Source Code Form of
+the Covered Software, except that You may alter any license notices to
+the extent required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+
+You may choose to offer, and to charge a fee for, warranty, support,
+indemnity or liability obligations to one or more recipients of Covered
+Software. However, You may do so only on Your own behalf, and not on
+behalf of any Contributor. You must make it absolutely clear that any
+such warranty, support, indemnity, or liability obligation is offered by
+You alone, and You hereby agree to indemnify every Contributor for any
+liability incurred by such Contributor as a result of warranty, support,
+indemnity or liability terms You offer. You may include additional
+disclaimers of warranty and limitations of liability specific to any
+jurisdiction.
+
+4. Inability to Comply Due to Statute or Regulation
+---------------------------------------------------
+
+If it is impossible for You to comply with any of the terms of this
+License with respect to some or all of the Covered Software due to
+statute, judicial order, or regulation then You must: (a) comply with
+the terms of this License to the maximum extent possible; and (b)
+describe the limitations and the code they affect. Such description must
+be placed in a text file included with all distributions of the Covered
+Software under this License. Except to the extent prohibited by statute
+or regulation, such description must be sufficiently detailed for a
+recipient of ordinary skill to be able to understand it.
+
+5. Termination
+--------------
+
+5.1. The rights granted under this License will terminate automatically
+if You fail to comply with any of its terms. However, if You become
+compliant, then the rights granted under this License from a particular
+Contributor are reinstated (a) provisionally, unless and until such
+Contributor explicitly and finally terminates Your grants, and (b) on an
+ongoing basis, if such Contributor fails to notify You of the
+non-compliance by some reasonable means prior to 60 days after You have
+come back into compliance. Moreover, Your grants from a particular
+Contributor are reinstated on an ongoing basis if such Contributor
+notifies You of the non-compliance by some reasonable means, this is the
+first time You have received notice of non-compliance with this License
+from such Contributor, and You become compliant prior to 30 days after
+Your receipt of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent
+infringement claim (excluding declaratory judgment actions,
+counter-claims, and cross-claims) alleging that a Contributor Version
+directly or indirectly infringes any patent, then the rights granted to
+You by any and all Contributors for the Covered Software under Section
+2.1 of this License shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all
+end user license agreements (excluding distributors and resellers) which
+have been validly granted by You or Your distributors under this License
+prior to termination shall survive termination.
+
+************************************************************************
+*                                                                      *
+*  6. Disclaimer of Warranty                                           *
+*  -------------------------                                           *
+*                                                                      *
+*  Covered Software is provided under this License on an "as is"       *
+*  basis, without warranty of any kind, either expressed, implied, or  *
+*  statutory, including, without limitation, warranties that the       *
+*  Covered Software is free of defects, merchantable, fit for a        *
+*  particular purpose or non-infringing. The entire risk as to the     *
+*  quality and performance of the Covered Software is with You.        *
+*  Should any Covered Software prove defective in any respect, You     *
+*  (not any Contributor) assume the cost of any necessary servicing,   *
+*  repair, or correction. This disclaimer of warranty constitutes an   *
+*  essential part of this License. No use of any Covered Software is   *
+*  authorized under this License except under this disclaimer.         *
+*                                                                      *
+************************************************************************
+
+************************************************************************
+*                                                                      *
+*  7. Limitation of Liability                                          *
+*  --------------------------                                          *
+*                                                                      *
+*  Under no circumstances and under no legal theory, whether tort      *
+*  (including negligence), contract, or otherwise, shall any           *
+*  Contributor, or anyone who distributes Covered Software as          *
+*  permitted above, be liable to You for any direct, indirect,         *
+*  special, incidental, or consequential damages of any character      *
+*  including, without limitation, damages for lost profits, loss of    *
+*  goodwill, work stoppage, computer failure or malfunction, or any    *
+*  and all other commercial damages or losses, even if such party      *
+*  shall have been informed of the possibility of such damages. This   *
+*  limitation of liability shall not apply to liability for death or   *
+*  personal injury resulting from such party's negligence to the       *
+*  extent applicable law prohibits such limitation. Some               *
+*  jurisdictions do not allow the exclusion or limitation of           *
+*  incidental or consequential damages, so this exclusion and          *
+*  limitation may not apply to You.                                    *
+*                                                                      *
+************************************************************************
+
+8. Litigation
+-------------
+
+Any litigation relating to this License may be brought only in the
+courts of a jurisdiction where the defendant maintains its principal
+place of business and such litigation shall be governed by laws of that
+jurisdiction, without reference to its conflict-of-law provisions.
+Nothing in this Section shall prevent a party's ability to bring
+cross-claims or counter-claims.
+
+9. Miscellaneous
+----------------
+
+This License represents the complete agreement concerning the subject
+matter hereof. If any provision of this License is held to be
+unenforceable, such provision shall be reformed only to the extent
+necessary to make it enforceable. Any law or regulation which provides
+that the language of a contract shall be construed against the drafter
+shall not be used to construe this License against a Contributor.
+
+10. Versions of the License
+---------------------------
+
+10.1. New Versions
+
+Mozilla Foundation is the license steward. Except as provided in Section
+10.3, no one other than the license steward has the right to modify or
+publish new versions of this License. Each version will be given a
+distinguishing version number.
+
+10.2. Effect of New Versions
+
+You may distribute the Covered Software under the terms of the version
+of the License under which You originally received the Covered Software,
+or under the terms of any subsequent version published by the license
+steward.
+
+10.3. Modified Versions
+
+If you create software not governed by this License, and you want to
+create a new license for such software, you may create and use a
+modified version of this License if you rename the license and remove
+any references to the name of the license steward (except to note that
+such modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary
+Licenses
+
+If You choose to distribute Source Code Form that is Incompatible With
+Secondary Licenses under the terms of this version of the License, the
+notice described in Exhibit B of this License must be attached.
+
+Exhibit A - Source Code Form License Notice
+-------------------------------------------
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+If it is not possible or desirable to put the notice in a particular
+file, then You may include the notice in a location (such as a LICENSE
+file in a relevant directory) where a recipient would be likely to look
+for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+Exhibit B - "Incompatible With Secondary Licenses" Notice
+---------------------------------------------------------
+
+  This Source Code Form is "Incompatible With Secondary Licenses", as
+  defined by the Mozilla Public License, v. 2.0.

LICENSE.rst

@@ -1,20 +0,0 @@
-Copyright (c) 2013-2015, The OCRmyPDF Authors
-
-Permission is hereby granted, free of charge, to any person obtaining a
-copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be included
-in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
-OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

MANIFEST.in

@@ -1,4 +0,0 @@
-recursive-include ocrmypdf/jhove/bin *.jar
-recursive-include ocrmypdf/jhove/lib *.jar
-recursive-include ocrmypdf/jhove/conf *.conf
-recursive-exclude tests/output *

OCRmyPDF.sh

@@ -1,6 +0,0 @@
-#!/bin/sh
-##############################################################################
-# Copyright (c) 2013-14: fritz-hh from Github (https://github.com/fritz-hh)
-##############################################################################
-
-python3 -m ocrmypdf.main "$@"

README.md

@@ -0,0 +1,143 @@
+<img src="docs/images/logo.svg" width="240" alt="OCRmyPDF">
+
+[![Build Status](https://github.com/jbarlow83/OCRmyPDF/actions/workflows/build.yml/badge.svg)](https://github.com/jbarlow83/OCRmyPDF/actions/workflows/build.yml) [![PyPI version][pypi]](https://pypi.org/project/ocrmypdf/) ![Homebrew version][homebrew] ![ReadTheDocs][docs] ![Python versions][pyversions]
+
+[azure]: https://dev.azure.com/jim0585/ocrmypdf/_apis/build/status/jbarlow83.OCRmyPDF?branchName=master
+[travis]: https://travis-ci.org/jbarlow83/OCRmyPDF.svg?branch=master "Travis build status"
+[pypi]: https://img.shields.io/pypi/v/ocrmypdf.svg "PyPI version"
+[homebrew]: https://img.shields.io/homebrew/v/ocrmypdf.svg "Homebrew version"
+[docs]: https://readthedocs.org/projects/ocrmypdf/badge/?version=latest "RTD"
+[pyversions]: https://img.shields.io/pypi/pyversions/ocrmypdf "Supported Python versions"
+
+OCRmyPDF adds an OCR text layer to scanned PDF files, allowing them to be searched or copy-pasted.
+
+```bash
+ocrmypdf                      # it's a scriptable command line program
+   -l eng+fra                 # it supports multiple languages
+   --rotate-pages             # it can fix pages that are misrotated
+   --deskew                   # it can deskew crooked PDFs!
+   --title "My PDF"           # it can change output metadata
+   --jobs 4                   # it uses multiple cores by default
+   --output-type pdfa         # it produces PDF/A by default
+   input_scanned.pdf          # takes PDF input (or images)
+   output_searchable.pdf      # produces validated PDF output
+```
+
+[See the release notes for details on the latest changes](https://ocrmypdf.readthedocs.io/en/latest/release_notes.html).
+
+## Main features
+
+- Generates a searchable [PDF/A](https://en.wikipedia.org/?title=PDF/A) file from a regular PDF
+- Places OCR text accurately below the image to ease copy / paste
+- Keeps the exact resolution of the original embedded images
+- When possible, inserts OCR information as a "lossless" operation without disrupting any other content
+- Optimizes PDF images, often producing files smaller than the input file
+- If requested, deskews and/or cleans the image before performing OCR
+- Validates input and output files
+- Distributes work across all available CPU cores
+- Uses [Tesseract OCR](https://github.com/tesseract-ocr/tesseract) engine to recognize more than [100 languages](https://github.com/tesseract-ocr/tessdata)
+- Scales properly to handle files with thousands of pages
+- Battle-tested on millions of PDFs
+
+For details: please consult the [documentation](https://ocrmypdf.readthedocs.io/en/latest/).
+
+## Motivation
+
+I searched the web for a free command line tool to OCR PDF files: I found many, but none of them were really satisfying:
+
+- Either they produced PDF files with misplaced text under the image (making copy/paste impossible)
+- Or they did not handle accents and multilingual characters
+- Or they changed the resolution of the embedded images
+- Or they generated ridiculously large PDF files
+- Or they crashed when trying to OCR
+- Or they did not produce valid PDF files
+- On top of that none of them produced PDF/A files (format dedicated for long time storage)
+
+...so I decided to develop my own tool.
+
+## Installation
+
+Linux, Windows, macOS and FreeBSD are supported. Docker images are also available, for both x64 and ARM.
+
+| Operating system              | Install command               |
+| ----------------------------- | ------------------------------|
+| Debian, Ubuntu                | ``apt install ocrmypdf``      |
+| Windows Subsystem for Linux   | ``apt install ocrmypdf``      |
+| Fedora                        | ``dnf install ocrmypdf``      |
+| macOS                         | ``brew install ocrmypdf``     |
+| LinuxBrew                     | ``brew install ocrmypdf``     |
+| FreeBSD                       | ``pkg install py37-ocrmypdf`` |
+| Conda                         | ``conda install ocrmypdf``    |
+
+For everyone else, [see our documentation](https://ocrmypdf.readthedocs.io/en/latest/installation.html) for installation steps.
+
+## Languages
+
+OCRmyPDF uses Tesseract for OCR, and relies on its language packs. For Linux users, you can often find packages that provide language packs:
+
+```bash
+# Display a list of all Tesseract language packs
+apt-cache search tesseract-ocr
+
+# Debian/Ubuntu users
+apt-get install tesseract-ocr-chi-sim  # Example: Install Chinese Simplified language pack
+
+# Arch Linux users
+pacman -S tesseract-data-eng tesseract-data-deu # Example: Install the English and German language packs
+
+# brew macOS users
+brew install tesseract-lang
+```
+
+You can then pass the `-l LANG` argument to OCRmyPDF to give a hint as to what languages it should search for. Multiple languages can be requested.
+
+OCRmyPDF supports Tesseract 4.0 and the beta versions of Tesseract 5.0. It will
+automatically use whichever version it finds first on the `PATH` environment
+variable. On Windows, if `PATH` does not provide a Tesseract binary, we use
+the highest version number that is installed according to the Windows Registry.
+
+## Documentation and support
+
+Once OCRmyPDF is installed, the built-in help which explains the command syntax and options can be accessed via:
+
+```bash
+ocrmypdf --help
+```
+
+Our [documentation is served on Read the Docs](https://ocrmypdf.readthedocs.io/en/latest/index.html).
+
+Please report issues on our [GitHub issues](https://github.com/jbarlow83/OCRmyPDF/issues) page, and follow the issue template for quick response.
+
+## Requirements
+
+In addition to the required Python version (3.7+), OCRmyPDF requires external program installations of Ghostscript and Tesseract OCR. OCRmyPDF is pure Python, and runs on pretty much everything: Linux, macOS, Windows and FreeBSD.
+
+## Press & Media
+
+- [Going paperless with OCRmyPDF](https://medium.com/@ikirichenko/going-paperless-with-ocrmypdf-e2f36143f46a)
+- [Converting a scanned document into a compressed searchable PDF with redactions](https://medium.com/@treyharris/converting-a-scanned-document-into-a-compressed-searchable-pdf-with-redactions-63f61c34fe4c)
+- [c't 1-2014, page 59](https://heise.de/-2279695): Detailed presentation of OCRmyPDF v1.0 in the leading German IT magazine c't
+- [heise Open Source, 09/2014: Texterkennung mit OCRmyPDF](https://heise.de/-2356670)
+- [heise Durchsuchbare PDF-Dokumente mit OCRmyPDF erstellen](https://www.heise.de/ratgeber/Durchsuchbare-PDF-Dokumente-mit-OCRmyPDF-erstellen-4607592.html)
+- [Excellent Utilities: OCRmyPDF](https://www.linuxlinks.com/excellent-utilities-ocrmypdf-add-ocr-text-layer-scanned-pdfs/)
+- [LinuxUser Texterkennung mit OCRmyPDF und Scanbd automatisieren](https://www.linux-community.de/ausgaben/linuxuser/2021/06/texterkennung-mit-ocrmypdf-und-scanbd-automatisieren/)
+
+## Business enquiries
+
+OCRmyPDF would not be the software that it is today without companies and users choosing to provide support for feature development and consulting enquiries. We are happy to discuss all enquiries, whether for extending the existing feature set, or integrating OCRmyPDF into a larger system.
+
+## License
+
+The OCRmyPDF software is licensed under the Mozilla Public License 2.0
+(MPL-2.0). This license permits integration of OCRmyPDF with other code,
+included commercial and closed source, but asks you to publish source-level
+modifications you make to OCRmyPDF.
+
+Some components of OCRmyPDF have other licenses, as noted in those files and the
+``debian/copyright`` file. Most files in ``misc/`` use the MIT license, and the
+documentation and test files are generally licensed under Creative Commons
+ShareAlike 4.0 (CC-BY-SA 4.0).
+
+## Disclaimer
+
+The software is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

README.rst

@@ -1,95 +0,0 @@
-OCRmyPDF
-========
-
-OCRmyPDF adds an OCR text layer to scanned PDF files, allowing them to
-be searched.
-
-Main features
--------------
-
--  Generates a searchable
-   `PDF/A <https://en.wikipedia.org/?title=PDF/A>`__ file from a PDF
-   file containing only images
--  Places OCRed text accurately below the image to ease copy / paste
--  Keeps the exact resolution of the original embedded images
-
-   -  or if requested oversamples the images before OCRing so as to get
-      better results
-
--  If requested deskews and/or cleans the image before performing OCR
--  Validates the generated file against the PDF/A-1b specification using
-   `JHOVE <http://jhove.sourceforge.net/>`__
--  Provides debug mode to enable easy verification of the OCR results
--  Processes several pages in parallel when more than one CPU core is
-   available
--  Uses Tesseract OCR engine
-
-For details: please consult the release notes
-
-Motivation
-----------
-
-I searched the web for a free command line tool to OCR PDF files on
-Linux/UNIX: I found many, but none of them were really satisfying. -
-Either they produced PDF files with misplaced text under the image
-(making copy/paste impossible) - Or they did not display correctly some
-escaped HTML characters located in the hocr file produced by the OCR
-engine - Or they changed the resolution of the embedded images - Or they
-generated PDF file having a ridiculous big size - Or they crashed when
-trying to OCR some of my PDF files - Or they did not produce valid PDF
-files (even though they were readable with my current PDF reader) - On
-top of that none of them produced PDF/A files (format dedicated for long
-time storage / archiving)
-
-... so I decided to develop my own tool (using various existing scripts
-as an inspiration)
-
-Install
--------
-
-Download OCRmyPDF here: https://github.com/fritz-hh/OCRmyPDF/releases
-
-To install, download the tarball and run:
-
-    pip install ocrmypdf-3.0rc2.tar.gz
-
-You can install it within a virtual environment or system-wide.
-
-To run the program::
-   
-   ocrmypdf --help
-
-If not yet installed, the script will notify you about dependencies that
-need to be installed. The script requires specific versions of the
-dependencies. Older version than the ones mentioned in the release notes
-are likely not to be compatible to OCRmyPDF.
-
-Support
--------
-
-In case you detect an issue, please:
-
--  Check if your issue is already known
--  If no problem report exists on github, please create one here:
-   https://github.com/fritz-hh/OCRmyPDF/issues
--  Describe your problem thoroughly
--  Append the console output of the script when running the debug mode
-   (-v 1 option)
--  If possible provide your input PDF file as well as the content of the
-   temporary folder (using a file sharing service like
-   www.file-upload.net)
-
-Press & Media
--------------
-
--  `c't 1-2014, page 59 <http://www.heise.de/ct/inhalt/2014/1/58/>`__:
-   Detailed presentation of OCRmyPDF v1.0 in the leading German IT
-   magazine c't
--  `heise Open Source, 09/2014: Texterkennung mit
-   OCRmyPDF <http://www.heise.de/-2356670>`__
-
-Disclaimer
-----------
-
-The software is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
-CONDITIONS OF ANY KIND, either express or implied.

RELEASE_NOTES.rst

@@ -1,452 +0,0 @@
-RELEASE NOTES
-=============
-
-Please always read this file before installing the package
-
-Download software here: https://github.com/fritz-hh/OCRmyPDF/tags
-
-v3.0-rc2:
-=========
-
-New features
-------------
-
--  Easier installation with Python's package manager 
--  Now installs ``ocrmypdf`` to ``/usr/local/bin`` or equivalent for system-wide
-   access
--  Tesseract 3.03 PDF page can be used instead for better positioning
-   of recognized text (``--pdf-renderer tesseract``)
--  Improved command line syntax and usage help (``--help``)
--  PDF metadata (title, author, keywords) are now transferred to the 
-   output PDF
--  PDF metadata can also be set from the command line (``--title``, etc.)
--  Added test cases to confirm everything is working
--  Added option to skip extremely large pages that take too long to OCR and are 
-   often not OCRable (e.g. large scanned maps or diagrams); other pages are still
-   processed (``--skip-big``)
--  Added option to kill Tesseract OCR process if it seems to be taking too long on
-   a page, while still processing other pages (``--tesseract-timeout``)
-
-Changes
--------
-
--  New, robust rewrite in Python 3.4+ with ruffus_ pipelines
--  Now uses Ghostscript 9.14's improved color conversion model
--  All "tasks" in the pipeline can be executed in parallel on any
-   available CPUs, increasing performance
--  The ``-o DPI`` argument has been phased out, in favor of ``--oversample DPI``
--  Removed several dependencies, so it's easier to install.  We no 
-   longer use:
-   
-   - GNU parallel_
-   - ImageMagick_
-   - Python 2.7
-   - shell scripts
-
--  Some new external dependencies are required:
-
-   - MuPDF_ tools
-   - Ghostscript 9.14+
-   - Unpaper_ 6.1 (optional)
-   - some automatically managed Python dependencies
-  
-.. _ruffus: http://www.ruffus.org.uk/index.html
-.. _parallel: https://www.gnu.org/software/parallel/
-.. _ImageMagick: http://www.imagemagick.org/script/index.php
-.. _MuPDF: http://mupdf.com/docs/
-.. _Unpaper: https://github.com/Flameeyes/unpaper
-
-Compatibility notes
--------------------
-
--  ``./OCRmyPDF.sh`` script is still available for now
--  Stacking the verbosity option like ``-vvv`` is no longer supported
-
--  The configuration file ``config.sh`` has been removed.  Instead, you can
-   feed a file to the arguments for common settings:
-
-::
-
-   ocrmypdf input.pdf output.pdf @settings.txt
-
-where ``settings.txt`` contains, for example:
-
-::
-
-   -l deu --author 'A. Merkel' --pdf-renderer tesseract
-
-
-Fixes
------
-
--  Handling of filenames containing spaces: fixed
-
-Notes
------
-
--  Some dependencies may work with lower versions than tested, so try
-   overriding dependencies if they are "in the way" to see if they work.
-
-
-v2.2-stable (2014-09-29):
-=======
-
-New features
-------------
-
-- None
-
-Changes
--------
-
-- Update to jhove v1.11
-- Request the python library reportlab v3.0 or newer (So that we could remove a patch to the previous version of reportlab leading to issues for some users)
-
-Fixes
------
-
-- Fix bug on Mac OS X (resolution of simlink to OCRmyPDF.sh script) (thanks to jbarlow83)
-- Check if the input pdf file exists before to continue
-
-Tested with
------------
-
-- Operating system: FreeBSD 9.2
-- Dependencies:
-   - parallel 20140822
-   - poppler-utils 0.24.5
-   - ImageMagick 6.8.9-4 2014-09-17
-   - Unpaper 0.3
-   - tesseract 3.02.02
-   - Python 2.7.8
-   - ghostcript (gs): 9.06
-   - java: openjdk version "1.7.0_65"
-
-
-v2.1-stable (2014-09-20):
-=========================
-
-New features
-------------
-
--  None
-
-Changes
--------
-
--  None
-
-Fixes
------
-
--  Allow execution via simlink
--  Add support for tesseract 3.03
--  Add support for newer version of reportlab
--  Lowered minimum version of gnu parallel
--  Various typo
-
-Tested with
------------
-
--  Operating system: FreeBSD 9.1
--  Dependencies:
--  parallel 20130222
--  poppler-utils 0.22.2
--  ImageMagick 6.8.0-7 2013-03-30
--  Unpaper 0.3
--  tesseract 3.02.02
--  Python 2.7.3
--  ghoscript (gs): 9.06
--  java: openjdk version "1.7.0\_17"
-
-v2.0-stable (2014-01-25):
-=========================
-
-New features
-------------
-
--  Check if the language(s) passed using the -l option is supported by
-   tesseract (fixes #60)
-
-Changes
--------
-
--  Allow OCRmyPDF to be used with tesseract 3.02.01, even though OCR
-   might fail for few PDF file (see issue #28). Rationale: For some
-   linux distribution, no newer version than tesseract 3.02.01 is
-   available
-
-Fixes
------
-
--  More robust algorithm for checking the version of the installed
-   tesseract package
-
-Tested with
------------
-
--  Operating system: FreeBSD 9.1
--  Dependencies:
--  parallel 20130222
--  poppler-utils 0.22.2
--  ImageMagick 6.8.0-7 2013-03-30
--  Unpaper 0.3
--  tesseract 3.02.02
--  Python 2.7.3
--  ghoscript (gs): 9.06
--  java: openjdk version "1.7.0\_17"
-
-v2.0-rc2 (2014-01-16):
-======================
-
-New features
-------------
-
--  None
-
-Changes
--------
-
--  Size reduction of final PDF file: (fixes #50)
--  Support for monochrome (Black&White) images (massive size reduction
-   in final PDF: >80%)
--  Reduced size of grayscale images (by 13% on test PDF file)
--  Preventing fi, fl ligatures does not require anymore to pass an
-   additional config file to tesseract using the -C option (fixes #58)
--  Location of temporary folder according to content of environment
-   variable TMPDIR.
--  Dependency to pdftk removed
--  Check for compatible versions of dependencies: (fixes #51)
--  parallel and tesseract
--  python libraries reportlab and lxml
-
-Fixes
------
-
--  Improved portability with various shells (dash, bash, tcsh) and OS
-   (FreeBSD, MAC OSX, Linux) (fixes #59)
--  Corrected bug in case the input PDF file contains a space character
-   (fixes #48)
--  Prevent spurious error message in case there is no image in a PDF
-   page
--  Prevent collision of temporary folder names (fixes #57)
-
-Tested with
------------
-
--  Operating system: FreeBSD 9.1
--  Dependencies:
--  parallel 20130222
--  poppler-utils 0.22.2
--  ImageMagick 6.8.0-7 2013-03-30
--  Unpaper 0.3
--  tesseract 3.02.02
--  Python 2.7.3
--  ghoscript (gs): 9.06
--  java: openjdk version "1.7.0\_17"
-
-v2.0-rc1 (2014-01-07):
-======================
-
-New features
-------------
-
--  Huge performance improvement on machines having multiple CPU/cores
-   (processing of several pages concurrently) (fixes #18)
--  By default prevent from processing a PDF file already containing
-   fonts (i.e. text)(it can be overridden with the -f flag) (fixes #16)
--  Warn if the resolution is too low to get reasonable OCR results
-   (fixes #37)
--  New option (-o) to perform automatic oversampling if the image
-   resolution is too low. This can improve OCR results.
--  Warn if using a tesseract version older than v3.02.02 (as older
-   versions are known to produce invalid output) (fixes #41)
--  Echo version of the installed dependencies (e.g. tesseract) in debug
-   mode in order to ease support (fixes #35)
--  Echo the arguments passed to the script in debug mode to ease support
-
-Changes
--------
-
--  In debug mode: The debug page is now placed after the respective
-   "normal" page
--  Reduced disk space usage in temporary folder if -d (deskew) or -c
-   (cleanup) options are not selected
--  New file src/config.sh containing various configuration parameters
--  Documentation of the tesseract config file "tess-cfg/no\_ligature"
-   improved
--  Improved consistency of the temporary file names
-
-Fixes
------
-
--  Improved robustness:
--  in case vertical resolution differs from horizontal resolution (fixes
-   #38)
--  in case a PDF page contains more than one image (fixes #36)
--  Fix a problem occurring if python 3 is the standard interpreter
-   (fixes #33)
--  Fix a problem occurring if the input PDF file contains special
-   characters like "#" (fixes #34)
-
-Tested with
------------
-
--  Operating system: FreeBSD 9.1
--  Dependencies:
--  parallel 20130222
--  poppler-utils 0.22.2
--  ImageMagick 6.8.0-7 2013-03-30
--  Unpaper 0.3
--  tesseract 3.02.02
--  Python 2.7.3
--  pdftk 1.45
--  ghoscript (gs): 9.06
--  java: openjdk version "1.7.0\_17"
-
-v1.1-stable (2014-01-06):
-=========================
-
-New features
-------------
-
--  N/A
-
-Changes
--------
-
--  N/A
-
-Fixes
------
-
--  Fixed syntax error (bashism) leading to an error message on certain
-   systems (fixes #42)
-
-Tested with
------------
-
--  Operating system: FreeBSD 9.1
--  Dependencies:
--  poppler-utils 0.22.2
--  ImageMagick 6.8.0-7 2013-03-30
--  Unpaper 0.3
--  tesseract 3.02.02
--  Python 2.7.3
--  pdftk 1.45
--  ghoscript (gs): 9.06
--  java: openjdk version "1.7.0\_17"
-
-v1.0-stable (2013-05-06):
-=========================
-
-New features
-------------
-
--  In debug mode: compute and echo time required for processing (fixes
-   #26)
-
-Changes
--------
-
--  Removed feature to add metadata in final pdf file (because it lead to
-   to final PDF file that does not comply to the PDF/A-1 format)
--  Removed feature to set same owner & permissions in final PDF file
-   than in input file
--  Removed many unused jhove files (e.g. documentation, \*.java and
-   \*.class files)
-
-Fixes
------
-
--  Correction to handle correctly path and input PDF files having spaces
-   (fixes #31)
--  Resolutions (x/y) that are nearly equal are now supported (fixes #25)
--  Fix compatibility issue with Ubuntu server 12.04 / Ubuntu server
-   10.04 / Linux Mint 13 Maya and probably other Linux distributions
-   (fixes #27)
--  Commit missing jhove files (\*.jar mainly) due to wrong .gitignore
-
-Tested with
------------
-
--  Operating system: FreeBSD 9.1
--  Dependencies:
--  poppler-utils 0.22.2
--  ImageMagick 6.8.0-7 2013-03-30
--  Unpaper 0.3
--  tesseract 3.02.02
--  Python 2.7.3
--  pdftk 1.45
--  ghoscript (gs): 9.06
--  java: openjdk version "1.7.0\_17"
-
-v1.0-rc2 (2013-04-29):
-======================
-
-New features
-------------
-
--  Keep temporary files if debug mode is set (fixes #22)
--  Set same owner & permissions in final PDF file than in input file
-   (fixes #9)
--  Added metadata in final pdf file (fixes #4)
-
-Changes
--------
-
--  N/A
-
-Fixes
------
-
--  Fixed wrong image cropping when deskew option is activated
--  Exit with error message if page size is not found in hocr file (fixes
-   #21)
--  Various minor fixes in log messages
-
-Tested with
------------
-
--  Operating system: FreeBSD 9.1
--  Dependencies:
--  poppler-utils 0.22.2
--  ImageMagick 6.8.0-7 2013-03-30
--  Unpaper 0.3
--  tesseract 3.02.02
--  Python 2.7.3
--  pdftk 1.45
--  ghoscript (gs): 9.06
--  java: openjdk version "1.7.0\_17"
-
-v1.0-rc1 (2013-04-26):
-======================
-
-New features
-------------
-
--  First release candidate
-
-Changes
--------
-
--  N/A
-
-Fixes
------
-
--  N/A
-
-Tested with
------------
-
--  Operating system: FreeBSD 9.1
--  Dependencies:
--  poppler-utils 0.22.2
--  ImageMagick 6.8.0-7 2013-03-30
--  Unpaper 0.3
--  tesseract 3.02.02
--  Python 2.7.3
--  pdftk 1.45
--  ghoscript (gs): 9.06
--  java: openjdk version "1.7.0\_17"

ROADMAP.md

@@ -1,96 +0,0 @@
-Recoding in 5 python modules
-==================
-
-- Less platform dependent implementation
-- Higher versality (wrt addition of new intput / output file types)
-
-The functionality of each module is described below:
-
-Normalize inputs (inputs can be a pdf file, an image, a folder containing images)
-----------------
-
-- For pdf:
-  - Identify if page needs to be ocred (see -s and -f parameters)
-  - If the page needs to be OCRed:
-    - Extract the image corresponding to the page and save it in a tmp folder. 3 approaches to extract images:
-      - extract raw image from pdf and rotate it according to pdf page rotation
-      - if not possible: identify resolution and rasterize
-      - if not possible: use default resolution and rasterize
-  - If not:
-    - Save the page AS-IS in the tmp folder that should contained the final page
-- For image(s):
-  - Just copy the images with standardized name into the tmp folder containing pages to be OCRed
-
-Preprocess normalized inputs (perform jobs in parallel)
-----------------------------
-
-- Orientation (if requested by user)
-  - Correct orientation
-- Skew angle (if requested by user)
-  - Correct skew angle
-- Cleaning (if requested by user)
-  - Clean image
-
-Perform OCR (perform jobs in parallel)
------------
-
-- Perform OCR and save resulting hocr file for each respective page (perfom jobs in parallel)
-
-Generate output for each page
------------------------------
-
-- For pdf (if output file has a "pdf" extension):
-  - Generate pdf pages from hocr files (note: pdf pages can already exist if OCR has been skipped for them)
-- For txt
-  - generate txt file for each page (containing txt located into hocr file)
-
-Build final output
-------------------
-
-- For pdf:
-  - Concatenate pdf pages
-  - Convert to pdf/1-a
-  - Verify conformity to pdf/1-a
-- For txt
-  - Concatenate all txt files into the final output txt file
-
-
-
-Tmp folder structure
-=========================
-
-- tmp_xxxxx/
-  - a_raw_images (either from images or extracted from pdf file)
-  - b_preprocessed_images (after deswing anf cleaning)
-  - c_ocr_out
-  - d_output_pages (one file per page (at first 1 pdf file per page. Later on other formats might be supported)
-  - e_output_final (concatenate output pages and conversion into PDF/1-a standard, Later on support other formats)
-
-ocrmypdf arguments
-==================
-
-ocrmypdf [-h] [-v] [-k] [-g] [-o dpi] [-f|-s] [-r] [-d] [-c] [-i] [-l lan1[+lan2...]] [-C] inputpath outputfile1 [outputfile2...]
-
-- Overall parameters
-  - [-h] : Display this help message
-  - [-v] : Increase the verbosity (this option can be used more than once) (e.g. -vvv)
-  - [-k] : Do not delete the temporary files
-  - [-g] : Activate debug mode (max verbosity, keep tmp files, generate debug pages)
-- Normalization parameters:
-  - [-o dpi] : If page resolution is lower x dpi, provide OCR engine with an oversampled image. (Can improve OCR results)
-  - [-f] : Force to OCR the whole document, even if some page already contain font data (only for pdf inputs)
-  - [-s] : If pages contain font data, do not OCR that page, but include the page (as is) in the final output (only for pdf inputs)
-- Prepocessing parameters:
-  - [-r] : Correct orientation
-  - [-d] : Deskew each page
-  - [-c] : Clean each page
-  - [-i] : Incorporate cleaned image in final output
-- OCR parameters:
-  - [-l lan1[+lan2...]] : Document language(s). Multiple languages may be specified, separated by '+' characters.
-  - [-C cfg] : Pass an additional cofg file to the tesseract OCR engine. (this option can be used more than once)
-- output generation parameters:
-  - None by now
-- input files:
-  - inputpath : path to image, pdf file or folder to be processed
-- output files:
-  - outputfile1 [outputfile2 ...] : *.pdf file or *.txt file to be generated (argumenst can be repeated if both pdf and txt file should be generated 

docs/advanced.rst

@@ -0,0 +1,344 @@
+=================
+Advanced features
+=================
+
+Control of unpaper
+==================
+
+OCRmyPDF uses ``unpaper`` to provide the implementation of the
+``--clean`` and ``--clean-final`` arguments.
+`unpaper <https://github.com/Flameeyes/unpaper/blob/master/doc/basic-concepts.md>`__
+provides a variety of image processing filters to improve images.
+
+By default, OCRmyPDF uses only ``unpaper`` arguments that were found to
+be safe to use on almost all files without having to inspect every page
+of the file afterwards. This is particularly true when only ``--clean``
+is used, since that instructs OCRmyPDF to only clean the image before
+OCR and not the final image.
+
+However, if you wish to use the more aggressive options in ``unpaper``,
+you may use ``--unpaper-args '...'`` to override the OCRmyPDF's defaults
+and forward other arguments to unpaper. This option will forward
+arguments to ``unpaper`` without any knowledge of what that program
+considers to be valid arguments. The string of arguments must be quoted
+as shown in the examples below. No filename arguments may be included.
+OCRmyPDF will assume it can append input and output filename of
+intermediate images to the ``--unpaper-args`` string.
+
+In this example, we tell ``unpaper`` to expect two pages of text on a
+sheet (image), such as occurs when two facing pages of a book are
+scanned. ``unpaper`` uses this information to deskew each independently
+and clean up the margins of both.
+
+.. code-block:: bash
+
+    ocrmypdf --clean --clean-final --unpaper-args '--layout double' input.pdf output.pdf
+    ocrmypdf --clean --clean-final --unpaper-args '--layout double --no-noisefilter' input.pdf output.pdf
+
+.. warning::
+
+   Some ``unpaper`` features will reposition text within the image.
+   ``--clean-final`` is recommended to avoid this issue.
+
+.. warning::
+
+   Some ``unpaper`` features cause multiple input or output files to be
+   consumed or produced. OCRmyPDF requires ``unpaper`` to consume one
+   file and produce one file. An deviation from that condition will
+   result in errors.
+
+.. note::
+
+   ``unpaper`` uses uncompressed PBM/PGM/PPM files for its intermediate
+   files. For large images or documents, it can take a lot of temporary
+   disk space.
+
+Control of OCR options
+======================
+
+OCRmyPDF provides many features to control the behavior of the OCR
+engine, Tesseract.
+
+When OCR is skipped
+-------------------
+
+If a page in a PDF seems to have text, by default OCRmyPDF will exit
+without modifying the PDF. This is to ensure that PDFs that were
+previously OCRed or were "born digital" rather than scanned are not
+processed.
+
+If ``--skip-text`` is issued, then no OCR will be performed on pages
+that already have text. The page will be copied to the output. This may
+be useful for documents that contain both "born digital" and scanned
+content, or to use OCRmyPDF to normalize and convert to PDF/A regardless
+of their contents.
+
+If ``--redo-ocr`` is issued, then a detailed text analysis is performed.
+Text is categorized as either visible or invisible. Invisible text (OCR)
+is stripped out. Then an image of each page is created with visible text
+masked out. The page image is sent for OCR, and any additional text is
+inserted as OCR. If a file contains a mix of text and bitmap images that
+contain text, OCRmyPDF will locate the additional text in images without
+disrupting the existing text.
+
+If ``--force-ocr`` is issued, then all pages will be rasterized to
+images, discarding any hidden OCR text, and rasterizing any printable
+text. This is useful for redoing OCR, for fixing OCR text with a damaged
+character map (text is selectable but not searchable), and destroying
+redacted information. Any forms and vector graphics will be rasterized
+as well.
+
+Time and image size limits
+--------------------------
+
+By default, OCRmyPDF permits tesseract to run for three minutes (180
+seconds) per page. This is usually more than enough time to find all
+text on a reasonably sized page with modern hardware.
+
+If a page is skipped, it will be inserted without OCR. If preprocessing
+was requested, the preprocessed image layer will be inserted.
+
+If you want to adjust the amount of time spent on OCR, change
+``--tesseract-timeout``. You can also automatically skip images that
+exceed a certain number of megapixels with ``--skip-big``. (A 300 DPI,
+8.5×11" page is 8.4 megapixels.)
+
+.. code-block:: bash
+
+    # Allow 300 seconds for OCR; skip any page larger than 50 megapixels
+    ocrmypdf --tesseract-timeout 300 --skip-big 50 bigfile.pdf output.pdf
+
+Overriding default tesseract
+----------------------------
+
+OCRmyPDF checks the system ``PATH`` for the ``tesseract`` binary.
+
+Some relevant environment variables that influence Tesseract's behavior
+include:
+
+.. envvar:: TESSDATA_PREFIX
+
+   Overrides the path to Tesseract's data files. This can allow
+   simultaneous installation of the "best" and "fast" training data
+   sets. OCRmyPDF does not manage this environment variable.
+
+.. envvar:: OMP_THREAD_LIMIT
+
+   Controls the number of threads Tesseract will use. OCRmyPDF will
+   manage this environment variable if it is not already set.
+
+For example, if you have a development build of Tesseract don't wish to
+use the system installation, you can launch OCRmyPDF as follows:
+
+.. code-block:: bash
+
+    env \
+        PATH=/home/user/src/tesseract/api:$PATH \
+        TESSDATA_PREFIX=/home/user/src/tesseract \
+        ocrmypdf input.pdf output.pdf
+
+In this example ``TESSDATA_PREFIX`` is required to redirect Tesseract to
+an alternate folder for its "tessdata" files.
+
+Overriding other support programs
+---------------------------------
+
+In addition to tesseract, OCRmyPDF uses the following external binaries:
+
+-  ``gs`` (Ghostscript)
+-  ``unpaper``
+-  ``pngquant``
+-  ``jbig2``
+
+In each case OCRmyPDF will search the ``PATH`` environment variable to
+locate the binaries.
+
+Changing tesseract configuration variables
+------------------------------------------
+
+You can override tesseract's default `control
+parameters <https://github.com/tesseract-ocr/tesseract/wiki/ControlParams>`__
+with a configuration file.
+
+As an example, this configuration will disable Tesseract's dictionary
+for current language. Normally the dictionary is helpful for
+interpolating words that are unclear, but it may interfere with OCR if
+the document does not contain many words (for example, a list of part
+numbers).
+
+Create a file named "no-dict.cfg" with these contents:
+
+::
+
+    load_system_dawg 0
+    language_model_penalty_non_dict_word 0
+    language_model_penalty_non_freq_dict_word 0
+
+then run ocrmypdf as follows (along with any other desired arguments):
+
+.. code-block:: bash
+
+    ocrmypdf --tesseract-config no-dict.cfg input.pdf output.pdf
+
+.. warning::
+
+   Some combinations of control parameters will break Tesseract or break
+   assumptions that OCRmyPDF makes about Tesseract's output.
+
+Changing the PDF renderer
+=========================
+
+rasterizing
+  Converting a PDF to an image for display.
+
+rendering
+  Creating a new PDF from other data (such as an existing PDF).
+
+OCRmyPDF has these PDF renderers: ``sandwich`` and ``hocr``. The
+renderer may be selected using ``--pdf-renderer``. The default is
+``auto`` which lets OCRmyPDF select the renderer to use. Currently,
+``auto`` always selects ``sandwich``.
+
+The ``sandwich`` renderer
+-------------------------
+
+The ``sandwich`` renderer uses Tesseract's new text-only PDF feature,
+which produces a PDF page that lays out the OCR in invisible text. This
+page is then "sandwiched" onto the original PDF page, allowing lossless
+application of OCR even to PDF pages that contain other vector objects.
+
+Currently this is the best renderer for most uses, however it is
+implemented in Tesseract so OCRmyPDF cannot influence it. Currently some
+problematic PDF viewers like Mozilla PDF.js and macOS Preview have
+problems with segmenting its text output, and
+mightrunseveralwordstogether.
+
+When image preprocessing features like ``--deskew`` are used, the
+original PDF will be rendered as a full page and the OCR layer will be
+placed on top.
+
+The ``hocr`` renderer
+---------------------
+
+The ``hocr`` renderer works with older versions of Tesseract. The image
+layer is copied from the original PDF page if possible, avoiding
+potentially lossy transcoding or loss of other PDF information. If
+preprocessing is specified, then the image layer is a new PDF.
+
+Unlike ``sandwich`` this renderer is implemented within OCRmyPDF; anyone
+looking to customize how OCR is presented should look here. A major
+disadvantage of this renderer is it not capable of correctly handling
+text outside the Latin alphabet (specifically, it supports the ISO 8859-1
+character). Pull requests to improve the situation are welcome.
+
+Currently, this renderer has the best compatibility with Mozilla's
+PDF.js viewer.
+
+This works in all versions of Tesseract.
+
+The ``tesseract`` renderer
+--------------------------
+
+The ``tesseract`` renderer was removed. OCRmyPDF's new approach to text
+layer grafting makes it functionally equivalent to ``sandwich``.
+
+Return code policy
+==================
+
+OCRmyPDF writes all messages to ``stderr``. ``stdout`` is reserved for
+piping output files. ``stdin`` is reserved for piping input files.
+
+The return codes generated by the OCRmyPDF are considered part of the
+stable user interface. They may be imported from
+``ocrmypdf.exceptions``.
+
+.. list-table:: Return codes
+    :widths: 5 35 60
+    :header-rows: 1
+
+    *	- Code
+        - Name
+        - Interpretation
+    *	- 0
+        - ``ExitCode.ok``
+        - Everything worked as expected.
+    *	- 1
+        - ``ExitCode.bad_args``
+        - Invalid arguments, exited with an error.
+    *	- 2
+        - ``ExitCode.input_file``
+        - The input file does not seem to be a valid PDF.
+    *	- 3
+        - ``ExitCode.missing_dependency``
+        - An external program required by OCRmyPDF is missing.
+    *	- 4
+        - ``ExitCode.invalid_output_pdf``
+        - An output file was created, but it does not seem to be a valid PDF. The file will be available.
+    *	- 5
+        - ``ExitCode.file_access_error``
+        - The user running OCRmyPDF does not have sufficient permissions to read the input file and write the output file.
+    *	- 6
+        - ``ExitCode.already_done_ocr``
+        - The file already appears to contain text so it may not need OCR. See output message.
+    *	- 7
+        - ``ExitCode.child_process_error``
+        - An error occurred in an external program (child process) and OCRmyPDF cannot continue.
+    *	- 8
+        - ``ExitCode.encrypted_pdf``
+        - The input PDF is encrypted. OCRmyPDF does not read encrypted PDFs. Use another program such as ``qpdf`` to remove encryption.
+    *	- 9
+        - ``ExitCode.invalid_config``
+        - A custom configuration file was forwarded to Tesseract using ``--tesseract-config``, and Tesseract rejected this file.
+    *   - 10
+        - ``ExitCode.pdfa_conversion_failed``
+        - A valid PDF was created, PDF/A conversion failed. The file will be available.
+    *	- 15
+        - ``ExitCode.other_error``
+        - Some other error occurred.
+    *	- 130
+        - ``ExitCode.ctrl_c``
+        - The program was interrupted by pressing Ctrl+C.
+
+
+Debugging the intermediate files
+================================
+
+OCRmyPDF normally saves its intermediate results to a temporary folder
+and deletes this folder when it exits, whether it succeeded or failed.
+
+If the ``-k`` argument is issued on the command line, OCRmyPDF will keep
+the temporary folder and print the location, whether it succeeded or
+failed (provided the Python interpreter did not crash). An example
+message is:
+
+.. code-block:: none
+
+    Temporary working files retained at:
+    /tmp/ocrmypdf.io.u20wpz07
+
+The organization of this folder is an implementation detail and subject
+to change between releases. However the general organization is that
+working files on a per page basis have the page number as a prefix
+(starting with page 1), an infix indicates the processing stage, and a
+suffix indicates the file type. Some important files include:
+
+-  ``_rasterize.png`` - what the input page looks like
+-  ``_ocr.png`` - the file that is sent to Tesseract for OCR; depending
+   on arguments this may differ from the presentation image
+-  ``_pp_deskew.png`` - the image, after deskewing
+-  ``_pp_clean.png`` - the image, after cleaning with unpaper
+-  ``_ocr_tess.pdf`` - the OCR file; appears as a blank page with invisible
+   text embedded
+-  ``_ocr_tess.txt`` - the OCR text (not necessarily all text on the page,
+   if the page is mixed format)
+-  ``fix_docinfo.pdf`` - a temporary file created to fix the PDF DocumentInfo
+   data structure
+-  ``graft_layers.pdf`` - the rendered PDF with OCR layers grafted on
+-  ``pdfa.pdf`` - ``graft_layers.pdf`` after conversion to PDF/A
+-  ``pdfa.ps`` - a PostScript file used by Ghostscript for PDF/A conversion
+-  ``optimize.pdf`` - the PDF generated before optimization
+-  ``optimize.out.pdf`` - the PDF generated by optimization
+-  ``origin`` - the input file
+-  ``origin.pdf`` - the input file or the input image converted to PDF
+-  ``images/*`` - images extracted during the optimization process; here
+   the prefix indicates a PDF object ID not a page number

docs/api.rst

@@ -0,0 +1,117 @@
+======================
+Using the OCRmyPDF API
+======================
+
+OCRmyPDF originated as a command line program and continues to have this
+legacy, but parts of it can be imported and used in other Python
+applications.
+
+Some applications may want to consider running ocrmypdf from a
+subprocess call anyway, as this provides isolation of its activities.
+
+Example
+=======
+
+OCRmyPDF provides one high-level function to run its main engine from an
+application. The parameters are symmetric to the command line arguments
+and largely have the same functions.
+
+.. code-block:: python
+
+    import ocrmypdf
+
+    if __name__ == '__main__':  # To ensure correct behavior on Windows and macOS
+        ocrmypdf.ocr('input.pdf', 'output.pdf', deskew=True)
+
+With some exceptions, all of the command line arguments are available
+and may be passed as equivalent keywords.
+
+A few differences are that ``verbose`` and ``quiet`` are not available.
+Instead, output should be managed by configuring logging.
+
+Parent process requirements
+---------------------------
+
+The :func:`ocrmypdf.ocr` function runs OCRmyPDF similar to command line
+execution. To do this, it will:
+
+- create a monitoring thread
+- create worker processes (on Linux, forking itself; on Windows and macOS, by
+  spawning)
+- manage the signal flags of its worker processes
+- execute other subprocesses (forking and executing other programs)
+
+The Python process that calls :func:`ocrmypdf.ocr()` must be sufficiently
+privileged to perform these actions.
+
+There currently is no option to manage how jobs are scheduled other
+than the argument ``jobs=`` which will limit the number of worker
+processes.
+
+Creating a child process to call :func:`ocrmypdf.ocr()` is suggested. That
+way your application will survive and remain interactive even if
+OCRmyPDF fails for any reason.
+
+Programs that call :func:`ocrmypdf.ocr()` should also install a SIGBUS signal
+handler (except on Windows), to raise an exception if access to a memory
+mapped file fails. OCRmyPDF may use memory mapping.
+
+:func:`ocrmypdf.ocr()` will take a threading lock to prevent multiple runs of itself
+in the same Python interpreter process. This is not thread-safe, because of how
+OCRmyPDF's plugins and Python's library import system work. If you need to parallelize
+OCRmyPDF, use processes.
+
+.. warning::
+
+    On Windows and macOS, the script that calls :func:`ocrmypdf.ocr()` must be
+    protected by an "ifmain" guard (``if __name__ == '__main__'``). If you do
+    not take at least one of these steps, process semantics will prevent
+    OCRmyPDF from working correctly.
+
+Logging
+-------
+
+OCRmyPDF will log under loggers named ``ocrmypdf``. In addition, it
+imports ``pdfminer`` and ``PIL``, both of which post log messages under
+those logging namespaces.
+
+You can configure the logging as desired for your application or call
+:func:`ocrmypdf.configure_logging` to configure logging the same way
+OCRmyPDF itself does. The command line parameters such as ``--quiet``
+and ``--verbose`` have no equivalents in the API; you must use the
+provided configuration function or do configuration in a way that suits
+your use case.
+
+Progress monitoring
+-------------------
+
+OCRmyPDF uses the ``tqdm`` package to implement its progress bars.
+:func:`ocrmypdf.configure_logging` will set up logging output to
+``sys.stderr`` in a way that is compatible with the display of the
+progress bar. Use ``ocrmypdf.ocr(...progress_bar=False)`` to disable
+the progress bar.
+
+Exceptions
+----------
+
+OCRmyPDF may throw standard Python exceptions, ``ocrmypdf.exceptions.*``
+exceptions, some exceptions related to multiprocessing, and
+:exc:`KeyboardInterrupt`. The parent process should provide an exception
+handler. OCRmyPDF will clean up its temporary files and worker processes
+automatically when an exception occurs.
+
+Programs that call OCRmyPDF should consider trapping KeyboardInterrupt
+so that they allow OCR to terminate with the whole program terminating.
+
+When OCRmyPDF succeeds conditionally, it returns an integer exit code.
+
+Reference
+---------
+
+.. autofunction:: ocrmypdf.ocr
+
+.. autoclass:: ocrmypdf.Verbosity
+    :members:
+    :undoc-members:
+
+.. autofunction:: ocrmypdf.configure_logging

docs/apiref.rst

@@ -0,0 +1,55 @@
+=============
+API Reference
+=============
+
+This page summarizes the rest of the public API. Generally speaking this
+should mainly of interest to plugin developers.
+
+ocrmypdf
+========
+
+.. autoclass:: ocrmypdf.PageContext
+    :members:
+
+.. autoclass:: ocrmypdf.PdfContext
+    :members:
+
+ocrmypdf.exceptions
+===================
+
+.. automodule:: ocrmypdf.exceptions
+    :members:
+    :undoc-members:
+
+ocrmypdf.helpers
+================
+
+.. automodule:: ocrmypdf.helpers
+    :members:
+    :noindex: deprecated
+
+    .. autodecorator:: deprecated
+
+ocrmypdf.hocrtransform
+======================
+
+.. automodule:: ocrmypdf.hocrtransform
+    :members:
+
+ocrmypdf.pdfa
+=============
+
+.. automodule:: ocrmypdf.pdfa
+    :members:
+
+ocrmypdf.quality
+================
+
+.. automodule:: ocrmypdf.quality
+    :members:
+
+ocrmypdf.subprocess
+===================
+
+.. automodule:: ocrmypdf.subprocess
+    :members:

docs/batch.rst

@@ -0,0 +1,217 @@
+================
+Batch processing
+================
+
+This article provides information about running OCRmyPDF on multiple
+files or configuring it as a service triggered by file system events.
+
+Batch jobs
+==========
+
+Consider using the excellent `GNU
+Parallel <https://www.gnu.org/software/parallel/>`__ to apply OCRmyPDF
+to multiple files at once.
+
+Both ``parallel`` and ``ocrmypdf`` will try to use all available
+processors. To maximize parallelism without overloading your system with
+processes, consider using ``parallel -j 2`` to limit parallel to running
+two jobs at once.
+
+This command will run all ocrmypdf all files named ``*.pdf`` in the
+current directory and write them to the previous created ``output/``
+folder. It will not search subdirectories.
+
+The ``--tag`` argument tells parallel to print the filename as a prefix
+whenever a message is printed, so that one can trace any errors to the
+file that produced them.
+
+.. code-block:: bash
+
+   parallel --tag -j 2 ocrmypdf '{}' 'output/{}' ::: *.pdf
+
+OCRmyPDF automatically repairs PDFs before parsing and gathering
+information from them.
+
+Directory trees
+===============
+
+This will walk through a directory tree and run OCR on all files in
+place, printing the output in a way that makes
+
+.. code-block:: bash
+
+   find . -printf '%p' -name '*.pdf' -exec ocrmypdf '{}' '{}' \;
+
+Alternatively, with a docker container (mounts a volume to the container
+where the PDFs are stored):
+
+.. code-block:: bash
+
+   find . -printf '%p' -name '*.pdf' -exec docker run --rm -v <host dir>:<container dir> jbarlow83/ocrmypdf '<container dir>/{}' '<container dir>/{}' \;
+
+This only runs one ``ocrmypdf`` process at a time. This variation uses
+``find`` to create a directory list and ``parallel`` to parallelize runs
+of ``ocrmypdf``, again updating files in place.
+
+.. code-block:: bash
+
+   find . -name '*.pdf' | parallel --tag -j 2 ocrmypdf '{}' '{}'
+
+In a Windows batch file, use
+
+.. code-block:: bat
+
+   for /r %%f in (*.pdf) do ocrmypdf %%f %%f
+
+Sample script
+-------------
+
+This user contributed script also provides an example of batch
+processing.
+
+.. literalinclude:: ../misc/batch.py
+    :caption: misc/batch.py
+
+Synology DiskStations
+---------------------
+
+Synology DiskStations (Network Attached Storage devices) can run the
+Docker image of OCRmyPDF if the Synology `Docker
+package <https://www.synology.com/en-global/dsm/packages/Docker>`__ is
+installed. Attached is a script to address particular quirks of using
+OCRmyPDF on one of these devices.
+
+This is only possible for x86-based Synology products. Some Synology
+products use ARM or Power processors and do not support Docker. Further
+adjustments might be needed to deal with the Synology's relatively
+limited CPU and RAM.
+
+.. literalinclude:: ../misc/synology.py
+    :caption: misc/synology.py - Sample script for Synology DiskStations
+
+Huge batch jobs
+---------------
+
+If you have thousands of files to work with, contact the author.
+Consulting work related to OCRmyPDF helps fund this open source project
+and all inquiries are appreciated.
+
+Hot (watched) folders
+=====================
+
+Watched folders with watcher.py
+-------------------------------
+
+OCRmyPDF has a folder watcher called watcher.py, which is currently included in source
+distributions but not part of the main program. It may be used natively or may run
+in a Docker container. Native instances tend to give better performance. watcher.py
+works on all platforms.
+
+Users may need to customize the script to meet their requirements.
+
+.. code-block:: bash
+
+    pip3 install ocrmypdf[watcher]
+
+    env OCR_INPUT_DIRECTORY=/mnt/input-pdfs \
+        OCR_OUTPUT_DIRECTORY=/mnt/output-pdfs \
+        OCR_OUTPUT_DIRECTORY_YEAR_MONTH=1 \
+        python3 watcher.py
+
+.. csv-table:: watcher.py environment variables
+    :header: "Environment variable", "Description"
+    :widths: 50, 50
+
+    "OCR_INPUT_DIRECTORY", "Set input directory to monitor (recursive)"
+    "OCR_OUTPUT_DIRECTORY", "Set output directory (should not be under input)"
+    "OCR_ON_SUCCESS_DELETE", "This will delete the input file if the exit code is 0 (OK)"
+    "OCR_OUTPUT_DIRECTORY_YEAR_MONTH", "This will place files in the output in ``{output}/{year}/{month}/{filename}``"
+    "OCR_DESKEW", "Apply deskew to crooked input PDFs"
+    "OCR_JSON_SETTINGS", "A JSON string specifying any other arguments for ``ocrmypdf.ocr``, e.g. ``'OCR_JSON_SETTINGS={""rotate_pages"": true}'``."
+    "OCR_POLL_NEW_FILE_SECONDS", "Polling interval"
+    "OCR_LOGLEVEL", "Level of log messages to report"
+
+One could configure a networked scanner or scanning computer to drop files in the
+watched folder.
+
+Watched folders with Docker
+---------------------------
+
+The watcher service is included in the OCRmyPDF Docker image. To run it:
+
+.. code-block:: bash
+
+    docker run \
+        -v <path to files to convert>:/input \
+        -v <path to store results>:/output \
+        -e OCR_OUTPUT_DIRECTORY_YEAR_MONTH=1 \
+        -e OCR_ON_SUCCESS_DELETE=1 \
+        -e OCR_DESKEW=1 \
+        -e PYTHONUNBUFFERED=1 \
+        -it --entrypoint python3 \
+        jbarlow83/ocrmypdf \
+        watcher.py
+
+This service will watch for a file that matches ``/input/\*.pdf`` and will
+convert it to a OCRed PDF in ``/output/``. The parameters to this image are:
+
+.. csv-table:: watcher.py parameters for Docker
+    :header: "Parameter", "Description"
+    :widths: 50, 50
+
+    "``-v <path to files to convert>:/input``", "Files placed in this location will be OCRed"
+    "``-v <path to store results>:/output``", "This is where OCRed files will be stored"
+    "``-e OCR_OUTPUT_DIRECTORY_YEAR_MONTH=1``", "Define environment variable OCR_OUTPUT_DIRECTORY_YEAR_MONTH=1"
+    "``-e OCR_ON_SUCCESS_DELETE=1``", "Define environment variable"
+    "``-e OCR_DESKEW=1``", "Define environment variable"
+    "``-e PYTHONBUFFERED=1``", "This will force STDOUT to be unbuffered and allow you to see messages in docker logs"
+
+This service relies on polling to check for changes to the filesystem. It
+may not be suitable for some environments, such as filesystems shared on a
+slow network.
+
+A configuration manager such as Docker Compose could be used to ensure that the
+service is always available.
+
+.. literalinclude:: ../misc/docker-compose.example.yml
+    :language: yaml
+    :caption: misc/docker-compose.example.yml
+
+Caveats
+-------
+
+-  ``watchmedo`` may not work properly on a networked file system,
+   depending on the capabilities of the file system client and server.
+-  This simple recipe does not filter for the type of file system event,
+   so file copies, deletes and moves, and directory operations, will all
+   be sent to ocrmypdf, producing errors in several cases. Disable your
+   watched folder if you are doing anything other than copying files to
+   it.
+-  If the source and destination directory are the same, watchmedo may
+   create an infinite loop.
+-  On BSD, FreeBSD and older versions of macOS, you may need to increase
+   the number of file descriptors to monitor more files, using
+   ``ulimit -n 1024`` to watch a folder of up to 1024 files.
+
+Alternatives
+------------
+
+-  On Linux, `systemd user services <https://wiki.archlinux.org/index.php/Systemd/User>`__
+   can be configured to automatically perform OCR on a collection of files.
+
+-  `Watchman <https://facebook.github.io/watchman/>`__ is a more
+   powerful alternative to ``watchmedo``.
+
+macOS Automator
+===============
+
+You can use the Automator app with macOS, to create a Workflow or Quick
+Action. Use a *Run Shell Script* action in your workflow. In the context
+of Automator, the ``PATH`` may be set differently your Terminal's
+``PATH``; you may need to explicitly set the PATH to include
+``ocrmypdf``. The following example may serve as a starting point:
+
+.. figure:: images/macos-workflow.png
+    :alt: Example macOS Automator workflow
+
+You may customize the command sent to ocrmypdf.

docs/conf.py

@@ -0,0 +1,383 @@
+#!/usr/bin/env python3
+#
+# ocrmypdf documentation build configuration file, created by
+# sphinx-quickstart on Sun Sep  4 14:29:43 2016.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+"""isort:skip_file"""
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.autosummary',
+    'sphinx.ext.napoleon',
+    'sphinx_issues',
+]
+
+# Extension settings
+intersphinx_mapping = {'https://docs.python.org/': None}
+napoleon_use_rtype = False
+issues_github_path = "jbarlow83/OCRmyPDF"
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The encoding of source files.
+#
+# source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = 'ocrmypdf'
+copyright = (
+    '2021, James R. Barlow. Licensed under Creative Commons Attribution-ShareAlike 4.0.'
+)
+author = 'James R. Barlow'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+
+import os
+
+on_rtd = os.environ.get('READTHEDOCS') == 'True'
+
+if on_rtd:
+    # Help ReadTheDocs avoid having to install any binary extension modules
+    import sys
+    from unittest.mock import MagicMock
+
+    class Mock(MagicMock):
+        @classmethod
+        def __getattr__(cls, name):
+            return MagicMock()
+
+    MOCK_MODULES = [
+        'pikepdf',
+        'pikepdf.models',
+        'pikepdf.models.metadata',
+    ]
+    sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)
+
+try:
+    from importlib_metadata import version as package_version
+except ModuleNotFoundError:
+    from importlib.metadata import version as package_version
+
+# The full version, including alpha/beta/rc tags.
+release = package_version('ocrmypdf')
+version = '.'.join(release.split('.')[:2])
+
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#
+# today = ''
+#
+# Else, today_fmt is used as the format for a strftime call.
+#
+today_fmt = '%Y-%m-%d'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# The reST default role (used for this markup: `text`) to use for all
+# documents.
+#
+# default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#
+# add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#
+# add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#
+# show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+# modindex_common_prefix = []
+
+# If true, keep warnings as "system message" paragraphs in the built documents.
+# keep_warnings = False
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+import sphinx_rtd_theme
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'sphinx_rtd_theme'
+html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+html_theme_options = {'display_version': False}
+
+# Add any paths that contain custom themes here, relative to this directory.
+# html_theme_path = []
+
+# The name for this set of Sphinx documents.
+# "<project> v<release> documentation" by default.
+#
+# html_title = 'ocrmypdf v4.2'
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#
+# html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#
+# html_logo = "images/logo.svg"  # looks bad
+
+# The name of an image file (relative to this directory) to use as a favicon of
+# the docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#
+# html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# Add any extra paths that contain custom files (such as robots.txt or
+# .htaccess) here, relative to this directory. These files are copied
+# directly to the root of the documentation.
+#
+# html_extra_path = []
+
+# If not None, a 'Last updated on:' timestamp is inserted at every page
+# bottom, using the given strftime format.
+# The empty string is equivalent to '%b %d, %Y'.
+#
+# html_last_updated_fmt = None
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#
+# html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#
+# html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#
+# html_additional_pages = {}
+
+# If false, no module index is generated.
+#
+# html_domain_indices = True
+
+# If false, no index is generated.
+#
+# html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#
+# html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#
+# html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#
+# html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#
+# html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#
+# html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+# html_file_suffix = None
+
+# Language to be used for generating the HTML full-text search index.
+# Sphinx supports the following languages:
+#   'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja'
+#   'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr', 'zh'
+#
+# html_search_language = 'en'
+
+# A dictionary with options for the search language support, empty by default.
+# 'ja' uses this config value.
+# 'zh' user can custom change `jieba` dictionary path.
+#
+# html_search_options = {'type': 'default'}
+
+# The name of a javascript file (relative to the configuration directory) that
+# implements a search results scorer. If empty, the default will be used.
+#
+# html_search_scorer = 'scorer.js'
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'ocrmypdfdoc'
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {  # type: ignore
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'ocrmypdf.tex', 'ocrmypdf Documentation', 'James R. Barlow', 'manual')
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#
+# latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#
+# latex_use_parts = False
+
+# If true, show page references after internal links.
+#
+# latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#
+# latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#
+# latex_appendices = []
+
+# It false, will not define \strong, \code, 	itleref, \crossref ... but only
+# \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added
+# packages.
+#
+# latex_keep_old_macro_names = True
+
+# If false, no module index is generated.
+#
+# latex_domain_indices = True
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [(master_doc, 'ocrmypdf', 'ocrmypdf Documentation', [author], 1)]
+
+# If true, show URL addresses after external links.
+#
+# man_show_urls = False
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (
+        master_doc,
+        'ocrmypdf',
+        'ocrmypdf Documentation',
+        author,
+        'ocrmypdf',
+        'One line description of project.',
+        'Miscellaneous',
+    )
+]
+
+# Documents to append as an appendix to all manuals.
+#
+# texinfo_appendices = []
+
+# If false, no module index is generated.
+#
+# texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#
+# texinfo_show_urls = 'footnote'
+
+# If true, do not generate a @detailmenu in the "Top" node's menu.
+#
+# texinfo_no_detailmenu = False

docs/contributing.rst

@@ -0,0 +1,67 @@
+=======================
+Contributing guidelines
+=======================
+
+Contributions are welcome!
+
+Big changes
+===========
+
+Please open a new issue to discuss or propose a major change. Not only is it fun
+to discuss big ideas, but we might save each other's time too. Perhaps some of the
+work you're contemplating is already half-done in a development branch.
+
+Code style
+==========
+
+We use PEP8, ``black`` for code formatting and ``isort`` for import sorting. The
+settings for these programs are in ``pyproject.toml`` and ``setup.cfg``. Pull
+requests should follow the style guide. One difference we use from "black" style
+is that strings shown to the user are always in double quotes (``"``) and strings
+for internal uses are in single quotes (``'``).
+
+Tests
+=====
+
+New features should come with tests that confirm their correctness.
+
+New Python dependencies
+=======================
+
+If you are proposing a change that will require a new Python dependency, we
+prefer dependencies that are already packaged by Debian or Red Hat. This makes
+life much easier for our downstream package maintainers.
+
+Python dependencies must also be license-compatible. GPLv3 or AGPLv3 are likely
+incompatible with the project's license, but LGPLv3 is compatible.
+
+New non-Python dependencies
+===========================
+
+OCRmyPDF uses several external programs (Tesseract, Ghostscript and others) for
+its functionality. In general we prefer to avoid adding new external programs.
+
+Style guide: Is it OCRmyPDF or ocrmypdf?
+========================================
+
+The program/project is OCRmyPDF and the name of the executable or library is ocrmypdf.
+
+Known ports/packagers
+=====================
+
+OCRmyPDF has been ported to many platforms already. If you are interesting in
+porting to a new platform, check with
+`Repology <https://repology.org/projects/?search=ocrmypdf>`__ to see the status
+of that platform.
+
+Packager maintainers, please ensure that the command line completion scripts in
+``misc/`` are installed.
+
+Copyright and license
+=====================
+
+For contributions over 10 lines of code, please include your name to list of
+copyright holders for that file. The core program is licensed under MPL-2.0,
+test files and documentation under CC-BY-SA 4.0, and miscellaneous files under
+MIT. Please contribute code only that you wrote and you have the permission to
+contribute or license to us.

docs/cookbook.rst

@@ -0,0 +1,358 @@
+========
+Cookbook
+========
+
+Basic examples
+==============
+
+Help!
+-----
+
+ocrmypdf has built-in help.
+
+.. code-block:: bash
+
+    ocrmypdf --help
+
+Add an OCR layer and convert to PDF/A
+-------------------------------------
+
+.. code-block:: bash
+
+    ocrmypdf input.pdf output.pdf
+
+Add an OCR layer and output a standard PDF
+------------------------------------------
+
+.. code-block:: bash
+
+    ocrmypdf --output-type pdf input.pdf output.pdf
+
+Create a PDF/A with all color and grayscale images converted to JPEG
+--------------------------------------------------------------------
+
+.. code-block:: bash
+
+    ocrmypdf --output-type pdfa --pdfa-image-compression jpeg input.pdf output.pdf
+
+Modify a file in place
+----------------------
+
+The file will only be overwritten if OCRmyPDF is successful.
+
+.. code-block:: bash
+
+    ocrmypdf myfile.pdf myfile.pdf
+
+Correct page rotation
+---------------------
+
+OCR will attempt to automatic correct the rotation of each page. This
+can help fix a scanning job that contains a mix of landscape and
+portrait pages.
+
+.. code-block:: bash
+
+    ocrmypdf --rotate-pages myfile.pdf myfile.pdf
+
+You can increase (decrease) the parameter ``--rotate-pages-threshold``
+to make page rotation more (less) aggressive. The threshold number is the ratio
+of how confidence the OCR engine is that the document image should be changed,
+compared to kept the same. The default value is quite conservative; on some files
+it may not attempt rotations at all unless it is very confident that the current
+rotation is wrong. A lower value of ``2.0`` will produce more rotations, and
+more false positives. Run with ``-v1`` to see the confidence level for each
+page to see if there may be a better value for your files.
+
+If the page is "just a little off horizontal", like a crooked picture,
+then you want ``--deskew``. ``--rotate-pages`` is for when the cardinal
+angle is wrong.
+
+OCR languages other than English
+--------------------------------
+
+OCRmyPDF assumes the document is in English unless told otherwise. OCR
+quality may be poor if the wrong language is used.
+
+.. code-block:: bash
+
+    ocrmypdf -l fra LeParisien.pdf LeParisien.pdf
+    ocrmypdf -l eng+fra Bilingual-English-French.pdf Bilingual-English-French.pdf
+
+Language packs must be installed for all languages specified. See
+:ref:`Installing additional language packs <lang-packs>`.
+
+Unfortunately, the Tesseract OCR engine has no ability to detect the
+language when it is unknown.
+
+Produce PDF and text file containing OCR text
+---------------------------------------------
+
+This produces a file named "output.pdf" and a companion text file named
+"output.txt".
+
+.. code-block:: bash
+
+    ocrmypdf --sidecar output.txt input.pdf output.pdf
+
+.. note::
+
+    The sidecar file contains the **OCR text** found by OCRmyPDF. If the document
+    contains pages that already have text, that text will not appear in the
+    sidecar. If the option ``--pages`` is used, only those pages on which OCR
+    was performed will be included in the sidecar. If certain pages were skipped
+    because of options like ``--skip-big`` or ``--tesseract-timeout``, those pages
+    will not be in the sidecar.
+
+    To extract all text from a PDF, whether generated from OCR or otherwise,
+    use a program like Poppler's ``pdftotext`` or ``pdfgrep``.
+
+OCR images, not PDFs
+--------------------
+
+Option: use Tesseract
+~~~~~~~~~~~~~~~~~~~~~
+
+If you are starting with images, you can just use Tesseract directly to
+convert images to PDFs:
+
+.. code-block:: bash
+
+    tesseract my-image.jpg output-prefix pdf
+
+.. code-block:: bash
+
+    # When there are multiple images
+    tesseract text-file-containing-list-of-image-filenames.txt output-prefix pdf
+
+Tesseract's PDF output is quite good – OCRmyPDF uses it internally, in
+some cases. However, OCRmyPDF has many features not available in
+Tesseract like image processing, metadata control, and PDF/A generation.
+
+Option: use img2pdf
+~~~~~~~~~~~~~~~~~~~
+
+You can also use a program like
+`img2pdf <https://gitlab.mister-muffin.de/josch/img2pdf>`__ to convert
+your images to PDFs, and then pipe the results to run ocrmypdf. The
+``-`` tells ocrmypdf to read standard input.
+
+.. code-block:: bash
+
+    img2pdf my-images*.jpg | ocrmypdf - myfile.pdf
+
+``img2pdf`` is recommended because it does an excellent job at
+generating PDFs without transcoding images.
+
+Option: use OCRmyPDF (single images only)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+For convenience, OCRmyPDF can also convert single images to PDFs on its
+own. If the resolution (dots per inch, DPI) of an image is not set or is
+incorrect, it can be overridden with ``--image-dpi``. (As 1 inch is 2.54
+cm, 1 dpi = 0.39 dpcm).
+
+.. code-block:: bash
+
+    ocrmypdf --image-dpi 300 image.png myfile.pdf
+
+If you have multiple images, you must use ``img2pdf`` to convert the
+images to PDF.
+
+Not recommended
+~~~~~~~~~~~~~~~
+
+We caution against using ImageMagick or Ghostscript to convert images to
+PDF, since they may transcode images or produce downsampled images,
+sometimes without warning.
+
+Image processing
+================
+
+OCRmyPDF perform some image processing on each page of a PDF, if
+desired. The same processing is applied to each page. It is suggested
+that the user review files after image processing as these commands
+might remove desirable content, especially from poor quality scans.
+
+-  ``--rotate-pages`` attempts to determine the correct orientation for
+   each page and rotates the page if necessary.
+-  ``--remove-background`` attempts to detect and remove a noisy
+   background from grayscale or color images. Monochrome images are
+   ignored. This should not be used on documents that contain color
+   photos as it may remove them.
+-  ``--deskew`` will correct pages were scanned at a skewed angle by
+   rotating them back into place.
+-  ``--clean`` uses
+   `unpaper <https://www.flameeyes.eu/projects/unpaper>`__ to clean up
+   pages before OCR, but does not alter the final output. This makes it
+   less likely that OCR will try to find text in background noise.
+-  ``--clean-final`` uses unpaper to clean up pages before OCR and
+   inserts the page into the final output. You will want to review each
+   page to ensure that unpaper did not remove something important.
+
+.. note::
+
+   In many cases image processing will rasterize PDF pages as images,
+   potentially losing quality.
+
+.. warning::
+
+   ``--clean-final`` and ``-remove-background`` may leave undesirable
+   visual artifacts in some images where their algorithms have
+   shortcomings. Files should be visually reviewed after using these
+   options.
+
+Example: OCR and correct document skew (crooked scan)
+-----------------------------------------------------
+
+Deskew:
+
+.. code-block:: bash
+
+    ocrmypdf --deskew input.pdf output.pdf
+
+Image processing commands can be combined. The order in which options
+are given does not matter. OCRmyPDF always applies the steps of the
+image processing pipeline in the same order (rotate, remove background,
+deskew, clean).
+
+.. code-block:: bash
+
+    ocrmypdf --deskew --clean --rotate-pages input.pdf output.pdf
+
+Don't actually OCR my PDF
+=========================
+
+If you set ``--tesseract-timeout 0`` OCRmyPDF will apply its image
+processing without performing OCR, if all you want to is to apply image
+processing or PDF/A conversion.
+
+.. code-block:: bash
+
+    ocrmypdf --tesseract-timeout=0 --remove-background input.pdf output.pdf
+
+Optimize images without performing OCR
+--------------------------------------
+
+You can also optimize all images without performing any OCR:
+
+.. code-block:: bash
+
+    ocrmypdf --tesseract-timeout=0 --optimize 3 --skip-text input.pdf output.pdf
+
+Perform OCR only certain pages
+------------------------------
+
+You can ask OCRmyPDF to only apply OCR to certain pages.
+
+.. code-block:: bash
+
+    ocrmypdf --pages 2,3,13-17 input.pdf output.pdf
+
+Hyphens denote a range of pages and commas separate page numbers. If you prefer
+to use spaces, quote all of the page numbers: ``--pages '2, 3, 5, 7'``.
+
+OCRmyPDF will warn if your list of page numbers contains duplicates or
+overlap pages. OCRmyPDF does not currently account for document page numbers,
+such as an introduction section of a book that uses Roman numerals. It simply
+counts the number of virtual pieces of paper since the start.
+
+Regardless of the argument to ``--pages``, OCRmyPDF will optimize all pages in
+the file and convert it to PDF/A, unless you disable those options. In this
+example, we want to OCR only the title and otherwise change the PDF as little
+as possible:
+
+.. code-block:: bash
+
+    ocrmypdf --pages 1 --output-type pdf --optimize 0 input.pdf output.pdf
+
+Redo existing OCR
+=================
+
+To redo OCR on a file OCRed with other OCR software or a previous
+version of OCRmyPDF and/or Tesseract, you may use the ``--redo-ocr``
+argument. (Normally, OCRmyPDF will exit with an error if asked to modify
+a file with OCR.)
+
+This may be helpful for users who want to take advantage of accuracy
+improvements in Tesseract 4.0 for files they previously OCRed with an
+earlier version of Tesseract and OCRmyPDF.
+
+.. code-block:: bash
+
+    ocrmypdf --redo-ocr input.pdf output.pdf
+
+This method will replace OCR without rasterizing, reducing quality or
+removing vector content. If a file contains a mix of pure digital text
+and OCR, digital text will be ignored and OCR will be replaced. As such
+this mode is incompatible with image processing options, since they
+alter the appearance of the file.
+
+In some cases, existing OCR cannot be detected or replaced. Files
+produced by OCRmyPDF v2.2 or earlier, for example, are internally
+represented as having visible text with an opaque image drawn on top.
+This situation cannot be detected.
+
+If ``--redo-ocr`` does not work, you can use ``--force-ocr``, which will
+force rasterization of all pages, potentially reducing quality or losing
+vector content.
+
+Improving OCR quality
+=====================
+
+The `Image processing <#image-processing>`__ features can improve OCR
+quality.
+
+Rotating pages and deskewing helps to ensure that the page orientation
+is correct before OCR begins. Removing the background and/or cleaning
+the page can also improve results. The ``--oversample DPI`` argument can
+be specified to resample images to higher resolution before attempting
+OCR; this can improve results as well.
+
+OCR quality will suffer if the resolution of input images is not correct
+(since the range of pixel sizes that will be checked for possible fonts
+will also be incorrect).
+
+PDF optimization
+================
+
+By default OCRmyPDF will attempt to perform lossless optimizations on
+the images inside PDFs after OCR is complete. Optimization is performed
+even if no OCR text is found.
+
+The ``--optimize N`` (short form ``-O``) argument controls optimization,
+where ``N`` ranges from 0 to 3 inclusive, analogous to the optimization
+levels in the GCC compiler.
+
+.. list-table::
+    :widths: auto
+    :header-rows: 1
+
+    *   - Level
+        - Comments
+    *   - ``--optimize 0``
+        - Disables optimization.
+    *   - ``--optimize 1``
+        - Enables lossless optimizations, such as transcoding images to more
+          efficient formats. Also compress other uncompressed objects in the
+          PDF and enables the more efficient "object streams" within the PDF.
+    *   - ``--optimize 2``
+        - All of the above, and enables lossy optimizations and color quantization.
+    *   - ``--optimize 3``
+        - All of the above, and enables more aggressive optimizations and targets lower image quality.
+
+Optimization is improved when a JBIG2 encoder is available and when
+``pngquant`` is installed. If either of these components are missing,
+then some types of images cannot be optimized.
+
+The types of optimization available may expand over time. By default,
+OCRmyPDF compresses data streams inside PDFs, and will change
+inefficient compression modes to more modern versions. A program like
+``qpdf`` can be used to change encodings, e.g. to inspect the internals
+fo a PDF.
+
+.. code-block:: bash
+
+    ocrmypdf --optimize 3 in.pdf out.pdf  # Make it small
+
+Some users may consider enabling lossy JBIG2. See: :ref:`jbig2-lossy`.

docs/docker.rst

@@ -0,0 +1,196 @@
+.. _docker:
+
+=====================
+OCRmyPDF Docker image
+=====================
+
+OCRmyPDF is also available in a Docker image that packages recent
+versions of all dependencies.
+
+For users who already have Docker installed this may be an easy and
+convenient option. However, it is less performant than a system
+installation and may require Docker engine configuration.
+
+OCRmyPDF needs a generous amount of RAM, CPU cores, temporary storage
+space, whether running in a Docker container or on its own. It may be
+necessary to ensure the container is provisioned with additional
+resources.
+
+.. _docker-install:
+
+Installing the Docker image
+===========================
+
+If you have `Docker <https://docs.docker.com/>`__ installed on your
+system, you can install a Docker image of the latest release.
+
+If you can run this command successfully, your system is ready to download and
+execute the image:
+
+.. code-block:: bash
+
+   docker run hello-world
+
+The recommended OCRmyPDF Docker image is currently named ``ocrmypdf``:
+
+.. code-block:: bash
+
+   docker pull jbarlow83/ocrmypdf
+
+
+OCRmyPDF will use all available CPU cores. By default, the VirtualBox
+machine instance on Windows and macOS has only a single CPU core
+enabled. Use the VirtualBox Manager to determine the name of your Docker
+engine host, and then follow these optional steps to enable multiple
+CPUs:
+
+.. code-block:: bash
+
+   # Optional step for Mac OS X users
+   docker-machine stop "yourVM"
+   VBoxManage modifyvm "yourVM" --cpus 2  # or whatever number of core is desired
+   docker-machine start "yourVM"
+   eval $(docker-machine env "yourVM")
+
+See the Docker documentation for
+`adjusting memory and CPU on other platforms <https://docs.docker.com/config/containers/resource_constraints/>`__.
+
+Using the Docker image on the command line
+==========================================
+
+**Unlike typical Docker containers**, in this section the OCRmyPDF Docker
+container is emphemeral – it runs for one OCR job and terminates, just like a
+command line program. We are using Docker to deliver an application (as opposed
+to the more conventional case, where a Docker container runs as a server).
+
+To start a Docker container (instance of the image):
+
+.. code-block:: bash
+
+   docker tag jbarlow83/ocrmypdf ocrmypdf
+   docker run --rm -i ocrmypdf (... all other arguments here...) - -
+
+For convenience, create a shell alias to hide the Docker command. It is
+easier to send the input file as stdin and read the output from
+stdout – **this avoids the messy permission issues with Docker entirely**.
+
+.. code-block:: bash
+
+   alias docker_ocrmypdf='docker run --rm -i ocrmypdf'
+   docker_ocrmypdf --version  # runs docker version
+   docker_ocrmypdf - - <input.pdf >output.pdf
+
+Or in the wonderful `fish shell <https://fishshell.com/>`__:
+
+.. code-block:: fish
+
+   alias docker_ocrmypdf 'docker run --rm ocrmypdf'
+   funcsave docker_ocrmypdf
+
+Alternately, you could mount the local current working directory as a
+Docker volume:
+
+.. code-block:: bash
+
+   alias docker_ocrmypdf='docker run --rm  -i --user "$(id -u):$(id -g)" --workdir /data -v "$PWD:/data" ocrmypdf'
+   docker_ocrmypdf /data/input.pdf /data/output.pdf
+
+.. _docker-lang-packs:
+
+Adding languages to the Docker image
+====================================
+
+By default the Docker image includes English, German, Simplified Chinese,
+French, Portuguese and Spanish, the most popular languages for OCRmyPDF
+users based on feedback. You may add other languages by creating a new
+Dockerfile based on the public one.
+
+.. code-block:: dockerfile
+
+   FROM jbarlow83/ocrmypdf
+
+   # Example: add Italian
+   RUN apt install tesseract-ocr-ita
+
+To install language packs (training data) such as the 
+`tessdata_best <https://github.com/tesseract-ocr/tessdata_best>`_ suite or
+custom data, you first need to determine the version of Tesseract data files, which
+may differ from the Tesseract program version. Use this command to determine the data
+file version:
+
+.. code-block:: bash
+
+   docker run -i --rm --entrypoint /bin/ls jbarlow83/ocrmypdf /usr/share/tesseract-ocr
+
+As of 2021, the data file version is probably ``4.00``.
+
+You can then add new data with either a Dockerfile:
+
+.. code-block:: dockerfile
+
+   FROM jbarlow83/ocrmypdf
+
+   # Example: add a tessdata_best file
+   COPY chi_tra_vert.traineddata /usr/share/tesseract-ocr/<data version>/tessdata/
+
+Alternately, you can copy training data into a Docker container as follows:
+
+.. code-block:: bash
+
+   docker cp mycustomtraining.traineddata name_of_container:/usr/share/tesseract-ocr/<tesseract version>/tessdata/
+
+Executing the test suite
+========================
+
+The OCRmyPDF test suite is installed with image. To run it:
+
+.. code-block:: bash
+
+   docker run --entrypoint python3  jbarlow83/ocrmypdf -m pytest
+
+Accessing the shell
+===================
+
+To use the bash shell in the Docker image:
+
+.. code-block:: bash
+
+   docker run -it --entrypoint bash  jbarlow83/ocrmypdf
+
+Using the OCRmyPDF web service wrapper
+======================================
+
+The OCRmyPDF Docker image includes an example, barebones HTTP web
+service. The webservice may be launched as follows:
+
+.. code-block:: bash
+
+   docker run --entrypoint python3 -p 5000:5000  jbarlow83/ocrmypdf webservice.py
+
+This will configure the machine to listen on port 5000. On Linux machines
+this is port 5000 of localhost. On macOS or Windows machines running
+Docker, this is port 5000 of the virtual machine that runs your Docker
+images. You can find its IP address using the command ``docker-machine ip``.
+
+Unlike command line usage this program will open a socket and wait for
+connections.
+
+.. warning::
+
+   The OCRmyPDF web service wrapper is intended for demonstration or
+   development. It provides no security, no authentication, no
+   protection against denial of service attacks, and no load balancing.
+   The default Flask WSGI server is used, which is intended for
+   development only. The server is single-threaded and so can respond to
+   only one client at a time. While running OCR, it cannot respond to
+   any other clients.
+
+Clients must keep their open connection while waiting for OCR to
+complete. This may entail setting a long timeout; this interface is more
+useful for internal HTTP API calls.
+
+Unlike the rest of OCRmyPDF, this web service is licensed under the
+Affero GPLv3 (AGPLv3) since Ghostscript is also licensed in this way.
+
+In addition to the above, please read our
+:ref:`general remarks on using OCRmyPDF as a service <ocr-service>`.

docs/errors.rst

@@ -0,0 +1,53 @@
+=====================
+Common error messages
+=====================
+
+Page already has text
+=====================
+
+.. code-block::
+
+   ERROR -    1: page already has text! – aborting (use --force-ocr to force OCR)
+
+You ran ocrmypdf on a file that already contains printable text or a
+hidden OCR text layer (it can't quite tell the difference). You probably
+don't want to do this, because the file is already searchable.
+
+As the error message suggests, your options are:
+
+-  ``ocrmypdf --force-ocr`` to :ref:`rasterize <raster-vector>` all
+   vector content and run OCR on the images. This is useful if a
+   previous OCR program failed, or if the document contains a text
+   watermark.
+-  ``ocrmypdf --skip-text`` to skip OCR and other processing on any
+   pages that contain text. Text pages will be copied into the output
+   PDF without modification.
+-  ``ocrmypdf --redo-ocr`` to scan the file for any existing OCR
+   (non-printing text), remove it, and do OCR again. This is one way
+   to take advantage of improvements in OCR accuracy. Printable vector
+   text is excluded from OCR, so this can be used on files that contain
+   a mix of digital and scanned files.
+
+
+Input file 'filename' is not a valid PDF
+========================================
+
+OCRmyPDF checks files with pikepdf, a library that in turn uses libqpdf to fixes
+errors in PDFs, before it tries to work on them. In most cases this happens
+because the PDF is corrupt and truncated (incomplete file copying) and not much
+can be done.
+
+You can try rewriting the file with Ghostscript:
+
+.. code-block:: bash
+
+    gs -o output.pdf -dSAFER -sDEVICE=pdfwrite input.pdf
+
+``pdftk`` can also rewrite PDFs:
+
+.. code-block:: bash
+
+    pdftk input.pdf cat output output.pdf
+
+Sometimes Acrobat can repair PDFs with its `Preflight
+tool <https://helpx.adobe.com/acrobat/using/correcting-problem-areas-preflight-tool.html>`__.

docs/images/bitmap_vs_svg.svg

@@ -0,0 +1,35 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg xmlns="http://www.w3.org/2000/svg" width="100%" height="100%" viewBox="0 0 915 585" xmlns:xlink="http://www.w3.org/1999/xlink">
+<defs>
+<linearGradient id="b" y2="445" gradientUnits="userSpaceOnUse" y1="179" gradientTransform="translate(0 -2.06)" x2="-29.7" x1="322">
+<stop stop-color="#333" offset="0"/>
+<stop stop-color="#fff" stop-opacity="0" offset="1"/>
+</linearGradient>
+<linearGradient id="a" y2="414" gradientUnits="userSpaceOnUse" y1="159" x2="490" x1="815">
+<stop stop-color="#33f" offset="0"/>
+<stop stop-color="#3f3fff" stop-opacity="0" offset="1"/>
+</linearGradient>
+</defs>
+<path fill="url(#b)" d="m403 247c-12 115-135 122-368 123-4.3-1.07-7.32-7.33-6-41 76-37 151-124 167-236 93 123 201 40.9 207 154z"/>
+<g stroke-width="3.45" fill="none">
+<path stroke="#000" d="m11.8 11.8h411v411l-411 0.01v-411z"/>
+<path stroke="#448" d="m489 11.7h415v411h-415v-411z"/>
+</g>
+<path d="m876 244c-12 115-133 120-366 121-6-14-10-40-3-43 76-37.3 136-106 152-218 38 48 209 101 217 140z" fill="url(#a)"/>
+<g id="RasterLarge" transform="matrix(1.36 0 0 1.28 -161 -636)">
+<path fill="#999" d="m287 730h-30v-60h20v20h10v10h10v10h20v10h40v-10h20v-20h10v-20h-10v-10h-10v-10h-40v-10h-30v-10h-20v-10h-10v-10h-10v-60h10v-10h10v-10h10v-10h90v10h30v60h-20v-10h-10v-20h-10v-10h-20v-10h-30v10h-20v10h-10v20h10v20h30v10h30v10h30v10h10v10h10v10h10v60h-10v10h-10v10h-10v10h-100v-10z"/>
+<path fill="#555" d="m297 730h-30v-10h-10v-50h20v20h10v20h10 10v10h60v-10h10v-10h10v-40h-20v-10h-20v-10h-40v-10h-20v-10h-20v-20h-10v-50h10v-10h10v-10h20v-10h70v10h30v10h10v50h-20v-20h-10v-20h-20v-10h-50v10h-10v10h-10v30h10v10h20v10h30v10h30v10h20v10h10v10h10v50h-10v20h-10v10h-20v10h-80z"/>
+<path d="m307 730h-30v-10h-20v-50h20v30h10v10h10v10h70v-10h20v-50h-10v-10h-20v-10h-40v-10h-30v-10h-10v-10h-10v-20h-10v-30h10v-20h20v-10h20v-10h50v10h30v10h20v50h-20v-30h-10v-10h-10v-10h-70v10h-10v40h10v10h10v10h30v10h40v10h20v10h10v20h10v40h-10v20h-20v10h-30v10h-50v-10z"/>
+</g>
+<g font-size="40" font-family="sans-serif" text-anchor="middle">
+<g font-size="100">
+<text y="518" x="210">Raster</text>
+<text y="518" x="695" fill="#338">Vector</text>
+</g>
+<text y="563" x="210">.jpeg  .gif  .png</text>
+<text y="563" x="696" fill="#338">.svg</text>
+</g>
+<path id="VectorLarge" fill="#005" d="m661 294v-62.5l23.4 0.184c0.678 20.8 7.32 36.3 19.9 46.4 12.7 9.93 32.1 14.9 57.9 14.9 24.1 0 42.5-4.29 55.1-12.9 12.7-8.71 19.1-21.3 19.1-37.9 0-13.2-3.86-23.4-11.6-30.5-7.59-7.11-23.7-14-48.4-20.8l-40.1-10.9c-29-7.97-49.5-17.9-61.4-29.8-11.8-11.9-17.7-28.2-17.7-48.9 0-23.3 9.15-41.4 27.4-54.3 18.3-12.9 44-19.3 77.1-19.3 14.1 0 29.6 1.41 46.4 4.23 16.8 2.7 34.7 6.68 53.7 12v58.5h-23c-2.3-19.4-9.49-33.4-21.6-41.9-11.9-8.71-30.2-13.1-54.7-13.1-21.4 0-37.7 3.99-49 12-11.1 7.85-16.7 19.3-16.7 34.4 0 13.1 4.2 23.4 12.6 30.9 8.4 7.48 26.2 14.9 53.5 22.3l37.6 10.1c27.5 7.48 47.1 17 58.8 28.7 11.8 11.5 17.7 27 17.7 46.5 0 26.6-9.42 46.7-28.3 60.2s-46.9 20.2-84.2 20.2c-16.7 0-33.7-1.53-51-4.6-18-3-35-7-53-13z"/>
+<use xlink:href="#VectorLarge" transform="matrix(.17 0 0 .17 392 313)"/>
+<use xlink:href="#RasterLarge" transform="matrix(.173 0 0 .173 -8.25 314)" height="100%" width="100%" y="0" x="0"/>
+</svg>

docs/images/logo-square.svg

@@ -0,0 +1,233 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg
+   xmlns:serif="http://www.serif.com/"
+   xmlns:dc="http://purl.org/dc/elements/1.1/"
+   xmlns:cc="http://creativecommons.org/ns#"
+   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+   xmlns:svg="http://www.w3.org/2000/svg"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   width="503"
+   height="503"
+   viewBox="0 0 503 503"
+   version="1.1"
+   xml:space="preserve"
+   style="clip-rule:evenodd;fill-rule:evenodd;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:1.5"
+   id="svg270"
+   sodipodi:docname="logo-square.svg"
+   inkscape:export-filename="/home/jb/src/ocrmypdf/docs/images/logo-square.png"
+   inkscape:export-xdpi="96"
+   inkscape:export-ydpi="96"
+   inkscape:version="1.0.2 (e86c870879, 2021-01-15)"><metadata
+   id="metadata276"><rdf:RDF><cc:Work
+       rdf:about=""><dc:format>image/svg+xml</dc:format><dc:type
+         rdf:resource="http://purl.org/dc/dcmitype/StillImage" /><dc:title></dc:title></cc:Work></rdf:RDF></metadata><defs
+   id="defs274" /><sodipodi:namedview
+   pagecolor="#ffffff"
+   bordercolor="#666666"
+   borderopacity="1"
+   objecttolerance="10"
+   gridtolerance="10"
+   guidetolerance="10"
+   inkscape:pageopacity="0"
+   inkscape:pageshadow="2"
+   inkscape:window-width="2396"
+   inkscape:window-height="1691"
+   id="namedview272"
+   showgrid="false"
+   lock-margins="false"
+   inkscape:zoom="2.0079523"
+   inkscape:cx="251.5"
+   inkscape:cy="193.18317"
+   inkscape:window-x="26"
+   inkscape:window-y="23"
+   inkscape:window-maximized="0"
+   inkscape:current-layer="svg270" />
+    <g
+   id="svg"
+   transform="matrix(0.965977,0,0,0.807602,0,138.43572)">
+        <rect
+   x="0"
+   y="0"
+   width="520"
+   height="280"
+   style="fill:#ffffff"
+   id="rect188" />
+        <g
+   transform="matrix(1.03522,0,0,1.23823,-69.7528,-83.422)"
+   id="g267">
+            <g
+   transform="translate(243.977,20.0703)"
+   id="g218">
+                <g
+   id="Page">
+                    <g
+   transform="matrix(0.961773,0,0,1.05962,6.19811,-3.01071)"
+   id="g192">
+                        <path
+   d="m 328.5,97.682 c 0,-1.217 -0.517,-2.386 -1.444,-3.264 -7.03,-6.66 -37.614,-35.638 -44.828,-42.474 -0.977,-0.925 -2.327,-1.448 -3.738,-1.448 -13.997,0 -90.407,0 -111.151,0 -2.871,0 -5.198,2.113 -5.198,4.718 0,27.837 0,170.351 0,198.186 0,2.605 2.327,4.717 5.197,4.717 24.904,0 131.821,0 156.2,0 2.74,0 4.962,-2.016 4.962,-4.504 0,-24.345 0,-139.717 0,-155.931 z"
+   style="fill:#fdfdfd;stroke:#333333;stroke-width:3.95px"
+   id="path190" />
+                    </g>
+                    <g
+   id="Dog-ear"
+   serif:id="Dog ear"
+   transform="translate(-4,2)">
+                        <path
+   d="m 277.072,48.496 v 45.352 c 0,1.324 0.526,2.593 1.462,3.529 0.936,0.936 2.205,1.462 3.529,1.462 12.485,0 44.078,0 44.078,0"
+   style="fill:#f5f5f5;stroke:#333333;stroke-width:4px"
+   id="path194" />
+                    </g>
+                </g>
+                <g
+   transform="translate(-29.6816,-0.395178)"
+   id="g216">
+                    <g
+   transform="matrix(1.00243,0,0,1.11818,-144.72,-8.80181)"
+   id="g200">
+                        <path
+   d="m 465.73,119.654 c 0,-2.049 -1.856,-3.713 -4.142,-3.713 H 310.259 c -2.286,0 -4.142,1.664 -4.142,3.713 v 63.454 c 0,2.049 1.856,3.713 4.142,3.713 h 151.329 c 2.286,0 4.142,-1.664 4.142,-3.713 z"
+   style="fill:#f80000;stroke:#ffffff;stroke-width:3.77px"
+   id="path198" />
+                    </g>
+                    <g
+   transform="matrix(1.24571,0,0,1.35864,116.812,84.3924)"
+   id="g214">
+                        <g
+   transform="matrix(64,0,0,64,42.1437,77.6203)"
+   id="g204">
+                            <path
+   d="m 0.084,0 v -0.68 h 0.213 c 0.074,0 0.137,0.017 0.19,0.05 0.053,0.034 0.079,0.09 0.079,0.168 0,0.077 -0.028,0.134 -0.085,0.17 -0.057,0.037 -0.121,0.055 -0.193,0.055 H 0.213 V 0 Z m 0.209,-0.572 h -0.08 v 0.228 h 0.082 c 0.039,0 0.07,-0.009 0.094,-0.027 0.024,-0.017 0.037,-0.045 0.04,-0.083 0,-0.044 -0.012,-0.075 -0.036,-0.092 -0.024,-0.017 -0.057,-0.026 -0.1,-0.026 z"
+   style="fill:#ffffff;fill-rule:nonzero"
+   id="path202" />
+                        </g>
+                        <g
+   transform="matrix(64,0,0,64,79.7117,77.6203)"
+   id="g208">
+                            <path
+   d="M 0.332,0 H 0.084 v -0.68 h 0.252 c 0.105,0 0.182,0.032 0.233,0.095 0.051,0.063 0.076,0.144 0.076,0.241 0,0.105 -0.027,0.189 -0.082,0.251 C 0.508,-0.031 0.431,0 0.332,0 Z M 0.337,-0.57 H 0.213 v 0.461 H 0.33 c 0.055,0 0.099,-0.018 0.132,-0.054 C 0.495,-0.199 0.511,-0.259 0.511,-0.344 0.511,-0.415 0.497,-0.47 0.469,-0.51 0.441,-0.55 0.397,-0.57 0.337,-0.57 Z"
+   style="fill:#ffffff;fill-rule:nonzero"
+   id="path206" />
+                        </g>
+                        <g
+   transform="matrix(64,0,0,64,123.424,77.6203)"
+   id="g212">
+                            <path
+   d="M 0.405,-0.288 H 0.213 V 0 H 0.084 v -0.68 h 0.385 l 0.02,0.102 H 0.213 v 0.189 h 0.173 z"
+   style="fill:#ffffff;fill-rule:nonzero"
+   id="path210" />
+                        </g>
+                    </g>
+                </g>
+            </g>
+            <g
+   transform="matrix(1,0,0,1.52217,67.3796,10.7507)"
+   id="g222">
+                <rect
+   x="23.500999"
+   y="81.300003"
+   width="162.30499"
+   height="61.77"
+   style="fill:#b4d5ff"
+   id="rect220" />
+            </g>
+            <g
+   transform="matrix(0.967536,0,0,0.961535,5.90498,47.9703)"
+   id="g236">
+                <g
+   transform="matrix(90.4804,0,0,90.4804,82.6698,167.705)"
+   id="g226">
+                    <path
+   d="m 0.057,-0.337 c 0,-0.105 0.027,-0.19 0.082,-0.257 0.055,-0.066 0.132,-0.1 0.231,-0.102 0.107,0 0.186,0.034 0.237,0.103 0.051,0.069 0.077,0.152 0.077,0.249 0,0.105 -0.027,0.191 -0.082,0.258 -0.055,0.067 -0.133,0.1 -0.232,0.1 C 0.264,0.014 0.185,-0.02 0.134,-0.089 0.083,-0.157 0.057,-0.24 0.057,-0.337 Z m 0.135,-0.001 c 0,0.071 0.014,0.13 0.043,0.175 0.029,0.045 0.073,0.068 0.134,0.068 0.055,0 0.098,-0.02 0.131,-0.061 0.033,-0.041 0.049,-0.103 0.049,-0.188 0,-0.071 -0.014,-0.129 -0.043,-0.174 -0.029,-0.045 -0.073,-0.068 -0.134,-0.068 -0.053,0 -0.097,0.022 -0.13,0.067 -0.033,0.045 -0.05,0.105 -0.05,0.181 z"
+   style="fill:#333333;fill-rule:nonzero"
+   id="path224" />
+                </g>
+                <g
+   transform="matrix(90.4804,0,0,90.4804,147.906,167.705)"
+   id="g230">
+                    <path
+   d="M 0.505,-0.557 C 0.473,-0.567 0.448,-0.574 0.429,-0.579 0.41,-0.583 0.388,-0.585 0.361,-0.585 c -0.054,0 -0.096,0.022 -0.125,0.066 -0.029,0.044 -0.044,0.104 -0.044,0.181 0,0.066 0.012,0.123 0.037,0.171 0.025,0.048 0.066,0.072 0.124,0.072 0.029,0 0.056,-0.003 0.081,-0.009 0.025,-0.006 0.047,-0.013 0.068,-0.022 L 0.551,-0.03 C 0.525,-0.017 0.494,-0.006 0.457,0.002 0.42,0.01 0.388,0.014 0.36,0.014 0.254,0.014 0.177,-0.02 0.129,-0.088 0.081,-0.156 0.057,-0.239 0.057,-0.337 c 0,-0.105 0.027,-0.19 0.08,-0.257 0.053,-0.067 0.129,-0.1 0.228,-0.1 0.02,0 0.048,0.003 0.083,0.01 0.035,0.007 0.068,0.018 0.097,0.034 z"
+   style="fill:#333333;fill-rule:nonzero"
+   id="path228" />
+                </g>
+                <g
+   transform="matrix(90.4804,0,0,90.4804,199.751,167.705)"
+   id="g234">
+                    <path
+   d="m 0.293,-0.572 h -0.08 v 0.208 h 0.082 c 0.039,0 0.071,-0.008 0.096,-0.024 0.025,-0.015 0.038,-0.041 0.038,-0.077 0,-0.038 -0.012,-0.065 -0.036,-0.082 -0.024,-0.017 -0.057,-0.025 -0.1,-0.025 z M 0.479,0 0.335,-0.26 C 0.328,-0.259 0.32,-0.259 0.312,-0.259 0.304,-0.258 0.296,-0.258 0.288,-0.258 H 0.213 V 0 H 0.084 v -0.68 h 0.213 c 0.074,0 0.137,0.017 0.19,0.051 0.053,0.034 0.079,0.087 0.079,0.158 0,0.042 -0.011,0.078 -0.032,0.108 -0.022,0.031 -0.05,0.054 -0.084,0.071 L 0.617,0 Z"
+   style="fill:#333333;fill-rule:nonzero"
+   id="path232" />
+                </g>
+            </g>
+            <g
+   transform="matrix(0.916882,0,0,1,121.475,-32.6535)"
+   id="g246">
+                <g
+   transform="matrix(86.953,0,0,86.953,152.996,241.878)"
+   id="g240">
+                    <path
+   d="M 0.479,-0.428 C 0.5,-0.451 0.527,-0.47 0.562,-0.484 c 0.034,-0.013 0.065,-0.02 0.092,-0.02 0.066,0 0.113,0.019 0.141,0.058 0.027,0.039 0.041,0.086 0.041,0.142 V 0 H 0.705 v -0.298 c 0,-0.031 -0.007,-0.054 -0.022,-0.071 -0.015,-0.016 -0.036,-0.024 -0.064,-0.024 -0.019,0 -0.038,0.005 -0.059,0.015 -0.021,0.01 -0.039,0.021 -0.056,0.034 0.001,0.007 0.001,0.013 0.002,0.02 0.001,0.007 0.001,0.013 0.001,0.02 V 0 H 0.376 v -0.298 c 0,-0.031 -0.007,-0.054 -0.022,-0.071 -0.015,-0.016 -0.036,-0.024 -0.063,-0.024 -0.017,0 -0.033,0.003 -0.05,0.01 -0.017,0.007 -0.034,0.016 -0.049,0.027 V 0 H 0.062 V -0.485 H 0.13 l 0.032,0.044 c 0.022,-0.02 0.049,-0.035 0.08,-0.047 0.031,-0.011 0.058,-0.016 0.083,-0.016 0.038,0 0.07,0.007 0.095,0.02 0.025,0.014 0.045,0.033 0.059,0.056 z"
+   style="fill:#333333;fill-rule:nonzero"
+   id="path238" />
+                </g>
+                <g
+   transform="matrix(86.953,0,0,86.953,228.906,241.878)"
+   id="g244">
+                    <path
+   d="M 0.156,0.023 0.179,-0.034 0.006,-0.467 0.14,-0.485 0.252,-0.191 0.358,-0.485 H 0.495 L 0.278,0.064 C 0.263,0.103 0.236,0.137 0.197,0.165 0.158,0.193 0.118,0.212 0.075,0.222 L 0.029,0.115 C 0.052,0.105 0.077,0.093 0.104,0.079 0.13,0.064 0.147,0.046 0.156,0.023 Z"
+   style="fill:#333333;fill-rule:nonzero"
+   id="path242" />
+                </g>
+            </g>
+            <g
+   id="Selectors"
+   transform="matrix(0.965977,0,0,0.807602,67.3796,67.3718)">
+                <g
+   id="Right-selector"
+   serif:id="Right selector">
+                    <g
+   transform="matrix(1.03522,0,0,1.23823,2.07044,0)"
+   id="g250">
+                        <path
+   d="M 185.806,161.156 V 67.132"
+   style="fill:none;stroke:#4c9fff;stroke-width:4px;stroke-linecap:butt"
+   id="path248" />
+                    </g>
+                    <g
+   transform="matrix(1.03522,0,0,1.23823,161.788,169.469)"
+   id="g254">
+                        <circle
+   cx="31.523001"
+   cy="34.313999"
+   r="10.021"
+   style="fill:#4c9fff;stroke:#4c9fff;stroke-width:4px;stroke-linecap:butt"
+   id="circle252" />
+                    </g>
+                </g>
+                <g
+   id="Left-selector"
+   serif:id="Left selector">
+                    <g
+   transform="matrix(1.03522,0,0,1.23823,-170.092,0)"
+   id="g259">
+                        <path
+   d="M 185.806,161.156 V 67.132"
+   style="fill:none;stroke:#4c9fff;stroke-width:4px;stroke-linecap:butt"
+   id="path257" />
+                    </g>
+                    <g
+   transform="matrix(1.03522,0,0,1.23823,-10.3742,28.2274)"
+   id="g263">
+                        <circle
+   cx="31.523001"
+   cy="34.313999"
+   r="10.021"
+   style="fill:#4c9fff;stroke:#4c9fff;stroke-width:4px;stroke-linecap:butt"
+   id="circle261" />
+                    </g>
+                </g>
+            </g>
+        </g>
+    </g>
+</svg>

docs/images/logo.svg

@@ -0,0 +1,75 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<svg width="100%" height="100%" viewBox="0 0 503 227" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xml:space="preserve" xmlns:serif="http://www.serif.com/" style="fill-rule:evenodd;clip-rule:evenodd;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:1.5;">
+    <g id="svg" transform="matrix(0.965977,0,0,0.807602,0,0)">
+        <rect x="0" y="0" width="520" height="280" style="fill:white;"/>
+        <g transform="matrix(1.03522,0,0,1.23823,-69.7528,-83.422)">
+            <g transform="matrix(1,0,0,1,243.977,20.0703)">
+                <g id="Page">
+                    <g transform="matrix(0.961773,0,0,1.05962,6.19811,-3.01071)">
+                        <path d="M328.5,97.682C328.5,96.465 327.983,95.296 327.056,94.418C320.026,87.758 289.442,58.78 282.228,51.944C281.251,51.019 279.901,50.496 278.49,50.496C264.493,50.496 188.083,50.496 167.339,50.496C164.468,50.496 162.141,52.609 162.141,55.214C162.141,83.051 162.141,225.565 162.141,253.4C162.141,256.005 164.468,258.117 167.338,258.117C192.242,258.117 299.159,258.117 323.538,258.117C326.278,258.117 328.5,256.101 328.5,253.613C328.5,229.268 328.5,113.896 328.5,97.682Z" style="fill:rgb(253,253,253);stroke:rgb(51,51,51);stroke-width:3.95px;"/>
+                    </g>
+                    <g id="Dog-ear" serif:id="Dog ear" transform="matrix(1,0,0,1,-4,2)">
+                        <path d="M277.072,48.496L277.072,93.848C277.072,95.172 277.598,96.441 278.534,97.377C279.47,98.313 280.739,98.839 282.063,98.839C294.548,98.839 326.141,98.839 326.141,98.839" style="fill:rgb(245,245,245);stroke:rgb(51,51,51);stroke-width:4px;"/>
+                    </g>
+                </g>
+                <g transform="matrix(1,0,0,1,-29.6816,-0.395178)">
+                    <g transform="matrix(1.00243,0,0,1.11818,-144.72,-8.80181)">
+                        <path d="M465.73,119.654C465.73,117.605 463.874,115.941 461.588,115.941L310.259,115.941C307.973,115.941 306.117,117.605 306.117,119.654L306.117,183.108C306.117,185.157 307.973,186.821 310.259,186.821L461.588,186.821C463.874,186.821 465.73,185.157 465.73,183.108L465.73,119.654Z" style="fill:rgb(248,0,0);stroke:white;stroke-width:3.77px;"/>
+                    </g>
+                    <g transform="matrix(1.24571,0,0,1.35864,116.812,84.3924)">
+                        <g transform="matrix(64,0,0,64,42.1437,77.6203)">
+                            <path d="M0.084,0L0.084,-0.68L0.297,-0.68C0.371,-0.68 0.434,-0.663 0.487,-0.63C0.54,-0.596 0.566,-0.54 0.566,-0.462C0.566,-0.385 0.538,-0.328 0.481,-0.292C0.424,-0.255 0.36,-0.237 0.288,-0.237L0.213,-0.237L0.213,0L0.084,0ZM0.293,-0.572L0.213,-0.572L0.213,-0.344L0.295,-0.344C0.334,-0.344 0.365,-0.353 0.389,-0.371C0.413,-0.388 0.426,-0.416 0.429,-0.454C0.429,-0.498 0.417,-0.529 0.393,-0.546C0.369,-0.563 0.336,-0.572 0.293,-0.572Z" style="fill:white;fill-rule:nonzero;"/>
+                        </g>
+                        <g transform="matrix(64,0,0,64,79.7117,77.6203)">
+                            <path d="M0.332,0L0.084,0L0.084,-0.68L0.336,-0.68C0.441,-0.68 0.518,-0.648 0.569,-0.585C0.62,-0.522 0.645,-0.441 0.645,-0.344C0.645,-0.239 0.618,-0.155 0.563,-0.093C0.508,-0.031 0.431,0 0.332,0ZM0.337,-0.57L0.213,-0.57L0.213,-0.109L0.33,-0.109C0.385,-0.109 0.429,-0.127 0.462,-0.163C0.495,-0.199 0.511,-0.259 0.511,-0.344C0.511,-0.415 0.497,-0.47 0.469,-0.51C0.441,-0.55 0.397,-0.57 0.337,-0.57Z" style="fill:white;fill-rule:nonzero;"/>
+                        </g>
+                        <g transform="matrix(64,0,0,64,123.424,77.6203)">
+                            <path d="M0.405,-0.288L0.213,-0.288L0.213,0L0.084,0L0.084,-0.68L0.469,-0.68L0.489,-0.578L0.213,-0.578L0.213,-0.389L0.386,-0.389L0.405,-0.288Z" style="fill:white;fill-rule:nonzero;"/>
+                        </g>
+                    </g>
+                </g>
+            </g>
+            <g transform="matrix(1,0,0,1.52217,67.3796,10.7507)">
+                <rect x="23.501" y="81.3" width="162.305" height="61.77" style="fill:rgb(180,213,255);"/>
+            </g>
+            <g transform="matrix(0.967536,0,0,0.961535,5.90498,47.9703)">
+                <g transform="matrix(90.4804,0,0,90.4804,82.6698,167.705)">
+                    <path d="M0.057,-0.337C0.057,-0.442 0.084,-0.527 0.139,-0.594C0.194,-0.66 0.271,-0.694 0.37,-0.696C0.477,-0.696 0.556,-0.662 0.607,-0.593C0.658,-0.524 0.684,-0.441 0.684,-0.344C0.684,-0.239 0.657,-0.153 0.602,-0.086C0.547,-0.019 0.469,0.014 0.37,0.014C0.264,0.014 0.185,-0.02 0.134,-0.089C0.083,-0.157 0.057,-0.24 0.057,-0.337ZM0.192,-0.338C0.192,-0.267 0.206,-0.208 0.235,-0.163C0.264,-0.118 0.308,-0.095 0.369,-0.095C0.424,-0.095 0.467,-0.115 0.5,-0.156C0.533,-0.197 0.549,-0.259 0.549,-0.344C0.549,-0.415 0.535,-0.473 0.506,-0.518C0.477,-0.563 0.433,-0.586 0.372,-0.586C0.319,-0.586 0.275,-0.564 0.242,-0.519C0.209,-0.474 0.192,-0.414 0.192,-0.338Z" style="fill:rgb(51,51,51);fill-rule:nonzero;"/>
+                </g>
+                <g transform="matrix(90.4804,0,0,90.4804,147.906,167.705)">
+                    <path d="M0.505,-0.557C0.473,-0.567 0.448,-0.574 0.429,-0.579C0.41,-0.583 0.388,-0.585 0.361,-0.585C0.307,-0.585 0.265,-0.563 0.236,-0.519C0.207,-0.475 0.192,-0.415 0.192,-0.338C0.192,-0.272 0.204,-0.215 0.229,-0.167C0.254,-0.119 0.295,-0.095 0.353,-0.095C0.382,-0.095 0.409,-0.098 0.434,-0.104C0.459,-0.11 0.481,-0.117 0.502,-0.126L0.551,-0.03C0.525,-0.017 0.494,-0.006 0.457,0.002C0.42,0.01 0.388,0.014 0.36,0.014C0.254,0.014 0.177,-0.02 0.129,-0.088C0.081,-0.156 0.057,-0.239 0.057,-0.337C0.057,-0.442 0.084,-0.527 0.137,-0.594C0.19,-0.661 0.266,-0.694 0.365,-0.694C0.385,-0.694 0.413,-0.691 0.448,-0.684C0.483,-0.677 0.516,-0.666 0.545,-0.65L0.505,-0.557Z" style="fill:rgb(51,51,51);fill-rule:nonzero;"/>
+                </g>
+                <g transform="matrix(90.4804,0,0,90.4804,199.751,167.705)">
+                    <path d="M0.293,-0.572L0.213,-0.572L0.213,-0.364L0.295,-0.364C0.334,-0.364 0.366,-0.372 0.391,-0.388C0.416,-0.403 0.429,-0.429 0.429,-0.465C0.429,-0.503 0.417,-0.53 0.393,-0.547C0.369,-0.564 0.336,-0.572 0.293,-0.572ZM0.479,0L0.335,-0.26C0.328,-0.259 0.32,-0.259 0.312,-0.259C0.304,-0.258 0.296,-0.258 0.288,-0.258L0.213,-0.258L0.213,0L0.084,0L0.084,-0.68L0.297,-0.68C0.371,-0.68 0.434,-0.663 0.487,-0.629C0.54,-0.595 0.566,-0.542 0.566,-0.471C0.566,-0.429 0.555,-0.393 0.534,-0.363C0.512,-0.332 0.484,-0.309 0.45,-0.292L0.617,0L0.479,0Z" style="fill:rgb(51,51,51);fill-rule:nonzero;"/>
+                </g>
+            </g>
+            <g transform="matrix(0.916882,0,0,1,121.475,-32.6535)">
+                <g transform="matrix(86.953,0,0,86.953,152.996,241.878)">
+                    <path d="M0.479,-0.428C0.5,-0.451 0.527,-0.47 0.562,-0.484C0.596,-0.497 0.627,-0.504 0.654,-0.504C0.72,-0.504 0.767,-0.485 0.795,-0.446C0.822,-0.407 0.836,-0.36 0.836,-0.304L0.836,0L0.705,0L0.705,-0.298C0.705,-0.329 0.698,-0.352 0.683,-0.369C0.668,-0.385 0.647,-0.393 0.619,-0.393C0.6,-0.393 0.581,-0.388 0.56,-0.378C0.539,-0.368 0.521,-0.357 0.504,-0.344C0.505,-0.337 0.505,-0.331 0.506,-0.324C0.507,-0.317 0.507,-0.311 0.507,-0.304L0.507,0L0.376,0L0.376,-0.298C0.376,-0.329 0.369,-0.352 0.354,-0.369C0.339,-0.385 0.318,-0.393 0.291,-0.393C0.274,-0.393 0.258,-0.39 0.241,-0.383C0.224,-0.376 0.207,-0.367 0.192,-0.356L0.192,0L0.062,0L0.062,-0.485L0.13,-0.485L0.162,-0.441C0.184,-0.461 0.211,-0.476 0.242,-0.488C0.273,-0.499 0.3,-0.504 0.325,-0.504C0.363,-0.504 0.395,-0.497 0.42,-0.484C0.445,-0.47 0.465,-0.451 0.479,-0.428Z" style="fill:rgb(51,51,51);fill-rule:nonzero;"/>
+                </g>
+                <g transform="matrix(86.953,0,0,86.953,228.906,241.878)">
+                    <path d="M0.156,0.023L0.179,-0.034L0.006,-0.467L0.14,-0.485L0.252,-0.191L0.358,-0.485L0.495,-0.485L0.278,0.064C0.263,0.103 0.236,0.137 0.197,0.165C0.158,0.193 0.118,0.212 0.075,0.222L0.029,0.115C0.052,0.105 0.077,0.093 0.104,0.079C0.13,0.064 0.147,0.046 0.156,0.023Z" style="fill:rgb(51,51,51);fill-rule:nonzero;"/>
+                </g>
+            </g>
+            <g id="Selectors" transform="matrix(0.965977,0,0,0.807602,67.3796,67.3718)">
+                <g id="Right-selector" serif:id="Right selector">
+                    <g transform="matrix(1.03522,0,0,1.23823,2.07044,0)">
+                        <path d="M185.806,161.156L185.806,67.132" style="fill:none;stroke:rgb(76,159,255);stroke-width:4px;stroke-linecap:butt;"/>
+                    </g>
+                    <g transform="matrix(1.03522,0,0,1.23823,161.788,169.469)">
+                        <circle cx="31.523" cy="34.314" r="10.021" style="fill:rgb(76,159,255);stroke:rgb(76,159,255);stroke-width:4px;stroke-linecap:butt;"/>
+                    </g>
+                </g>
+                <g id="Left-selector" serif:id="Left selector">
+                    <g transform="matrix(1.03522,0,0,1.23823,-170.092,0)">
+                        <path d="M185.806,161.156L185.806,67.132" style="fill:none;stroke:rgb(76,159,255);stroke-width:4px;stroke-linecap:butt;"/>
+                    </g>
+                    <g transform="matrix(1.03522,0,0,1.23823,-10.3742,28.2274)">
+                        <circle cx="31.523" cy="34.314" r="10.021" style="fill:rgb(76,159,255);stroke:rgb(76,159,255);stroke-width:4px;stroke-linecap:butt;"/>
+                    </g>
+                </g>
+            </g>
+        </g>
+    </g>
+</svg>

docs/index.rst

@@ -0,0 +1,49 @@
+OCRmyPDF documentation
+======================
+
+.. figure:: images/logo.svg
+
+OCRmyPDF adds an optical character recognition (OCR) text layer to scanned PDF
+files, allowing them to be searched.
+
+PDF is the best format for storing and exchanging scanned documents.
+Unfortunately, PDFs can be difficult to modify. OCRmyPDF makes it easy to apply
+image processing and OCR to existing PDFs.
+
+.. toctree::
+   :maxdepth: 1
+
+   introduction
+   release_notes
+   installation
+   optimizer
+   languages
+   jbig2
+
+.. toctree::
+   :caption: Usage
+   :maxdepth: 2
+
+   cookbook
+   docker
+   advanced
+   batch
+   performance
+   pdfsecurity
+   errors
+
+.. toctree::
+   :caption: Developers
+   :maxdepth: 2
+
+   api
+   plugins
+   apiref
+   contributing
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/installation.rst

@@ -0,0 +1,826 @@
+===================
+Installing OCRmyPDF
+===================
+
+.. |latest| image:: https://img.shields.io/pypi/v/ocrmypdf.svg
+    :alt: OCRmyPDF latest released version on PyPI
+
+|latest|
+
+The easiest way to install OCRmyPDF is to follow the steps for your operating
+system/platform. This version may be out of date, however.
+
+These platforms have one-liner installs:
+
++-------------------------------+-------------------------------+
+| Debian, Ubuntu                | ``apt install ocrmypdf``      |
++-------------------------------+-------------------------------+
+| Windows Subsystem for Linux   | ``apt install ocrmypdf``      |
++-------------------------------+-------------------------------+
+| Fedora                        | ``dnf install ocrmypdf``      |
++-------------------------------+-------------------------------+
+| macOS                         | ``brew install ocrmypdf``     |
++-------------------------------+-------------------------------+
+| LinuxBrew                     | ``brew install ocrmypdf``     |
++-------------------------------+-------------------------------+
+| FreeBSD                       | ``pkg install py38-ocrmypdf`` |
++-------------------------------+-------------------------------+
+| Conda (WSL, macOS, Linux)     | ``conda install ocrmypdf``    |
++-------------------------------+-------------------------------+
+
+More detailed procedures are outlined below. If you want to do a manual
+install, or install a more recent version than your platform provides, read on.
+
+.. contents:: Platform-specific steps
+    :depth: 2
+    :local:
+
+Installing on Linux
+===================
+
+Debian and Ubuntu 18.04 or newer
+--------------------------------
+
+.. |deb-stable| image:: https://repology.org/badge/version-for-repo/debian_stable/ocrmypdf.svg
+    :alt: Debian 9 stable ("stretch")
+
+.. |deb-testing| image:: https://repology.org/badge/version-for-repo/debian_testing/ocrmypdf.svg
+    :alt: Debian 10 testing ("buster")
+
+.. |deb-unstable| image:: https://repology.org/badge/version-for-repo/debian_unstable/ocrmypdf.svg
+    :alt: Debian unstable
+
+.. |ubu-1804| image:: https://repology.org/badge/version-for-repo/ubuntu_18_04/ocrmypdf.svg
+    :alt: Ubuntu 18.04 LTS
+
+.. |ubu-2004| image:: https://repology.org/badge/version-for-repo/ubuntu_20_04/ocrmypdf.svg
+    :alt: Ubuntu 20.04 LTS
+
+.. |ubu-2110| image:: https://repology.org/badge/version-for-repo/ubuntu_21_10/ocrmypdf.svg
+    :alt: Ubuntu 21.10
+
++-----------------------------------------------+
+| **OCRmyPDF versions in Debian & Ubuntu**      |
++-----------------------------------------------+
+| |latest|                                      |
++-----------------------------------------------+
+| |deb-stable| |deb-testing| |deb-unstable|     |
++-----------------------------------------------+
+| |ubu-1804| |ubu-2004| |ubu-2110|              |
++-----------------------------------------------+
+
+Users of Debian 9 ("stretch") or later, or Ubuntu 18.04 or later, including users
+of Windows Subsystem for Linux, may simply
+
+.. code-block:: bash
+
+    apt-get install ocrmypdf
+
+As indicated in the table above, Debian and Ubuntu releases may lag
+behind the latest version. If the version available for your platform is
+out of date, you could opt to install the latest version from source.
+See `Installing HEAD revision from
+sources <#installing-head-revision-from-sources>`__. Ubuntu 16.10 to 17.10
+inclusive also had ocrmypdf, but these versions are end of life.
+
+For full details on version availability for your platform, check the
+`Debian Package Tracker <https://tracker.debian.org/pkg/ocrmypdf>`__ or
+`Ubuntu launchpad.net <https://launchpad.net/ocrmypdf>`__.
+
+.. note::
+
+   OCRmyPDF for Debian and Ubuntu currently omit the JBIG2 encoder.
+   OCRmyPDF works fine without it but will produce larger output files.
+   If you build jbig2enc from source, ocrmypdf 7.0.0 and later will
+   automatically detect it (specifically the ``jbig2`` binary) on the
+   ``PATH``. To add JBIG2 encoding, see :ref:`jbig2`.
+
+Fedora
+------
+
+.. |fedora-34| image:: https://repology.org/badge/version-for-repo/fedora_34/ocrmypdf.svg
+    :alt: Fedora 34
+
+.. |fedora-35| image:: https://repology.org/badge/version-for-repo/fedora_35/ocrmypdf.svg
+    :alt: Fedora 35
+
+.. |fedora-rawhide| image:: https://repology.org/badge/version-for-repo/fedora_rawhide/ocrmypdf.svg
+    :alt: Fedore Rawhide
+
++-----------------------------------------------+
+| **OCRmyPDF version**                          |
++-----------------------------------------------+
+| |latest|                                      |
++-----------------------------------------------+
+| |fedora-34| |fedora-35| |fedora-rawhide|      |
++-----------------------------------------------+
+
+Users of Fedora 29 or later may simply
+
+.. code-block:: bash
+
+    dnf install ocrmypdf
+
+For full details on version availability, check the `Fedora Package
+Tracker <https://apps.fedoraproject.org/packages/ocrmypdf>`__.
+
+If the version available for your platform is out of date, you could opt
+to install the latest version from source. See `Installing HEAD revision
+from sources <#installing-head-revision-from-sources>`__.
+
+.. note::
+
+   OCRmyPDF for Fedora currently omits the JBIG2 encoder due to patent
+   issues. OCRmyPDF works fine without it but will produce larger output
+   files. If you build jbig2enc from source, ocrmypdf 7.0.0 and later
+   will automatically detect it on the ``PATH``. To add JBIG2 encoding,
+   see `Installing the JBIG2 encoder <jbig2>`__.
+
+.. _ubuntu-lts-latest:
+
+Installing the latest version on Ubuntu 20.04 LTS
+-------------------------------------------------
+
+Ubuntu 20.04 includes ocrmypdf 9.6.0 - you can install that with ``apt``. To
+install a more recent version, uninstall the system-provided version of
+ocrmypdf, and install the following dependencies:
+
+.. code-block:: bash
+
+    sudo apt-get -y remove ocrmypdf  # remove system ocrmypdf, if installed
+    sudo apt-get -y update
+    sudo apt-get -y install \
+        ghostscript \
+        icc-profiles-free \
+        libxml2 \
+        pngquant \
+        python3-pip \
+        tesseract-ocr \
+        zlib1g
+
+To install ocrmypdf for the system:
+
+.. code-block:: bash
+
+    pip3 install ocrmypdf
+
+To install for the current user only:
+
+.. code-block:: bash
+
+    export PATH=$HOME/.local/bin:$PATH
+    pip3 install --user ocrmypdf
+
+Ubuntu 18.04 LTS
+----------------
+
+Ubuntu 18.04 includes ocrmypdf 6.1.2 - you can install that with ``apt``, but
+it is quite old now. To install a more recent version, uninstall the old version
+of ocrmypdf, and install the following dependencies:
+
+.. code-block:: bash
+
+    sudo apt-get -y remove ocrmypdf
+    sudo apt-get -y update
+    sudo apt-get -y install \
+        ghostscript \
+        icc-profiles-free \
+        libxml2 \
+        pngquant \
+        python3-distutils \
+        python3-pkg-resources \
+        python3-reportlab \
+        qpdf \
+        tesseract-ocr \
+        zlib1g \
+        unpaper
+
+We will need a newer version of ``pip`` then was available for Ubuntu 18.04:
+
+.. code-block:: bash
+
+    wget https://bootstrap.pypa.io/get-pip.py && python3 get-pip.py
+
+Then install the most recent ocrmypdf for the local user and set the
+user's ``PATH`` to check for the user's Python packages.
+
+.. code-block:: bash
+
+    export PATH=$HOME/.local/bin:$PATH
+    python3 -m pip install --user ocrmypdf
+
+To add JBIG2 encoding, see :ref:`jbig2`.
+
+Ubuntu 16.04 LTS
+----------------
+
+No package is available for Ubuntu 16.04. OCRmyPDF 8.0 and newer require
+Python 3.7. Ubuntu 16.04 ships Python 3.5, but you can install Python
+3.7 on it. Or, you can skip Python 3.7 and install OCRmyPDF 7.x or older
+- for that procedure, please see the installation documentation for the
+version of OCRmyPDF you plan to use.
+
+**Install system packages for OCRmyPDF**
+
+.. code-block:: bash
+
+    sudo apt-get update
+    sudo apt-get install -y software-properties-common python-software-properties
+    sudo add-apt-repository -y \
+        ppa:jonathonf/python-3.7 \
+        ppa:alex-p/tesseract-ocr
+    sudo apt-get update
+    sudo apt-get install -y \
+        ghostscript \
+        libexempi3 \
+        libffi6 \
+        pngquant \
+        python3.7 \
+        qpdf \
+        tesseract-ocr \
+        unpaper
+
+This will install a Python 3.7 binary at ``/usr/bin/python3.7``
+alongside the system's Python 3.5. Do not remove the system Python. This
+will also install Tesseract 4.0 from a PPA, since the version available
+in Ubuntu 16.04 is too old for OCRmyPDF.
+
+Now install pip for Python 3.7. This will install the Python 3.7 version
+of ``pip`` at ``/usr/local/bin/pip``.
+
+.. code-block:: bash
+
+    curl https://bootstrap.pypa.io/get-pip.py | sudo python3.7
+
+**Install OCRmyPDF**
+
+OCRmyPDF requires the locale to be set for UTF-8. **On some minimal
+Ubuntu installations**, such as the Ubuntu 16.04 Docker images it may be
+necessary to set the locale.
+
+.. code-block:: bash
+
+    # Optional: Only need to set these if they are not already set
+    export LC_ALL=C.UTF-8
+    export LANG=C.UTF-8
+
+Now install OCRmyPDF for the current user, and ensure that the ``PATH``
+environment variable contains ``$HOME/.local/bin``.
+
+.. code-block:: bash
+
+    export PATH=$HOME/.local/bin:$PATH
+    pip3.7 install --user ocrmypdf
+
+To add JBIG2 encoding, see :ref:`jbig2`.
+
+Arch Linux (AUR)
+----------------
+
+.. image:: https://repology.org/badge/version-for-repo/aur/ocrmypdf.svg
+    :alt: ArchLinux
+    :target: https://repology.org/metapackage/ocrmypdf
+
+There is an `Arch User Repository (AUR) package for OCRmyPDF
+<https://aur.archlinux.org/packages/ocrmypdf/>`__.
+
+Installing AUR packages as root is not allowed, so you must first `setup a
+non-root user
+<https://wiki.archlinux.org/index.php/Users_and_groups#User_management>`__ and
+`configure sudo <https://wiki.archlinux.org/index.php/Sudo#Configuration>`__.
+The standard Docker image, ``archlinux/base:latest``, does **not** have a
+non-root user configured, so users of that image must follow these guides. If
+you are using a VM image, such as `the official Vagrant image
+<https://app.vagrantup.com/archlinux/boxes/archlinux>`__, this work may already
+be completed for you.
+
+Next you should install the `base-devel package group
+<https://www.archlinux.org/groups/x86_64/base-devel/>`__. This includes the
+standard tooling needed to build packages, such as a compiler and binary tools.
+
+.. code-block:: bash
+
+   sudo pacman -S base-devel
+
+Now you are ready to install the OCRmyPDF package.
+
+.. code-block:: bash
+
+   curl -O https://aur.archlinux.org/cgit/aur.git/snapshot/ocrmypdf.tar.gz
+   tar xvzf ocrmypdf.tar.gz
+   cd ocrmypdf
+   makepkg -sri
+
+At this point you will have a working install of OCRmyPDF, but the Tesseract
+install won’t include any OCR language data. You can install `the
+tesseract-data package group
+<https://www.archlinux.org/groups/any/tesseract-data/>`__ to add all supported
+languages, or use that package listing to identify the appropriate package for
+your desired language.
+
+.. code-block:: bash
+
+   sudo pacman -S tesseract-data-eng
+
+As an alternative to this manual procedure, consider using an `AUR helper
+<https://wiki.archlinux.org/index.php/AUR_helpers>`__. Such a tool will
+automatically fetch, build and install the AUR package, resolve dependencies
+(including dependencies on AUR packages), and ease the upgrade procedure.
+
+If you have any difficulties with installation, check the repository package
+page.
+
+.. note::
+
+    The OCRmyPDF AUR package currently omits the JBIG2 encoder. OCRmyPDF works
+    fine without it but will produce larger output files. The encoder is
+    available from `the jbig2enc-git AUR package
+    <https://aur.archlinux.org/packages/jbig2enc-git/>`__ and may be installed
+    using the same series of steps as for the installation OCRmyPDF AUR
+    package. Alternatively, it may be built manually from source following the
+    instructions in `Installing the JBIG2 encoder <jbig2>`__.  If JBIG2 is
+    installed, OCRmyPDF 7.0.0 and later will automatically detect it.
+
+Alpine Linux
+------------
+
+.. image:: https://repology.org/badge/version-for-repo/alpine_edge/ocrmypdf.svg
+    :alt: Alpine Linux
+    :target: https://repology.org/metapackage/ocrmypdf
+
+To install OCRmyPDF for Alpine Linux:
+
+.. code-block:: bash
+
+    apk add ocrmypdf
+
+Mageia 7
+--------
+
+There is no OS-level packaging available for Mageia, so you must install the
+dependencies:
+
+.. code-block:: bash
+
+    # As root user
+    urpmi.update -a
+    urpmi \
+        ghostscript \
+        icc-profiles-openicc \
+        jbig2dec \
+        pngquant \
+        python3-pip \
+        python3-distutils-extra \
+        python3-pkg-resources \
+        python3-reportlab \
+        qpdf \
+        tesseract \
+        tesseract-osd \
+        tesseract-eng \
+        tesseract-fra
+
+To install ocrmypdf for the system:
+
+.. code-block:: bash
+
+    # As root user
+    pip3 install ocrmypdf
+    ldconfig
+
+Or, to install for the current user only:
+
+.. code-block:: bash
+
+    export PATH=$HOME/.local/bin:$PATH
+    pip3 install --user ocrmypdf
+
+Other Linux packages
+--------------------
+
+See the
+`Repology <https://repology.org/metapackage/ocrmypdf/versions>`__ page.
+
+In general, first install the OCRmyPDF package for your system, then
+optionally use the procedure `Installing with Python
+pip <#installing-with-python-pip>`__ to install a more recent version.
+
+Installing on macOS
+===================
+
+Homebrew
+--------
+
+.. image:: https://img.shields.io/homebrew/v/ocrmypdf.svg
+    :alt: homebrew
+    :target: http://brewformulas.org/Ocrmypdf
+
+OCRmyPDF is now a standard `Homebrew <https://brew.sh>`__ formula. To
+install on macOS:
+
+.. code-block:: bash
+
+    brew install ocrmypdf
+
+This will include only the English language pack. If you need other
+languages you can optionally install them all:
+
+.. code-block:: bash
+
+    brew install tesseract-lang  # Optional: Install all language packs
+
+.. note::
+
+   Users who previously installed OCRmyPDF on macOS using
+   ``pip install ocrmypdf`` should remove the pip version
+   (``pip3 uninstall ocrmypdf``) before switching to the Homebrew
+   version.
+
+.. note::
+
+   Users who previously installed OCRmyPDF from the private tap should
+   switch to the mainline version (``brew untap jbarlow83/ocrmypdf``)
+   and install from there.
+
+Manual installation on macOS
+----------------------------
+
+These instructions probably work on all macOS supported by Homebrew, and are
+for installing a more current version of OCRmyPDF than is available from
+Homebrew. Note that the Homebrew versions usually track the release versions
+fairly closely.
+
+If it's not already present, `install Homebrew <http://brew.sh/>`__.
+
+Update Homebrew:
+
+.. code-block:: bash
+
+    brew update
+
+Install or upgrade the required Homebrew packages, if any are missing.
+To do this, use ``brew edit ocrmypdf`` to obtain a recent list of Homebrew
+dependencies. You could also check the ``.workflows/build.yml``.
+
+This will include the English, French, German and Spanish language
+packs. If you need other languages you can optionally install them all:
+
+.. _macos-all-languages:
+
+   .. code-block:: bash
+
+    brew install tesseract-lang  # Option 2: for all language packs
+
+Update the homebrew pip:
+
+.. code-block:: bash
+
+    pip3 install --upgrade pip
+
+You can then install OCRmyPDF from PyPI, for the current user:
+
+.. code-block:: bash
+
+    pip3 install --user ocrmypdf
+
+or system-wide:
+
+.. code-block:: bash
+
+    pip3 install ocrmypdf
+
+The command line program should now be available:
+
+.. code-block:: bash
+
+    ocrmypdf --help
+
+Installing on Windows
+=====================
+
+Native Windows
+--------------
+
+.. note::
+
+    Administrator privileges will be required for some of these steps.
+
+You must install the following for Windows:
+
+* Python 3.7 (64-bit) or later
+* Tesseract 4.0 or later
+* Ghostscript 9.50 or later
+
+Using the `Chocolatey <https://chocolatey.org/>`_ package manager, install the
+following when running in an Administrator command prompt:
+
+* ``choco install python3``
+* ``choco install --pre tesseract``
+* ``choco install ghostscript``
+* ``choco install pngquant`` (optional)
+
+The commands above will install Python 3.x (latest version), Tesseract, Ghostscript
+and pngquant. Chocolatey may also need to install the Windows Visual C++ Runtime
+DLLs or other Windows patches, and may require a reboot.
+
+You may then use ``pip`` to install ocrmypdf. (This can performed by a user or
+Administrator.):
+
+* ``pip install ocrmypdf``
+
+Chocolatey automatically selects appropriate versions of these applications. If you
+are installing them manually, please install 64-bit versions of all applications for
+64-bit Windows, or 32-bit versions of all applications for 32-bit Windows. Mixing
+the "bitness" of these programs will lead to errors.
+
+OCRmyPDF will check the Windows Registry and standard locations in your Program Files
+for third party software it needs (specifically, Tesseract and Ghostscript). To
+override the versions OCRmyPDF selects, you can modify the ``PATH`` environment
+variable. `Follow these directions <https://www.computerhope.com/issues/ch000549.htm#dospath>`_
+to change the PATH.
+
+.. warning::
+
+    As of early 2021, users have reported problems with the Microsoft Store version of
+    Python and OCRmyPDF. These issues affect many other third party Python packages.
+    Please download Python from Python.org or Chocolatey instead, and do not use the
+    Microsoft Store version.
+
+Windows Subsystem for Linux
+---------------------------
+
+#. Install Ubuntu 20.04 for Windows Subsystem for Linux, if not already installed.
+#. Follow the procedure to install :ref:`OCRmyPDF on Ubuntu 20.04 <ubuntu-lts-latest>`.
+#. Open the Windows command prompt and create a symlink:
+
+.. code-block:: powershell
+
+    wsl sudo ln -s  /home/$USER/.local/bin/ocrmypdf /usr/local/bin/ocrmypdf
+
+Then confirm that the expected version from PyPI (|latest|) is installed:
+
+.. code-block:: powershell
+
+    wsl ocrmypdf --version
+
+You can then run OCRmyPDF in the Windows command prompt or Powershell, prefixing
+``wsl``, and call it from Windows programs or batch files.
+
+Cygwin64
+--------
+
+First install the the following prerequisite Cygwin packages using ``setup-x86_64.exe``::
+
+    python37 (or later)
+    python3?-devel
+    python3?-pip
+    python3?-lxml
+    python3?-imaging
+
+       (where 3? means match the version of python3 you installed)
+
+    gcc-g++
+    ghostscript (<=9.50 or >=9.52-2 see note below)
+    libexempi3
+    libexempi-devel
+    libffi6
+    libffi-devel
+    pngquant
+    qpdf
+    libqpdf-devel
+    tesseract-ocr
+    tesseract-ocr-devel
+
+.. note::
+
+    The Cygwin package for Ghostscript in versions 9.52 and
+    9.52-1 contained a bug that caused an exception to occur when
+    ocrmypdf invoked gs.  Make sure you have either 9.50 (or earlier)
+    or 9.52-2 (or later).
+
+Then open a Cygwin terminal (i.e. ``mintty``), run the following commands. Note
+that if you are using the version of ``pip`` that was installed with the Cygwin
+Python package, the command name will be ``pip3``.  If you have since updated
+``pip`` (with, for instance ``pip3 install --upgrade pip``) the the command is
+likely just ``pip`` instead of ``pip3``:
+
+.. code-block:: bash
+
+    pip3 install wheel
+    pip3 install ocrmypdf
+
+The optional dependency "unpaper" that is currently not available under Cygwin.
+Without it, certain options such as ``--clean`` will produce an error message.
+However, the OCR-to-text-layer functionality is available.
+
+Docker
+------
+
+You can also :ref:`Install the Docker <docker>` container on Windows. Ensure that
+your command prompt can run the docker "hello world" container.
+
+Installing on FreeBSD
+=====================
+
+.. image:: https://repology.org/badge/version-for-repo/freebsd/python:ocrmypdf.svg
+    :alt: FreeBSD
+    :target: https://repology.org/project/python:ocrmypdf/versions
+
+FreeBSD 11.3, 12.0, 12.1-RELEASE and 13.0-CURRENT are supported. Other
+versions likely work but have not been tested.
+
+.. code-block:: bash
+
+    pkg install py38-ocrmypdf
+
+To install a more recent version, you could attempt to first install the system
+version with ``pkg``, then use ``pip install --user ocrmypdf``.
+
+Installing the Docker image
+===========================
+
+For some users, installing the Docker image will be easier than
+installing all of OCRmyPDF's dependencies.
+
+See :ref:`docker` for more information.
+
+Installing with Python pip
+==========================
+
+OCRmyPDF is delivered by PyPI because it is a convenient way to install
+the latest version. However, PyPI and ``pip`` cannot address the fact
+that ``ocrmypdf`` depends on certain non-Python system libraries and
+programs being installed.
+
+.. warning::
+
+    Debian and Ubuntu users: unfortunately, Debian and Ubuntu customize
+    Python in non-standard ways, and the nature of these customizations
+    varies from release to release. This can make for a frustrating
+    user experience. The instructions below work on almost all platforms that
+    have Python installed, except for Debian and Ubuntu, where you may need
+    to take additional steps. For best results on Debian and Ubuntu, use the
+    ``apt`` packages; or if these are too old, run
+    ``apt install python3-pip python3-venv``, create a virtual environment,
+    and install OCRmyPDF in that environment.
+
+    `See here for more inforation on Debian-Python issues
+    <https://gist.github.com/tiran/2dec9e03c6f901814f6d1e8dad09528e>`__.
+
+For best results, first install `your platform's
+version <https://repology.org/metapackage/ocrmypdf/versions>`__ of
+``ocrmypdf``, using the instructions elsewhere in this document. Then
+you can use ``pip`` to get the latest version if your platform version
+is out of date. Chances are that this will satisfy most dependencies.
+
+Use ``ocrmypdf --version`` to confirm what version was installed.
+
+Then you can install the latest OCRmyPDF from the Python wheels. First
+try:
+
+.. code-block:: bash
+
+    pip3 install --user ocrmypdf
+
+You should then be able to run ``ocrmypdf --version`` and see that the
+latest version was located.
+
+Since ``pip3 install --user`` does not work correctly on some platforms,
+notably Ubuntu 16.04 and older, and the Homebrew version of Python,
+instead use this for a system wide installation:
+
+.. code-block:: bash
+
+    pip3 install ocrmypdf
+
+.. note::
+
+    AArch64 (ARM64) users: this process will be difficult because most
+    Python packages are not available as binary wheels for your platform.
+    You're probably better off using a platform install on Debian, Ubuntu,
+    or Fedora.
+
+Requirements for pip and HEAD install
+-------------------------------------
+
+OCRmyPDF currently requires these external programs and libraries to be
+installed, and must be satisfied using the operating system package
+manager. ``pip`` cannot provide them.
+
+-  Python 3.7 or newer
+-  Ghostscript 9.15 or newer
+-  Tesseract 4.0.0-beta or newer
+
+As of ocrmypdf 7.2.1, the following versions are recommended:
+
+-  Python 3.9 or newer
+-  Ghostscript 9.23 or newer
+-  Tesseract 4.0.0 or newer
+-  jbig2enc 0.29 or newer
+-  pngquant 2.5 or newer
+-  unpaper 6.1
+
+jbig2enc, pngquant, and unpaper are optional. If missing certain
+features are disabled. OCRmyPDF will discover them as soon as they are
+available.
+
+**jbig2enc**, if present, will be used to optimize the encoding of
+monochrome images. This can significantly reduce the file size of the
+output file. It is not required.
+`jbig2enc <https://github.com/agl/jbig2enc>`__ is not generally
+available for Ubuntu or Debian due to lingering concerns about patent
+issues, but can easily be built from source. To add JBIG2 encoding, see
+:ref:`jbig2`.
+
+**pngquant**, if present, is optionally used to optimize the encoding of
+PNG-style images in PDFs (actually, any that are that losslessly
+encoded) by lossily quantizing to a smaller color palette. It is only
+activated then the ``--optimize`` argument is ``2`` or ``3``.
+
+**unpaper**, if present, enables the ``--clean`` and ``--clean-final``
+command line options.
+
+These are in addition to the Python packaging dependencies, meaning that
+unfortunately, the ``pip install`` command cannot satisfy all of them.
+
+Installing HEAD revision from sources
+=====================================
+
+If you have ``git`` and Python 3.7 or newer installed, you can install
+from source. When the ``pip`` installer runs, it will alert you if
+dependencies are missing.
+
+If you prefer to build every from source, you will need to `build
+pikepdf from
+source <https://pikepdf.readthedocs.io/en/latest/installation.html#building-from-source>`__.
+First ensure you can build and install pikepdf.
+
+To install the HEAD revision from sources in the current Python 3
+environment:
+
+.. code-block:: bash
+
+    pip3 install git+https://github.com/jbarlow83/OCRmyPDF.git
+
+Or, to install in `development
+mode <https://pythonhosted.org/setuptools/setuptools.html#development-mode>`__,
+allowing customization of OCRmyPDF, use the ``-e`` flag:
+
+.. code-block:: bash
+
+    pip3 install -e git+https://github.com/jbarlow83/OCRmyPDF.git
+
+You may find it easiest to install in a virtual environment, rather than
+system-wide:
+
+.. code-block:: bash
+
+    git clone -b master https://github.com/jbarlow83/OCRmyPDF.git
+    python3 -m venv
+    source venv/bin/activate
+    cd OCRmyPDF
+    pip3 install .
+
+However, ``ocrmypdf`` will only be accessible on the system PATH when
+you activate the virtual environment.
+
+To run the program:
+
+.. code-block:: bash
+
+    ocrmypdf --help
+
+If not yet installed, the script will notify you about dependencies that
+need to be installed. The script requires specific versions of the
+dependencies. Older version than the ones mentioned in the release notes
+are likely not to be compatible to OCRmyPDF.
+
+For development
+---------------
+
+To install all of the development and test requirements:
+
+.. code-block:: bash
+
+    git clone -b master https://github.com/jbarlow83/OCRmyPDF.git
+    python3 -m venv
+    source venv/bin/activate
+    cd OCRmyPDF
+    pip install -e .[test]
+
+To add JBIG2 encoding, see :ref:`jbig2`.
+
+Shell completions
+=================
+
+Completions for ``bash`` and ``fish`` are available in the project's
+``misc/completion`` folder. The ``bash`` completions are likely ``zsh``
+compatible but this has not been confirmed. Package maintainers, please
+install these at the appropriate locations for your system.
+
+To manually install the ``bash`` completion, copy
+``misc/completion/ocrmypdf.bash`` to ``/etc/bash_completion.d/ocrmypdf``
+(rename the file).
+
+To manually install the ``fish`` completion, copy
+``misc/completion/ocrmypdf.fish`` to
+``~/.config/fish/completions/ocrmypdf.fish``.

docs/introduction.rst

@@ -0,0 +1,239 @@
+============
+Introduction
+============
+
+OCRmyPDF is an application and library that adds text "layers" to images
+in PDFs, making scanned image PDFs searchable. It uses OCR to guess what text
+is contained in images. It is written in Python. OCRmyPDF supports plugins
+that allow customization of its processing steps, and is very tolerant of
+PDFs that contain scanned images and "born digital" content that needs no
+text recognition.
+
+About OCR
+=========
+
+`Optical character
+recognition <https://en.wikipedia.org/wiki/Optical_character_recognition>`__
+is technology that converts images of typed or handwritten text, such as
+in a scanned document, to computer text that can be selected, searched and copied.
+
+OCRmyPDF uses
+`Tesseract <https://github.com/tesseract-ocr/tesseract>`__, the best
+available open source OCR engine, to perform OCR.
+
+.. _raster-vector:
+
+About PDFs
+==========
+
+PDFs are page description files that attempts to preserve a layout
+exactly. They contain `vector
+graphics <http://vector-conversions.com/vectorizing/raster_vs_vector.html>`__
+that can contain raster objects such as scanned images. Because PDFs can
+contain multiple pages (unlike many image formats) and can contain fonts
+and text, it is a good format for exchanging scanned documents.
+
+|image|
+
+A PDF page might contain multiple images, even if it only appears to
+have one image. Some scanners or scanning software will segment pages
+into monochromatic text and color regions for example, to improve the
+compression ratio and appearance of the page.
+
+Rasterizing a PDF is the process of generating corresponding raster images.
+OCR engines like Tesseract work with images, not scalable vector graphics
+or mixed raster-vector-text graphics such as PDF.
+
+About PDF/A
+===========
+
+`PDF/A <https://en.wikipedia.org/wiki/PDF/A>`__ is an ISO-standardized
+subset of the full PDF specification that is designed for archiving (the
+'A' stands for Archive). PDF/A differs from PDF primarily by omitting
+features that would make it difficult to read the file in the future,
+such as embedded Javascript, video, audio and references to external
+fonts. All fonts and resources needed to interpret the PDF must be
+contained within it. Because PDF/A disables Javascript and other types
+of embedded content, it is probably more secure.
+
+There are various conformance levels and versions, such as "PDF/A-2b".
+
+Generally speaking, the best format for scanned documents is PDF/A. Some
+governments and jurisdictions, US Courts in particular, `mandate the use
+of PDF/A <https://pdfblog.com/2012/02/13/what-is-pdfa/>`__ for scanned
+documents.
+
+Since most people who scan documents are interested in reading them
+indefinitely into the future, OCRmyPDF generates PDF/A-2b by default.
+
+PDF/A has a few drawbacks. Some PDF viewers include an alert that the
+file is a PDF/A, which may confuse some users. It also tends to produce
+larger files than PDF, because it embeds certain resources even if they
+are commonly available. PDF/A files can be digitally signed, but may not
+be encrypted, to ensure they can be read in the future. Fortunately,
+converting from PDF/A to a regular PDF is trivial, and any PDF viewer
+can view PDF/A.
+
+What OCRmyPDF does
+==================
+
+OCRmyPDF analyzes each page of a PDF to determine the colorspace and
+resolution (DPI) needed to capture all of the information on that page
+without losing content. It uses
+`Ghostscript <http://ghostscript.com/>`__ to rasterize the page, and
+then performs on OCR the rasterized image to create an OCR "layer".
+The layer is then grafted back onto the original PDF.
+
+While one can use a program like Ghostscript or ImageMagick to get an
+image and put the image through Tesseract, that actually creates a new
+PDF and many details may be lost. OCRmyPDF can produce a minimally
+changed PDF as output.
+
+OCRmyPDF also provides some image processing options, like deskew, which
+improves the appearance of files and quality of OCR. When these are used,
+the OCR layer is grafted onto the processed image instead.
+
+By default, OCRmyPDF produces archival PDFs – PDF/A, which are a
+stricter subset of PDF features designed for long term archives. If
+regular PDFs are desired, this can be disabled with
+``--output-type pdf``.
+
+Why you shouldn't do this manually
+==================================
+
+A PDF is similar to an HTML file, in that it contains document structure
+along with images. Sometimes a PDF does nothing more than present a full
+page image, but often there is additional content that would be lost.
+
+A manual process could work like either of these:
+
+1. Rasterize each page as an image, OCR the images, and combine the
+   output into a PDF. This preserves the layout of each page, but
+   resamples all images (possibly losing quality, increasing file size,
+   introducing compression artifacts, etc.).
+2. Extract each image, OCR, and combine the output into a PDF. This
+   loses the context in which images are used in the PDF, meaning that
+   cropping, rotation and scaling of pages may be lost. Some scanned
+   PDFs use multiple images segmented into black and white, grayscale
+   and color regions, with stencil masks to prevent overlap, as this can
+   enhance the appearance of a file while reducing file size. Clearly,
+   reassembling these images will be easy. This also loses and text or
+   vector art on any pages in a PDF with both scanned and pure digital
+   content.
+
+In the case of a PDF that is nothing other than a container of images
+(no rotation, scaling, cropping, one image per page), the second
+approach can be lossless.
+
+OCRmyPDF uses several strategies depending on input options and the
+input PDF itself, but generally speaking it rasterizes a page for OCR
+and then grafts the OCR back onto the original. As such it can handle
+complex PDFs and still preserve their contents as much as possible.
+
+OCRmyPDF also supports a many, many edge cases that have cropped over
+several years of development. We support PDF features like images inside
+of Form XObjects, and pages with UserUnit scaling. We support rare image
+formats like non-monochrome 1-bit images. We warn about files you may
+not to OCR. Thanks to pikepdf and QPDF, we auto-repair PDFs that are
+damaged. (Not that you need to know what any of these are! You should be
+able to throw any PDF at it.)
+
+Limitations
+===========
+
+OCRmyPDF is limited by the Tesseract OCR engine. As such it experiences
+these limitations, as do any other programs that rely on Tesseract:
+
+-  The OCR is not as accurate as commercial OCR solutions.
+-  It is not capable of recognizing handwriting.
+-  It may find gibberish and report this as OCR output.
+-  If a document contains languages outside of those given in the
+   ``-l LANG`` arguments, results may be poor.
+-  It is not always good at analyzing the natural reading order of
+   documents. For example, it may fail to recognize that a document
+   contains two columns, and may try to join text across columns.
+-  Poor quality scans may produce poor quality OCR. Garbage in, garbage
+   out.
+-  It does not expose information about what font family text belongs
+   to.
+
+OCRmyPDF is also limited by the PDF specification:
+
+-  PDF encodes the position of text glyphs but does not encode document
+   structure. There is no markup that divides a document in sections,
+   paragraphs, sentences, or even words (since blank spaces are not
+   represented). As such all elements of document structure including
+   the spaces between words must be derived heuristically. Some PDF
+   viewers do a better job of this than others.
+-  Because some popular open source PDF viewers have a particularly hard
+   time with spaces between words, OCRmyPDF appends a space to each text
+   element as a workaround (when using ``--pdf-renderer hocr``). While
+   this mixes document structure with graphical information that ideally
+   should be left to the PDF viewer to interpret, it improves
+   compatibility with some viewers and does not cause problems for
+   better ones.
+
+Ghostscript also imposes some limitations:
+
+-  PDFs containing JBIG2-encoded content will be converted to CCITT
+   Group4 encoding, which has lower compression ratios, if Ghostscript
+   PDF/A is enabled.
+-  PDFs containing JPEG 2000-encoded content will be converted to JPEG
+   encoding, which may introduce compression artifacts, if Ghostscript
+   PDF/A is enabled.
+-  Ghostscript may transcode grayscale and color images, either lossy to
+   lossless or lossless to lossy, based on an internal algorithm. This
+   behavior can be suppressed by setting ``--pdfa-image-compression`` to
+   ``jpeg`` or ``lossless`` to set all images to one type or the other.
+   Ghostscript has no option to maintain the input image's format.
+   (Ghostscript 9.25+ can copy JPEG images without transcoding them;
+   earlier versions will transcode.)
+-  Ghostscript's PDF/A conversion removes any XMP metadata that is not
+   one of the standard XMP metadata namespaces for PDFs. In particular,
+   PRISM Metdata is removed.
+-  Ghostscript's PDF/A conversion seems to remove or deactivate
+   hyperlinks and other active content.
+
+You can use ``--output-type pdf`` to disable PDF/A conversion and produce
+a standard, non-archival PDF.
+
+Regarding OCRmyPDF itself:
+
+-  PDFs that use transparency are not currently represented in the test
+   suite
+
+Similar programs
+================
+
+To the author's knowledge, OCRmyPDF is the most feature-rich and
+thoroughly tested command line OCR PDF conversion tool. If it does not
+meet your needs, contributions and suggestions are welcome. If not,
+consider one of these similar open source programs:
+
+-  pdf2pdfocr
+-  pdfsandwich
+
+Ghostscript recently added three "pdfocr" output devices. They work by
+rasterizing all content and converting all pages to a single colour space.
+
+Web front-ends
+==============
+
+The Docker image ``ocrmypdf`` provides a web service front-end
+that allows files to submitted over HTTP and the results "downloaded".
+This is an HTTP server intended to simplify web services deployments; it
+is not intended to be deployed on the public internet and no real
+security measures to speak of.
+
+In addition, the following third-party integrations are available:
+
+-  `Nextcloud OCR <https://github.com/janis91/ocr>`__ is a free software
+   plugin for the Nextcloud private cloud software
+
+OCRmyPDF is not designed to be secure against malware-bearing PDFs (see
+`Using OCRmyPDF online <ocr-service>`__). Users should ensure they
+comply with OCRmyPDF's licenses and the licenses of all dependencies. In
+particular, OCRmyPDF requires Ghostscript, which is licensed under
+AGPLv3.
+
+.. |image| image:: images/bitmap_vs_svg.svg

docs/jbig2.rst

@@ -0,0 +1,55 @@
+.. _jbig2:
+
+============================
+Installing the JBIG2 encoder
+============================
+
+Most Linux distributions do not include a JBIG2 encoder since JBIG2
+encoding was patented for a long time. All known JBIG2 US patents have
+expired as of 2017, but it is possible that unknown patents exist.
+
+JBIG2 encoding is recommended for OCRmyPDF and is used to losslessly
+create smaller PDFs. If JBIG2 encoding is not available, lower quality
+encodings will be used.
+
+JBIG2 decoding is not patented and is performed automatically by most
+PDF viewers. It is widely supported and has been part of the PDF
+specification since 2001.
+
+On macOS, Homebrew packages jbig2enc and OCRmyPDF includes it by
+default. The Docker image for OCRmyPDF also builds its own JBIG2 encoder
+from source.
+
+For all other Linux, you must build a JBIG2 encoder from source:
+
+.. code-block:: bash
+
+   git clone https://github.com/agl/jbig2enc
+   cd jbig2enc
+   ./autogen.sh
+   ./configure && make
+   [sudo] make install
+
+.. _jbig2-lossy:
+
+Lossy mode JBIG2
+================
+
+OCRmyPDF provides lossy mode JBIG2 as an advanced feature. Users should
+`review the technical concerns with JBIG2 in lossy
+mode <https://en.wikipedia.org/wiki/JBIG2#Disadvantages>`__
+and decide if this feature is acceptable for their use case.
+
+JBIG2 lossy mode does achieve higher compression ratios than any other
+monochrome (bitonal) compression technology; for large text documents
+the savings are considerable. JBIG2 lossless still gives great
+compression ratios and is a major improvement over the older CCITT G4
+standard. As explained above, there is some risk of substitution errors.
+
+To turn on JBIG2 lossy mode, add the argument ``--jbig2-lossy``.
+``--optimize {1,2,3}`` are necessary for the argument to take effect
+also required. Also, a JBIG2 encoder must be installed as described in
+the previous section.
+
+*Due to an oversight, ocrmypdf v7.0 and v7.1 used lossy mode by
+default.*

docs/languages.rst

@@ -0,0 +1,76 @@
+.. _lang-packs:
+
+====================================
+Installing additional language packs
+====================================
+
+OCRmyPDF uses Tesseract for OCR, and relies on its language packs for all languages.
+On most platforms, English is installed with Tesseract by default, but not always.
+
+Tesseract supports `most
+languages <https://github.com/tesseract-ocr/tesseract/blob/master/doc/tesseract.1.asc#languages>`__.
+Languages are identified by standardized three-letter codes (called ISO 639-2 Alpha-3).
+Tesseract's documentation also lists the three-letter code for your language.
+Some are anglicized, e.g. Spanish is ``spa`` rather than ``esp``, while others
+are not, e.g. German is ``deu`` and French is ``fra``.
+
+After you have installed a language pack, you can use it with ``ocrmypdf -l <language>``,
+for example ``ocrmypdf -l spa``. For multilingual documents, you can specify
+all languages to be expected, e.g. ``ocrmypdf -l eng+fra`` for English and French.
+English is assumed by default unless other language(s) are specified.
+
+For Linux users, you can often find packages that provide language
+packs:
+
+Debian and Ubuntu users
+=======================
+
+.. code-block:: bash
+
+   # Display a list of all Tesseract language packs
+   apt-cache search tesseract-ocr
+
+   # Install Chinese Simplified language pack
+   apt-get install tesseract-ocr-chi-sim
+
+You can then pass the ``-l LANG`` argument to OCRmyPDF to give a hint as
+to what languages it should search for. Multiple languages can be
+requested using either ``-l eng+fra`` (English and French) or
+``-l eng -l fra``.
+
+Fedora users
+============
+
+.. code-block:: bash
+
+   # Display a list of all Tesseract language packs
+   dnf search tesseract
+
+   # Install Chinese Simplified language pack
+   dnf install tesseract-langpack-chi_sim
+
+You can then pass the ``-l LANG`` argument to OCRmyPDF to give a hint as
+to what languages it should search for. Multiple languages can be
+requested using either ``-l eng+fra`` (English and French) or
+``-l eng -l fra``.
+
+macOS users
+===========
+
+You can install additional language packs by
+:ref:`installing Tesseract using Homebrew with all language packs <macos-all-languages>`.
+
+Docker users
+============
+
+Users of the OCRmyPDF Docker image should install language packs into a
+derived Docker image as
+:ref:`described in that section <docker-lang-packs>`.
+
+Windows users
+=============
+
+The Tesseract installer provided by Chocolatey currently includes only English language. 
+To install other languages, download the respective language pack (``.traineddata`` file) 
+from https://github.com/tesseract-ocr/tessdata/ and place it in 
+``C:\\Program Files\\Tesseract-OCR\\tessdata`` (or wherever Tesseract OCR is installed).

docs/optimizer.rst

@@ -0,0 +1,75 @@
+================
+PDF optimization
+================
+
+OCRmyPDF includes an image-oriented PDF optimizer. By default, the optimizer
+runs with safe settings with the goal of improving compression at no loss of
+quality. At higher optimization levels, lossy optimizations may be applied and
+tuned. Optimization occurs after OCR, and only if OCR succeeded.  It does not
+perform other possible optimizations such as deduplicating resources,
+consolidating fonts, simplifying vector drawings, or anything of that nature.
+
+Optimization ranges from ``-O0`` through ``-O3``, where ``0`` disables
+optimization and ``3`` implements all options. ``1``, the default, performs only
+safe and lossless optimizations. (This is similar to GCC's optimization
+parameter.) The exact type of optimizations performed will vary over time.
+
+PDF optimization requires third-party, optional tools for certain optimizations.
+If these are not installed or cannot be found by OCRmyPDF, optimization will not
+be as good.
+
+Optimizations that always occurs
+================================
+
+OCRmyPDF will automatically replace obsolete or inferior compression schemes
+such as RLE or LZW with superior schemes such as Deflate and converting
+monochrome images to CCITT G4. Since this is harmless it always occurs and there
+is no way to disable it. Other non-image compressed objects are compressed as
+well.
+
+Fast web view
+=============
+
+OCRmyPDF automatically optimizes PDFs for "fast web view" in Adobe Acrobat's
+parlance, or equivalently, linearizes PDFs so that the resources they reference
+are presented in the order a viewer needs them for sequential display. This
+reduces the latency of viewing a PDF both online and from local storage. This
+actually slightly increases the file size.
+
+To disable this optimization and all others, use ``ocrmypdf --optimize 0 ...``
+or the shorthand ``-O0``.
+
+Lossless optimizations
+======================
+
+At optimization level ``-O1`` (the default), OCRmyPDF will also attempt lossless
+image optimization.
+
+If a JBIG2 encoder is available, then monochrome images will be converted to
+JBIG2, with the potential for huge savings on large black and white images,
+since JBIG2 is far more efficient than any other monochrome (bi-level)
+compression. (All known US patents related to JBIG2 have probably expired, but
+it remains the responsibility of the user to supply a JBIG2 encoder such as
+`jbig2enc <https://github.com/agl/jbig2enc>`__. OCRmyPDF does not implement
+JBIG2 encoding on its own.)
+
+OCRmyPDF currently does not attempt to recompress losslessly compressed objects
+more aggressively.
+
+Lossy optimizations
+===================
+
+At optimization level ``-O2`` and ``-O3``, OCRmyPDF will some attempt lossy
+image optimization.
+
+If ``pngquant`` is installed, OCRmyPDF will use it to perform quantize paletted
+images to reduce their size.
+
+The quality of JPEGs may be lowered, on the assumption that a lower quality
+image may be suitable for storage after OCR.
+
+It is not possible to optimize all image types. Uncommon image types may be
+skipped by the optimizer.
+
+OCRmyPDF provides :ref:`lossy mode JBIG2 <jbig2-lossy>` as an advanced feature
+that additional requires the argument ``--jbig2-lossy``.

docs/pdfsecurity.rst

@@ -0,0 +1,162 @@
+===================
+PDF security issues
+===================
+
+   OCRmyPDF should only be used on PDFs you trust. It is not designed to
+   protect you against malware.
+
+Recognizing that many users have an interest in handling PDFs and
+applying OCR to PDFs they did not generate themselves, this article
+discusses the security implications of PDFs and how users can protect
+themselves.
+
+The disclaimer applies: this software has no warranties of any kind.
+
+PDFs may contain malware
+========================
+
+PDF is a rich, complex file format. The official PDF 1.7 specification,
+ISO 32000:2008, is hundreds of pages long and references several annexes
+each of which are similar in length. PDFs can contain video, audio, XML,
+JavaScript and other programming, and forms. In some cases, they can
+open internet connections to pre-selected URLs. All of these are possible
+attack vectors.
+
+In short, PDFs `may contain
+viruses <https://security.stackexchange.com/questions/64052/can-a-pdf-file-contain-a-virus>`__.
+
+This
+`article <https://theinvisiblethings.blogspot.ca/2013/02/converting-untrusted-pdfs-into-trusted.html>`__
+describes a high-paranoia method which allows potentially hostile PDFs
+to be viewed and rasterized safely in a disposable virtual machine. A
+trusted PDF created in this manner is converted to images and loses all
+information making it searchable and losing all compression. OCRmyPDF
+could be used to restore searchability.
+
+How OCRmyPDF processes PDFs
+===========================
+
+OCRmyPDF must open and interpret your PDF in order to insert an OCR
+layer. First, it runs all PDFs through
+`pikepdf <https://github.com/pikepdf/pikepdf>`__, a library based on
+`qpdf <https://github.com/qpdf/qpdf>`__, a program that repairs PDFs
+with syntax errors. This is done because, in the author's experience, a
+significant number of PDFs in the wild, especially those created by
+scanners, are not well-formed files. qpdf makes it more likely that
+OCRmyPDF will succeed, but offers no security guarantees. qpdf is also
+used to split the PDF into single page PDFs.
+
+Finally, OCRmyPDF rasterizes each page of the PDF using
+`Ghostscript <http://ghostscript.com/>`__ in ``-dSAFER`` mode.
+
+Depending on the options specified, OCRmyPDF may graft the OCR layer
+into the existing PDF or it may essentially reconstruct ("re-fry") a
+visually identical PDF that may be quite different at the binary level.
+That said, OCRmyPDF is not a tool designed for sanitizing PDFs.
+
+.. _ocr-service:
+
+Using OCRmyPDF online or as a service
+=====================================
+
+OCRmyPDF is not designed for use as a public web service where a
+malicious user could upload a chosen PDF. In particular, it is not
+necessarily secure against PDF malware or PDFs that cause denial of
+service. OCRmyPDF relies on Ghostscript, and therefore, if deployed
+online one should be prepared to comply with Ghostscript's Affero GPL
+license, and any other licenses.
+
+Setting aside these concerns, a side effect of OCRmyPDF is that it may
+incidentally sanitize PDFs containing certain types of malware. It
+repairs the PDF with pikepdf/libqpdf, which could correct malformed PDF
+structures that are part of an attack. When PDF/A output is selected
+(the default), the input PDF is partially reconstructed by Ghostscript.
+When ``--force-ocr`` is used, all pages are rasterized and reconverted
+to PDF, which could remove malware in embedded images.
+
+OCRmyPDF should be relatively safe to use in a trusted intranet, with
+some considerations:
+
+Limiting CPU usage
+------------------
+
+OCRmyPDF will attempt to use all available CPUs and storage, so
+executing ``nice ocrmypdf`` or limiting the number of jobs with the
+``-j`` argument may ensure the server remains available. Another option
+would be to run OCRmyPDF jobs inside a Docker container, a virtual machine,
+or a cloud instance, which can impose its own limits on CPU usage and be
+terminated "from orbit" if it fails to complete.
+
+Temporary storage requirements
+------------------------------
+
+OCRmyPDF will use a large amount of temporary storage for its work,
+proportional to the total number of pixels needed to rasterize the PDF.
+The raster image of a 8.5×11" color page at 300 DPI takes 25 MB
+uncompressed; OCRmyPDF saves its intermediates as PNG, but that still
+means it requires about 9 MB per intermediate based on average
+compression ratios. Multiple intermediates per page are also required,
+depending on the command line given. A rule of thumb would be to allow
+100 MB of temporary storage per page in a file – meaning that a small
+cloud servers or small VM partitions should be provisioned with plenty
+of extra space, if say, a 500 page file might be sent.
+
+To check temporary storage usage on actual files, run
+``ocrmypdf -k ...`` which will preserve and print the path to temporary
+storage when the job is done.
+
+To change where temporary files are stored, change the ``TMPDIR``
+environment variable for ocrmypdf's environment. (Python's
+``tempfile.gettempdir()`` returns the root directory in which temporary
+files will be stored.) For example, one could redirect ``TMPDIR`` to a
+large RAM disk to avoid wear on HDD/SSD and potentially improve
+performance. On Amazon Web Services, ``TMPDIR`` can be set to `empheral
+storage <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html>`__.
+
+Timeouts
+--------
+
+To prevent excessively long OCR jobs consider setting
+``--tesseract-timeout`` and/or ``--skip-big`` arguments. ``--skip-big``
+is particularly helpful if your PDFs include documents such as reports
+on standard page sizes with large images attached - often large images
+are not worth OCR'ing anyway.
+
+Commercial alternatives
+-----------------------
+
+The author also provides professional services that include OCR and
+building databases around PDFs, and is happy to provide consultation.
+
+Abbyy Cloud OCR is viable commercial alternative with a web services
+API. Amazon Textract, Google Cloud Vision, and Microsoft Azure 
+Computer Vision provide advanced OCR but have less PDF rendering capability.
+
+Password protection, digital signatures and certification
+=========================================================
+
+Password protected PDFs usually have two passwords, and owner and user
+password. When the user password is set to empty, PDF readers will open
+the file automatically and marked it as "(SECURED)". While not as
+reliable as a digital signature, this indicates that whoever set the
+password approved of the file at that time. When the user password is
+set, the document cannot be viewed without the password.
+
+Either way, OCRmyPDF does not remove passwords from PDFs and exits with
+an error on encountering them.
+
+``qpdf`` can remove passwords. If the owner and user password are set, a
+password is required for ``qpdf``. If only the owner password is set, then the
+password can be stripped, even if one does not have the owner password.
+
+After OCR is applied, password protection is not permitted on PDF/A
+documents but the file can be converted to regular PDF.
+
+Many programs exist which are capable of inserting an image of someone's
+signature. On its own, this offers no security guarantees. It is trivial
+to remove the signature image and apply it to other files. This practice
+offers no real security.
+
+Important documents can be digitally signed and certified to attest to
+their authorship. OCRmyPDF cannot do this. Open source tools such as
+pdfbox (Java) have this capability as does Adobe Acrobat.

docs/performance.rst

@@ -0,0 +1,22 @@
+===========
+Performance
+===========
+
+Some users have noticed that current versions of OCRmyPDF do not run as quickly
+as some older versions (specifically 6.x and older). This is because OCRmyPDF
+added image optimization as a postprocessing step, and it is enabled by default.
+
+Speed
+=====
+
+If running OCRmyPDF quickly is your main goal, you can use settings such as:
+
+* ``--optimize 0`` to disable file size optimization
+* ``--output-type pdf`` to disable PDF/A generation
+* ``--fast-web-view 0`` to disable fast web view optimization
+* ``--skip-big`` to skip large images, if some pages have large images
+
+You can also avoid:
+
+* ``--force-ocr``
+* Image preprocessing

docs/plugins.rst

@@ -0,0 +1,208 @@
+=======
+Plugins
+=======
+
+    The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL
+    NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED",  "MAY", and
+    "OPTIONAL" in this document are to be interpreted as described in
+    RFC 2119.
+
+You can use plugins to customize the behavior of OCRmyPDF at certain points of
+interest.
+
+Currently, it is possible to:
+
+- add new command line arguments
+- override the decision for whether or not to perform OCR on a particular file
+- modify the image is about to be sent for OCR
+- modify the page image before it is converted to PDF
+- replace the Tesseract OCR with another OCR engine that has similar behavior
+- replace Ghostscript with another PDF to image converter (rasterizer) or
+  PDF/A generator
+
+OCRmyPDF plugins are based on the Python ``pluggy`` package and conform to its
+conventions. Note that: plugins installed with as setuptools entrypoints are
+not checked currently, because OCRmyPDF assumes you may not want to enable
+plugins for all files.
+
+Script plugins
+==============
+
+Script plugins may be called from the command line, by specifying the name of a file.
+Script plugins may be convenient for informal or "one-off" plugins, when a certain
+batch of files needs a special processing step for example.
+
+.. code-block:: bash
+
+    ocrmypdf --plugin ocrmypdf_example_plugin.py input.pdf output.pdf
+
+Multiple plugins may be installed by issuing the ``--plugin`` argument multiple times.
+
+Packaged plugins
+================
+
+Installed plugins may be installed into the same virtual environment as OCRmyPDF
+is installed into. They may be invoked using Python standard module naming.
+If you are intending to distribute a plugin, please package it.
+
+.. code-block:: bash
+
+    ocrmypdf --plugin ocrmypdf_fancypants.pockets.contents input.pdf output.pdf
+
+OCRmyPDF does not automatically import plugins, because the assumption is that
+plugins affect different files differently and you may not want them activated
+all the time. The command line or ``ocrmypdf.ocr(plugin='...')`` must call
+for them.
+
+Third parties that wish to distribute packages for ocrmypdf should package them
+as packaged plugins, and these modules should begin with the name ``ocrmypdf_``
+similar to ``pytest`` packages such as ``pytest-cov`` (the package) and
+``pytest_cov`` (the module).
+
+.. note::
+
+    We recommend plugin authors name their plugins with the prefix
+    ``ocrmypdf-`` (for the package name on PyPI) and ``ocrmypdf_`` (for the
+    module), just like pytest plugins. At the same time, please make it clear
+    that your package is not official.
+
+Setuptools plugins
+==================
+
+You can also create a plugin that OCRmyPDF will always automatically load if both are
+installed in the same virtual environment, using a setuptools entrypoint.
+
+Your package's ``setup.py`` would need to contain the following, for a plugin
+named ``ocrmypdf-exampleplugin``:
+
+.. code-block:: python
+
+    # sample ./setup.py file
+    from setuptools import setup
+
+    setup(
+        name="ocrmypdf-exampleplugin",
+        packages=["exampleplugin"],
+        # the following makes a plugin available to pytest
+        entry_points={"ocrmypdf": ["exampleplugin = exampleplugin.pluginmodule"]},
+    )
+
+.. code-block:: ini
+
+    # equivalent setup.cfg
+    [options.entry_points]
+    ocrmypdf =
+        exampleplugin = exampleplugin.pluginmodule
+
+Plugin requirements
+===================
+
+OCRmyPDF generally uses multiple worker processes. When a new worker is started,
+Python will import all plugins again, including all plugins that were imported earlier.
+This means that the global state of a plugin in one worker will not be shared with
+other workers. As such, plugin hook implementations should be stateless, relying
+only on their inputs. Hook implementations may use their input parameters to
+to obtain a reference to shared state prepared by another hook implementation.
+Plugins must expect that other instances of the plugin will be running
+simultaneously.
+
+The ``context`` object that is passed to many hooks can be used to share information
+about a file being worked on. Plugins must write private, plugin-specific data to
+a subfolder named ``{options.work_folder}/ocrmypdf-plugin-name``. Plugins MAY
+read and write files in ``options.work_folder``, but should be aware that their
+semantics are subject to change.
+
+OCRmyPDF will delete ``options.work_folder`` when it has finished OCRing
+a file, unless invoked with ``--keep-temporary-files``.
+
+The documentation for some plugin hooks contain a detailed description of the
+execution context in which they will be called.
+
+Plugins should be prepared to work whether executed in worker threads or worker
+processes. Generally, OCRmyPDF uses processes, but has a semi-hidden threaded
+argument that simplifies debugging.
+
+
+Plugin hooks
+============
+
+A plugin may provide the following hooks. Hooks must be decorated with
+``ocrmypdf.hookimpl``, for example:
+
+.. code-block:: python
+
+    from ocrmpydf import hookimpl
+
+    @hookimpl
+    def add_options(parser):
+        pass
+
+The following is a complete list of hooks that are available, and when
+they are called.
+
+.. _firstresult:
+
+**Note on firstresult hooks**
+
+If multiple plugins install implementations for this hook, they will be called in
+the reverse of the order in which they are installed (i.e., last plugin wins).
+When each hook implementation is called in order, the first implementation that
+returns a value other than ``None`` will "win" and prevent execution of all other
+hooks. As such, you cannot "chain" a series of plugin filters together in this
+way. Instead, a single hook implementation should be responsible for any such
+chaining operations.
+
+Custom command line arguments
+-----------------------------
+
+.. autofunction:: ocrmypdf.pluginspec.add_options
+
+.. autofunction:: ocrmypdf.pluginspec.check_options
+
+Execution and progress reporting
+--------------------------------
+
+.. autoclass: ocrmypdf.pluginspec.Executor
+    :members:
+
+.. autofunction:: ocrmypdf.pluginspec.get_logging_console
+
+.. autofunction:: ocrmypdf.pluginspec.get_executor
+
+.. autofunction:: ocrmypdf.pluginspec.get_progressbar_class
+
+Applying special behavior before processing
+-------------------------------------------
+
+.. autofunction:: ocrmypdf.pluginspec.validate
+
+PDF page to image
+-----------------
+
+.. autofunction:: ocrmypdf.pluginspec.rasterize_pdf_page
+
+Modifying intermediate images
+-----------------------------
+
+.. autofunction:: ocrmypdf.pluginspec.filter_ocr_image
+
+.. autofunction:: ocrmypdf.pluginspec.filter_page_image
+
+.. autofunction:: ocrmypdf.pluginspec.filter_pdf_page
+
+OCR engine
+----------
+
+.. autofunction:: ocrmypdf.pluginspec.get_ocr_engine
+
+.. autoclass:: ocrmypdf.pluginspec.OcrEngine
+    :members:
+
+    .. automethod:: __str__
+
+.. autoclass:: ocrmypdf.pluginspec.OrientationConfidence
+
+PDF/A production
+----------------
+
+.. autofunction:: ocrmypdf.pluginspec.generate_pdfa

misc/batch.py

@@ -0,0 +1,62 @@
+#!/usr/bin/env python3
+# Copyright 2016 findingorder: https://github.com/findingorder
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+# This script must be edited to meet your needs.
+
+import logging
+import os
+import sys
+from pathlib import Path
+
+import ocrmypdf
+
+# pylint: disable=logging-format-interpolation
+# pylint: disable=logging-not-lazy
+
+script_dir = Path(__file__).parent
+
+if len(sys.argv) > 1:
+    start_dir = Path(sys.argv[1])
+else:
+    start_dir = Path('.')
+
+if len(sys.argv) > 2:
+    log_file = Path(sys.argv[2])
+else:
+    log_file = script_dir.with_name('ocr-tree.log')
+
+logging.basicConfig(
+    level=logging.INFO,
+    format='%(asctime)s %(message)s',
+    filename=log_file,
+    filemode='a',
+)
+
+ocrmypdf.configure_logging(ocrmypdf.Verbosity.default)
+
+for filename in start_dir.glob("**/*.py"):
+    logging.info(f"Processing {filename}")
+    result = ocrmypdf.ocr(filename, filename, deskew=True)
+    if result == ocrmypdf.ExitCode.already_done_ocr:
+        logging.error("Skipped document because it already contained text")
+    elif result == ocrmypdf.ExitCode.ok:
+        logging.info("OCR complete")
+    logging.info(result)

misc/completion/ocrmypdf.bash

@@ -0,0 +1,120 @@
+# ocrmypdf completion                                     -*- shell-script -*-
+
+# Copyright 2019 Frank Pille
+# Copyright 2020 Alex Willner
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+set -o errexit
+
+_ocrmypdf()
+{
+    local cur prev cword words split
+
+    # Homebrew on Macs have version 1.3 of bash-completion which doesn't include - see #502
+    if declare -F _init_completions >/dev/null 2>&1; then
+        _init_completion -s || return
+    else
+        COMPREPLY=()
+        _get_comp_words_by_ref cur prev words cword
+    fi
+
+    if [[ $cur == -* ]]; then
+        COMPREPLY=( $( compgen -W '--language --image-dpi --output-type
+            --sidecar --version --jobs --quiet --verbose --title --author
+            --subject --keywords --rotate-pages --deskew
+            --clean --clean-final --unpaper-args --oversample --remove-vectors
+            --force-ocr --skip-text --redo-ocr
+            --skip-big --jpeg-quality --png-quality --jbig2-lossy
+            --max-image-mpixels --tesseract-config --tesseract-pagesegmode
+            --help --tesseract-oem --pdf-renderer --tesseract-timeout
+            --rotate-pages-threshold --pdfa-image-compression --user-words
+            --user-patterns --keep-temporary-files --output-type
+            --no-progress-bar --pages --fast-web-view' \
+            --  "$cur" ) )
+        return
+    else
+        _filedir
+        return
+    fi
+
+    case $prev in
+        --version|-h|--help)
+            return
+            ;;
+        --user-words|--user-patterns|--tesseract-config)
+            _filedir
+            return
+            ;;
+        --output-type)
+            COMPREPLY=( $( compgen -W 'pdfa pdf pdfa-1 pdfa-2 pdfa-3' -- \
+                "$cur" ) )
+            return
+            ;;
+        --pdf-renderer)
+            COMPREPLY=( $( compgen -W 'auto hocr sandwich' -- "$cur" ) )
+            return
+            ;;
+        --pdfa-image-compression)
+            COMPREPLY=( $( compgen -W 'auto jpeg lossless' -- "$cur" ) )
+            return
+            ;;
+        -O|--optimize|--tesseract-oem)
+            COMPREPLY=( $( compgen -W '{0..3}' -- "$cur" ) )
+            return
+            ;;
+        --jpeg-quality|--png-quality)
+            COMPREPLY=( $( compgen -W '{0..100}' -- "$cur" ) )
+            return
+            ;;
+        -l|--language)
+            COMPREPLY=$( command tesseract --list-langs 2>/dev/null )
+            COMPREPLY=( $( compgen -W '${COMPREPLY[@]##*:}' -- "$cur" ) )
+            return
+            ;;
+        --image-dpi|--oversample|--skip-big|--max-image-mpixels|\
+        --tesseract-timeout|--rotate-pages-threshold)
+            COMPREPLY=( $( compgen -P "$cur" -W '{0..9}' ) )
+            return
+            ;;
+        -j|--jobs)
+            COMPREPLY=( $( compgen -W '{1..'$( _ncpus )'}' -- "$cur" ) )
+            return
+            ;;
+        -v|--verbose)
+            COMPREPLY=( $( compgen -W '{0..2}' -- "$cur" ) ) # max level ?
+            return
+            ;;
+        --tesseract-pagesegmode)
+            COMPREPLY=( $( compgen -W '{1..13}' -- "$cur" ) )
+            return
+            ;;
+        --sidecar|--title|--author|--subject|--keywords|--unpaper-args|--pages|--fast-web-view)
+            # argument required but no completions available
+            return
+            ;;
+    esac
+
+    $split && return
+} &&
+complete -F _ocrmypdf ocrmypdf
+
+set +o errexit
+
+# ex: filetype=sh

misc/completion/ocrmypdf.fish

@@ -0,0 +1,139 @@
+# Copyright 2020 James R. Barlow
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+complete -c ocrmypdf -x -n '__fish_is_first_arg' -l version
+complete -c ocrmypdf -x -n '__fish_is_first_arg' -s h -s "?" -l help
+
+complete -c ocrmypdf -r -l sidecar -d "write OCR to text file"
+complete -c ocrmypdf -x -s q -l quiet
+
+complete -c ocrmypdf -s r -l rotate-pages -d "rotate pages to correct orientation"
+complete -c ocrmypdf -s d -l deskew -d "fix small horizontal alignment skew"
+complete -c ocrmypdf -s c -l clean -d "clean document images before OCR"
+complete -c ocrmypdf -s i -l clean-final -d "clean document images and keep result"
+complete -c ocrmypdf -l remove-vectors -d "don't send vector objects to OCR"
+
+complete -c ocrmypdf -s f -l force-ocr -d "OCR documents that already have printable text"
+complete -c ocrmypdf -s s -l skip-ocr -d "skip OCR on pages that text, otherwise try OCR"
+complete -c ocrmypdf -l redo-ocr -d "redo OCR on any pages that seem to have OCR already"
+
+complete -c ocrmypdf -s k -l keep-temporary-files -d "keep temporary files (debug)"
+
+function __fish_ocrmypdf_languages
+    set langs (tesseract --list-langs ^/dev/null)
+    set arr (string split '\n' $langs)
+    for lang in $arr[2..-1]
+        echo $lang
+    end
+end
+complete -c ocrmypdf -x -s l -l language -a '(__fish_ocrmypdf_languages)' -d "language"
+
+complete -c ocrmypdf -x -l image-dpi -d "assume this DPI if input image DPI is unknown"
+
+function __fish_ocrmypdf_output_type
+    echo -e "pdfa\t"(_ "output a PDF/A (default)")
+    echo -e "pdf\t"(_ "output a standard PDF")
+    echo -e "pdfa-1\t"(_ "output a PDF/A-1b")
+    echo -e "pdfa-2\t"(_ "output a PDF/A-2b")
+    echo -e "pdfa-3\t"(_ "output a PDF/A-3b")
+    echo -e "none\t"(_ "do not produce an output PDF (for example, if you only care about --sidecar)")
+end
+complete -c ocrmypdf -x -l output-type -a '(__fish_ocrmypdf_output_type)' -d "select PDF output options"
+
+function __fish_ocrmypdf_pdf_renderer
+    echo -e "auto\t"(_ "auto select PDF renderer")
+    echo -e "hocr\t"(_ "use hOCR renderer")
+    echo -e "hocrdebug\t"(_ "uses hOCR renderer in debug mode, showing recognized text")
+    echo -e "sandwich\t"(_ "use sandwich renderer")
+end
+complete -c ocrmypdf -x -l pdf-renderer -a '(__fish_ocrmypdf_pdf_renderer)' -d "select PDF renderer options"
+
+function __fish_ocrmypdf_optimize
+    echo -e "0\t"(_ "do not optimize")
+    echo -e "1\t"(_ "do safe, lossless optimizations (default)")
+    echo -e "2\t"(_ "do some lossy optimizations")
+    echo -e "3\t"(_ "do aggressive lossy optimizations (including lossy JBIG2)")
+end
+complete -c ocrmypdf -x -s O -l optimize -a '(__fish_ocrmypdf_optimize)' -d "select optimization level"
+
+function __fish_ocrmypdf_verbose
+    echo -e "0\t"(_ "standard output messages")
+    echo -e "1\t"(_ "troubleshooting output messages")
+    echo -e "2\t"(_ "debugging output messages")
+end
+complete -c ocrmypdf -x -s v -l verbose -a '(__fish_ocrmypdf_verbose)' -d "set verbosity level"
+
+complete -c ocrmypdf -x -l no-progress-bar -d "disable the progress bar"
+
+function __fish_ocrmypdf_pdfa_compression
+    echo -e "auto\t"(_ "let Ghostscript decide how to compress images")
+    echo -e "jpeg\t"(_ "convert color and grayscale images to JPEG")
+    echo -e "lossless\t"(_ "convert color and grayscale images to lossless (PNG)")
+end
+complete -c ocrmypdf -x -l pdfa-image-compression -a '(__fish_ocrmypdf_pdfa_compression)' -d "set PDF/A image compression options"
+
+complete -c ocrmypdf -x -s j -l jobs -d "how many worker processes to use"
+complete -c ocrmypdf -x -l title -d "set metadata"
+complete -c ocrmypdf -x -l author -d "set metadata"
+complete -c ocrmypdf -x -l subject -d "set metadata"
+complete -c ocrmypdf -x -l keywords -d "set metadata"
+complete -c ocrmypdf -x -l oversample -d "oversample images to this DPI"
+complete -c ocrmypdf -x -l skip-big -d "skip OCR on pages larger than this many MPixels"
+
+complete -c ocrmypdf -x -l jpeg-quality -d "JPEG quality [0..100]"
+complete -c ocrmypdf -x -l png-quality -d "PNG quality [0..100]"
+complete -c ocrmypdf -x -l jbig2-lossy -d "enable lossy JBIG2 (see docs)"
+complete -c ocrmypdf -x -l max-image-mpixels -d "image decompression bomb threshold"
+complete -c ocrmypdf -x -l pages -d "apply OCR to only the specified pages"
+complete -c ocrmypdf -x -l tesseract-config -d "set custom tesseract config file"
+
+function __fish_ocrmypdf_tesseract_pagesegmode
+  echo -e "0\t"(_ "orientation and script detection (OSD) only")
+  echo -e "1\t"(_ "automatic page segmentation with OSD")
+  echo -e "2\t"(_ "automatic page segmentation, but no OSD, or OCR")
+  echo -e "3\t"(_ "fully automatic page segmentation, but no OSD (default)")
+  echo -e "4\t"(_ "assume a single column of text of variable sizes")
+  echo -e "5\t"(_ "assume a single uniform block of vertically aligned text")
+  echo -e "6\t"(_ "assume a single uniform block of text")
+  echo -e "7\t"(_ "treat the image as a single text line")
+  echo -e "8\t"(_ "treat the image as a single word")
+  echo -e "9\t"(_ "treat the image as a single word in a circle")
+  echo -e "10\t"(_ "treat the image as a single character")
+  echo -e "11\t"(_ "sparse text - find as much text as possible in no particular order")
+  echo -e "12\t"(_ "sparse text with OSD")
+  echo -e "13\t"(_ "raw line - treat the image as a single text line")
+end
+complete -c ocrmypdf -x -l tesseract-pagesegmode -a '(__fish_ocrmypdf_tesseract_pagesegmode)' -d "set tesseract --psm"
+
+function __fish_ocrmypdf_tesseract_oem
+    echo -e "0\t"(_ "legacy engine only")
+    echo -e "1\t"(_ "neural nets LSTM engine only")
+    echo -e "2\t"(_ "legacy + LSTM engines")
+    echo -e "3\t"(_ "default, based on what is available")
+end
+complete -c ocrmypdf -x -l tesseract-oem -a '(__fish_ocrmypdf_tesseract_oem)' -d "set tesseract --oem"
+complete -c ocrmypdf -x -l tesseract-timeout -d "maximum number of seconds to wait for OCR"
+complete -c ocrmypdf -x -l rotate-pages-threshold -d "page rotation confidence"
+
+complete -c ocrmypdf -r -l user-words -d "specify location of user words file"
+complete -c ocrmypdf -r -l user-patterns -d "specify location of user patterns file"
+complete -c ocrmypdf -x -l fast-web-view -d "if file size if above this amount in MB, linearize PDF"
+
+complete -c ocrmypdf -x -a "(__fish_complete_suffix .pdf; __fish_complete_suffix .PDF; __fish_complete_suffix .jpg; __fish_complete_suffix .png)"

misc/docker-compose.example.yml

@@ -0,0 +1,15 @@
+---
+version: "3.3"
+services:
+  ocrmypdf:
+    restart: always
+    container_name: ocrmypdf
+    image: jbarlow83/ocrmypdf
+    volumes:
+      - "/media/scan:/input"
+      - "/mnt/scan:/output"
+    environment:
+      - OCR_OUTPUT_DIRECTORY_YEAR_MONTH=0
+    user: "<SET TO YOUR USER ID>:<SET TO YOUR GROUP ID>"
+    entrypoint: python3
+    command: watcher.py

misc/example_plugin.py

@@ -0,0 +1,84 @@
+# © 2020 James R Barlow: https://github.com/jbarlow83
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+"""
+An example of an OCRmyPDF plugin.
+
+This plugin adds two new command line arguments
+    --grayscale-ocr: converts the image to grayscale before performing OCR on it
+        (This is occasionally useful for images whose color confounds OCR. It only
+        affects the image shown to OCR. The image is not saved.)
+    --mono-page: converts pages all pages in the output file to black and white
+
+To use this from the command line:
+    ocrmypdf --plugin path/to/example_plugin.py --mono-page input.pdf output.pdf
+
+To use this as an API:
+    import ocrmypdf
+    ocrmypdf.ocr('input.pdf', 'output.pdf',
+        plugins=['path/to/example_plugin.py'], mono_page=True
+    )
+"""
+
+import logging
+
+from PIL import Image
+
+from ocrmypdf import hookimpl
+
+log = logging.getLogger(__name__)
+
+
+@hookimpl
+def add_options(parser):
+    parser.add_argument('--grayscale-ocr', action='store_true')
+    parser.add_argument('--mono-page', action='store_true')
+
+
+@hookimpl
+def prepare(options):
+    pass
+
+
+@hookimpl
+def validate(pdfinfo, options):
+    pass
+
+
+@hookimpl
+def filter_ocr_image(page, image):
+    if page.options.grayscale_ocr:
+        log.info("graying")
+        return image.convert('L')
+    return image
+
+
+@hookimpl
+def filter_page_image(page, image_filename):
+    if page.options.mono_page:
+        with Image.open(image_filename) as im:
+            im = im.convert('1')
+            im.save(image_filename)
+        return image_filename
+    else:
+        output = image_filename.with_suffix('.jpg')
+        with Image.open(image_filename) as im:
+            im.save(output)
+        return output

misc/synology.py

@@ -0,0 +1,92 @@
+#!/bin/env python3
+# Copyright 2017 github.com/Enantiomerie
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+# This script must be edited to meet your needs.
+
+import logging
+import os
+import shutil
+import subprocess
+import sys
+import time
+
+# pylint: disable=logging-format-interpolation
+# pylint: disable=logging-not-lazy
+
+script_dir = os.path.dirname(os.path.realpath(__file__))
+timestamp = time.strftime("%Y-%m-%d-%H%M_")
+log_file = script_dir + '/' + timestamp + 'ocrmypdf.log'
+logging.basicConfig(
+    level=logging.INFO,
+    format='%(asctime)s %(message)s',
+    filename=log_file,
+    filemode='w',
+)
+
+if len(sys.argv) > 1:
+    start_dir = sys.argv[1]
+else:
+    start_dir = '.'
+
+for dir_name, _subdirs, file_list in os.walk(start_dir):
+    logging.info(dir_name)
+    os.chdir(dir_name)
+    for filename in file_list:
+        file_stem, file_ext = os.path.splitext(filename)
+        if file_ext != '.pdf':
+            continue
+        full_path = os.path.join(dir_name, filename)
+        timestamp_ocr = time.strftime("%Y-%m-%d-%H%M_OCR_")
+        filename_ocr = timestamp_ocr + file_stem + '.pdf'
+        # create string for pdf processing
+        # the script is processed as root user via chron
+        cmd = [
+            'docker',
+            'run',
+            '--rm',
+            '-i',
+            'jbarlow83/ocrmypdf',
+            '--deskew',
+            '-',
+            '-',
+        ]
+        logging.info(cmd)
+        full_path_ocr = os.path.join(dir_name, filename_ocr)
+        with open(filename, 'rb') as input_file, open(
+            full_path_ocr, 'wb'
+        ) as output_file:
+            proc = subprocess.run(
+                cmd,
+                stdin=input_file,
+                stdout=output_file,
+                stderr=subprocess.PIPE,
+                check=False,
+                text=True,
+                errors='ignore',
+            )
+        logging.info(proc.stderr)
+        os.chmod(full_path_ocr, 0o664)
+        os.chmod(full_path, 0o664)
+        full_path_ocr_archive = sys.argv[2]
+        full_path_archive = sys.argv[2] + '/no_ocr'
+        shutil.move(full_path_ocr, full_path_ocr_archive)
+        shutil.move(full_path, full_path_archive)
+logging.info('Finished.\n')

misc/watcher.py

@@ -0,0 +1,172 @@
+#!/usr/bin/env python3
+# Copyright (C) 2019 Ian Alexander: https://github.com/ianalexander
+# Copyright (C) 2020 James R Barlow: https://github.com/jbarlow83
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+import json
+import logging
+import os
+import sys
+import time
+from datetime import datetime
+from pathlib import Path
+
+import pikepdf
+from watchdog.events import PatternMatchingEventHandler
+from watchdog.observers import Observer
+from watchdog.observers.polling import PollingObserver
+
+import ocrmypdf
+
+# pylint: disable=logging-format-interpolation
+
+
+def getenv_bool(name: str, default: str = 'False'):
+    return os.getenv(name, default).lower() in ('true', 'yes', 'y', '1')
+
+
+INPUT_DIRECTORY = os.getenv('OCR_INPUT_DIRECTORY', '/input')
+OUTPUT_DIRECTORY = os.getenv('OCR_OUTPUT_DIRECTORY', '/output')
+OUTPUT_DIRECTORY_YEAR_MONTH = getenv_bool('OCR_OUTPUT_DIRECTORY_YEAR_MONTH')
+ON_SUCCESS_DELETE = getenv_bool('OCR_ON_SUCCESS_DELETE')
+DESKEW = getenv_bool('OCR_DESKEW')
+OCR_JSON_SETTINGS = json.loads(os.getenv('OCR_JSON_SETTINGS', '{}'))
+POLL_NEW_FILE_SECONDS = int(os.getenv('OCR_POLL_NEW_FILE_SECONDS', '1'))
+USE_POLLING = getenv_bool('OCR_USE_POLLING')
+LOGLEVEL = os.getenv('OCR_LOGLEVEL', 'INFO')
+PATTERNS = ['*.pdf', '*.PDF']
+
+log = logging.getLogger('ocrmypdf-watcher')
+
+
+def get_output_dir(root, basename):
+    if OUTPUT_DIRECTORY_YEAR_MONTH:
+        today = datetime.today()
+        output_directory_year_month = (
+            Path(root) / str(today.year) / f'{today.month:02d}'
+        )
+        if not output_directory_year_month.exists():
+            output_directory_year_month.mkdir(parents=True, exist_ok=True)
+        output_path = Path(output_directory_year_month) / basename
+    else:
+        output_path = Path(OUTPUT_DIRECTORY) / basename
+    return output_path
+
+
+def wait_for_file_ready(file_path):
+    # This loop waits to make sure that the file is completely loaded on
+    # disk before attempting to read. Docker sometimes will publish the
+    # watchdog event before the file is actually fully on disk, causing
+    # pikepdf to fail.
+
+    retries = 5
+    while retries:
+        try:
+            pdf = pikepdf.open(file_path)
+        except (FileNotFoundError, pikepdf.PdfError) as e:
+            log.info(f"File {file_path} is not ready yet")
+            log.debug("Exception was", exc_info=e)
+            time.sleep(POLL_NEW_FILE_SECONDS)
+            retries -= 1
+        else:
+            pdf.close()
+            return True
+
+    return False
+
+
+def execute_ocrmypdf(file_path):
+    file_path = Path(file_path)
+    output_path = get_output_dir(OUTPUT_DIRECTORY, file_path.name)
+
+    log.info("-" * 20)
+    log.info(f'New file: {file_path}. Waiting until fully loaded...')
+    if not wait_for_file_ready(file_path):
+        log.info(f"Gave up waiting for {file_path} to become ready")
+        return
+    log.info(f'Attempting to OCRmyPDF to: {output_path}')
+    exit_code = ocrmypdf.ocr(
+        input_file=file_path,
+        output_file=output_path,
+        deskew=DESKEW,
+        **OCR_JSON_SETTINGS,
+    )
+    if exit_code == 0 and ON_SUCCESS_DELETE:
+        log.info(f'OCR is done. Deleting: {file_path}')
+        file_path.unlink()
+    else:
+        log.info('OCR is done')
+
+
+class HandleObserverEvent(PatternMatchingEventHandler):
+    def on_any_event(self, event):
+        if event.event_type in ['created']:
+            execute_ocrmypdf(event.src_path)
+
+
+def main():
+    ocrmypdf.configure_logging(
+        verbosity=(
+            ocrmypdf.Verbosity.default
+            if LOGLEVEL != 'DEBUG'
+            else ocrmypdf.Verbosity.debug
+        ),
+        manage_root_logger=True,
+    )
+    log.setLevel(LOGLEVEL)
+    log.info(
+        f"Starting OCRmyPDF watcher with config:\n"
+        f"Input Directory: {INPUT_DIRECTORY}\n"
+        f"Output Directory: {OUTPUT_DIRECTORY}\n"
+        f"Output Directory Year & Month: {OUTPUT_DIRECTORY_YEAR_MONTH}"
+    )
+    log.debug(
+        f"INPUT_DIRECTORY: {INPUT_DIRECTORY}\n"
+        f"OUTPUT_DIRECTORY: {OUTPUT_DIRECTORY}\n"
+        f"OUTPUT_DIRECTORY_YEAR_MONTH: {OUTPUT_DIRECTORY_YEAR_MONTH}\n"
+        f"ON_SUCCESS_DELETE: {ON_SUCCESS_DELETE}\n"
+        f"DESKEW: {DESKEW}\n"
+        f"ARGS: {OCR_JSON_SETTINGS}\n"
+        f"POLL_NEW_FILE_SECONDS: {POLL_NEW_FILE_SECONDS}\n"
+        f"USE_POLLING: {USE_POLLING}\n"
+        f"LOGLEVEL: {LOGLEVEL}"
+    )
+
+    if 'input_file' in OCR_JSON_SETTINGS or 'output_file' in OCR_JSON_SETTINGS:
+        log.error('OCR_JSON_SETTINGS should not specify input file or output file')
+        sys.exit(1)
+
+    handler = HandleObserverEvent(patterns=PATTERNS)
+    if USE_POLLING:
+        observer = PollingObserver()
+    else:
+        observer = Observer()
+    observer.schedule(handler, INPUT_DIRECTORY, recursive=True)
+    observer.start()
+    try:
+        while True:
+            time.sleep(1)
+    except KeyboardInterrupt:
+        observer.stop()
+    observer.join()
+
+
+if __name__ == "__main__":
+    main()

misc/webservice.py

@@ -0,0 +1,118 @@
+#!/usr/bin/env python3
+# webservice.py wrapper for OCRmyPDF
+# Copyright (C) 2019 James R. Barlow: github.com/jbarlow83
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+"""This is a simple web service/HTTP wrapper for OCRmyPDF
+
+This may be more convenient than the command line tool for some Docker users.
+Note that OCRmyPDF uses Ghostscript, which is licensed under AGPLv3+. While
+OCRmyPDF is under GPLv3, this file is distributed under the Affero GPLv3+ license,
+to emphasize that SaaS deployments should make sure they comply with
+Ghostscript's license as well as OCRmyPDF's.
+"""
+
+import os
+import shlex
+from subprocess import PIPE, run
+from tempfile import TemporaryDirectory
+
+from flask import Flask, Response, request, send_from_directory
+from werkzeug.utils import secure_filename
+
+app = Flask(__name__)
+app.secret_key = "secret"
+app.config['MAX_CONTENT_LENGTH'] = 50_000_000
+app.config.from_envvar("OCRMYPDF_WEBSERVICE_SETTINGS", silent=True)
+
+ALLOWED_EXTENSIONS = {"pdf"}
+
+
+def allowed_file(filename):
+    return "." in filename and filename.rsplit(".", 1)[1].lower() in ALLOWED_EXTENSIONS
+
+
+def do_ocrmypdf(file):
+    uploaddir = TemporaryDirectory(prefix="ocrmypdf-upload")
+    downloaddir = TemporaryDirectory(prefix="ocrmypdf-download")
+
+    filename = secure_filename(file.filename)
+    up_file = os.path.join(uploaddir.name, filename)
+    file.save(up_file)
+
+    down_file = os.path.join(downloaddir.name, filename)
+
+    cmd_args = [arg for arg in shlex.split(request.form["params"])]
+    if "--sidecar" in cmd_args:
+        return Response("--sidecar not supported", 501, mimetype='text/plain')
+
+    ocrmypdf_args = ["ocrmypdf", *cmd_args, up_file, down_file]
+    proc = run(ocrmypdf_args, stdout=PIPE, stderr=PIPE, encoding="utf-8")
+    if proc.returncode != 0:
+        stderr = proc.stderr
+        return Response(stderr, 400, mimetype='text/plain')
+
+    return send_from_directory(downloaddir.name, filename)
+
+
+@app.route("/", methods=["GET", "POST"])
+def upload_file():
+    if request.method == "POST":
+        if "file" not in request.files:
+            return Response("No file in POST", 400, mimetype='text/plain')
+        file = request.files["file"]
+        if file.filename == "":
+            return Response("Empty filename", 400, mimetype='text/plain')
+        if not allowed_file(file.filename):
+            return Response("Invalid filename", 400, mimetype='text/plain')
+        if file and allowed_file(file.filename):
+            return do_ocrmypdf(file)
+        return Response("Some other problem", 400, mimetype='text/plain')
+
+    return """
+    <!doctype html>
+    <title>OCRmyPDF webservice</title>
+    <h1>Upload a PDF (debug UI)</h1>
+    <form method=post enctype=multipart/form-data>
+      <label for="args">Command line parameters</label>
+      <input type=textbox name=params>
+      <label for="file">File to upload</label>
+      <input type=file name=file>
+      <input type=submit value=Upload>
+    </form>
+    <h4>Notice</h2>
+    <div style="font-size: 70%; max-width: 34em;">
+    <p>This is a webservice wrapper for OCRmyPDF.</p>
+    <p>Copyright 2019 James R. Barlow</p>
+    <p>This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Affero General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+    </p>
+    <p>This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+    </p>
+    <p>
+    You should have received a copy of the GNU Affero General Public License
+    along with this program.  If not, see &lt;http://www.gnu.org/licenses/&gt;.
+    </p>
+    </div>
+    """
+
+
+if __name__ == "__main__":
+    app.run(host='0.0.0.0', port=5000)

ocrmypdf.py

@@ -1,45 +0,0 @@
-#!/usr/local/bin/python2
-##############################################################################
-# Copyright (c) 2013-14: fritz-hh from Github (https://github.com/fritz-hh)
-##############################################################################
-
-import argparse
-from argparse import RawTextHelpFormatter
-
-if __name__ == '__main__':
-
-    parser = argparse.ArgumentParser(prog="ocrmypdf", description="OCRmyPDF adds an OCR text layer to scanned PDF files, allowing them to be searched", formatter_class=RawTextHelpFormatter)
-    parser.add_argument('-v', '--verbove', action='count', help="Increase the verbosity (this option can be used more than once) (e.g. -vvv)")
-    parser.add_argument('-k', '--keep-tmp', action='store_true', help="Do not delete the temporary files")
-    parser.add_argument('-g', '--debug', action='store_true', 
-        help="Activate debug mode:\n" + 
-        "- Generates a PDF file containing each page twice (once with the image, once without the image\n" +
-        "       but with the OCRed text as well as the detected bounding boxes)\n" +
-        "- Set the verbosity to the highest possible\n" +
-        "- Do not delete the temporary files")
-    parser.add_argument('-d', '--deskew', action='store_true', help="Deskew each page before performing OCR")
-    parser.add_argument('-c', '--clean', action='store_true', help="Clean each page before performing OCR")
-    parser.add_argument('-i', action='store_true', help="Incorporate the cleaned image in the final PDF file (by default the original image, or the deskewed image if the -d option is set)")
-    parser.add_argument('-o', '--oversample', metavar='dpi', type=int, 
-        help="If the resolution of an image is lower than dpi value provided as argument, provide the OCR engine with\n" +
-        "an oversampled image having the latter dpi value. This can improve the OCR results but can lead to a larger output PDF file.\n" +
-        "(default: no oversampling performed)")
-    group_sf = parser.add_mutually_exclusive_group()
-    group_sf.add_argument('-f', action='store_true', 
-        help="Force to OCR the whole document, even if some page already contain font data.\n" +
-        "(which should not be the case for PDF files built from scnanned images)\n" +
-        "Any text data will be rendered to raster format and then fed through OCR.")
-    group_sf.add_argument('-s', action='store_true', help="If pages contain font data, do not OCR that page, but include the page (as is) in the final output.")
-    parser.add_argument('-l', '--language', metavar='lan', 
-        help="Language(s) of the PDF file. The language should be set correctly in order to get good OCR results.\n" +
-        "Any language supported by tesseract is supported (Tesseract uses 3-character ISO 639-2 language codes)\n" +
-        "Multiple languages may be specified, separated by '+' characters.\n" +
-        "(The default language is defined in the config file)")
-    parser.add_argument('-C', '--tess-config', metavar='file', 
-        help="Pass an additional configuration file to the tesseract OCR engine.\n" +
-        "(this option can be used more than once)\n" +
-        "Note 1: The configuration file must be available in the \"tessdata/configs\" folder of your tesseract installation")
-    parser.add_argument('inputfile', help="PDF file to be OCRed")
-    parser.add_argument('outputfile', help="The PDF/A file that will be generated")
-
-    args = parser.parse_args()

ocrmypdf/ghostscript.py

@@ -1,51 +0,0 @@
-#!/usr/bin/env python3
-# © 2015 James R. Barlow: github.com/jbarlow83
-
-from tempfile import NamedTemporaryFile
-from subprocess import Popen, PIPE, check_call
-from shutil import copy
-
-
-def rasterize_pdf(input_file, output_file, xres, yres, raster_device, log):
-    with NamedTemporaryFile(delete=True) as tmp:
-        args_gs = [
-            'gs',
-            '-dBATCH', '-dNOPAUSE',
-            '-sDEVICE=%s' % raster_device,
-            '-o', tmp.name,
-            '-r{0}x{1}'.format(str(xres), str(yres)),
-            input_file
-        ]
-
-        p = Popen(args_gs, close_fds=True, stdout=PIPE, stderr=PIPE,
-                  universal_newlines=True)
-        stdout, stderr = p.communicate()
-        if stdout:
-            log.debug(stdout)
-        if stderr:
-            log.error(stderr)
-
-        if p.returncode == 0:
-            copy(tmp.name, output_file)
-        else:
-            log.error('Ghostscript rendering failed')
-
-
-def generate_pdfa(pdf_pages, output_file):
-    with NamedTemporaryFile(delete=True) as gs_pdf:
-        args_gs = [
-            "gs",
-            "-dQUIET",
-            "-dBATCH",
-            "-dNOPAUSE",
-            "-sDEVICE=pdfwrite",
-            "-sColorConversionStrategy=/RGB",
-            "-sProcessColorModel=DeviceRGB",
-            "-dPDFA",
-            "-sPDFACompatibilityPolicy=2",
-            "-sOutputICCProfile=srgb.icc",
-            "-sOutputFile=" + gs_pdf.name,
-        ]
-        args_gs.extend(pdf_pages)
-        check_call(args_gs)
-        copy(gs_pdf.name, output_file)

ocrmypdf/hocrtransform.py

@@ -1,231 +0,0 @@
-#!/usr/local/bin/python3
-##############################################################################
-# Copyright (c) 2013-14: fritz-hh from Github
-#   (https://github.com/fritz-hh)
-#
-# Copyright (c) 2010: Jonathan Brinley from Github
-#   (https://github.com/jbrinley/HocrConverter)
-#   Initial version by Jonathan Brinley, jonathanbrinley@gmail.com
-##############################################################################
-from reportlab.pdfgen.canvas import Canvas
-from reportlab.lib.units import inch
-from lxml import etree as ElementTree
-from PIL import Image
-from collections import namedtuple
-import re
-import argparse
-
-
-Rect = namedtuple('Rect', ['x1', 'y1', 'x2', 'y2'])
-
-
-class HocrTransformError(Exception):
-    pass
-
-
-class HocrTransform():
-
-    """
-    A class for converting documents from the hOCR format.
-    For details of the hOCR format, see:
-    http://docs.google.com/View?docid=dfxcv4vc_67g844kf
-    """
-
-    def __init__(self, hocrFileName, dpi):
-        self.dpi = dpi
-        self.boxPattern = re.compile(r'bbox((\s+\d+){4})')
-
-        self.hocr = ElementTree.ElementTree()
-        self.hocr.parse(hocrFileName)
-
-        # if the hOCR file has a namespace, ElementTree requires its use to
-        # find elements
-        matches = re.match(r'({.*})html', self.hocr.getroot().tag)
-        self.xmlns = ''
-        if matches:
-            self.xmlns = matches.group(1)
-
-        # get dimension in pt (not pixel!!!!) of the OCRed image
-        self.width, self.height = None, None
-        for div in self.hocr.findall(
-                ".//%sdiv[@class='ocr_page']" % (self.xmlns)):
-            coords = self.element_coordinates(div)
-            pt_coords = self.pt_from_pixel(coords)
-            self.width = pt_coords.x2 - pt_coords.x1
-            self.height = pt_coords.y2 - pt_coords.y1
-            # there shouldn't be more than one, and if there is, we don't want
-            # it
-            break
-        if self.width is None or self.height is None:
-            raise HocrTransformError("hocr file is missing page dimensions")
-
-    def __str__(self):
-        """
-        Return the textual content of the HTML body
-        """
-        if self.hocr is None:
-            return ''
-        body = self.hocr.find(".//%sbody" % (self.xmlns))
-        if body:
-            return self._get_element_text(body)
-        else:
-            return ''
-
-    def _get_element_text(self, element):
-        """
-        Return the textual content of the element and its children
-        """
-        text = ''
-        if element.text is not None:
-            text += element.text
-        for child in element.getchildren():
-            text += self._get_element_text(child)
-        if element.tail is not None:
-            text += element.tail
-        return text
-
-    def element_coordinates(self, element):
-        """
-        Returns a tuple containing the coordinates of the bounding box around
-        an element
-        """
-        out = (0, 0, 0, 0)
-        if 'title' in element.attrib:
-            matches = self.boxPattern.search(element.attrib['title'])
-            if matches:
-                coords = matches.group(1).split()
-                out = Rect._make(int(coords[n]) for n in range(4))
-        return out
-
-    def pt_from_pixel(self, pxl):
-        """
-        Returns the quantity in PDF units (pt) given quantity in pixels
-        """
-        return Rect._make(
-            (c / self.dpi * inch) for c in pxl)
-
-    def replace_unsupported_chars(self, s):
-        """
-        Given an input string, returns the corresponding string that:
-        - is available in the helvetica facetype
-        - does not contain any ligature (to allow easy search in the PDF file)
-        """
-        # The 'u' before the character to replace indicates that it is a
-        # unicode character
-        s = s.replace(u"fl", "fl")
-        s = s.replace(u"fi", "fi")
-        return s
-
-    def to_pdf(self, outFileName, imageFileName=None, showBoundingboxes=False,
-               fontname="Helvetica", invisibleText=False):
-        """
-        Creates a PDF file with an image superimposed on top of the text.
-        Text is positioned according to the bounding box of the lines in
-        the hOCR file.
-        The image need not be identical to the image used to create the hOCR
-        file.
-        It can have a lower resolution, different color mode, etc.
-        """
-        # create the PDF file
-        # page size in points (1/72 in.)
-        pdf = Canvas(
-            outFileName, pagesize=(self.width, self.height), pageCompression=1)
-
-        # draw bounding box for each paragraph
-        # light blue for bounding box of paragraph
-        pdf.setStrokeColorRGB(0, 1, 1)
-        # light blue for bounding box of paragraph
-        pdf.setFillColorRGB(0, 1, 1)
-        pdf.setLineWidth(0)		# no line for bounding box
-        for elem in self.hocr.findall(
-                ".//%sp[@class='%s']" % (self.xmlns, "ocr_par")):
-
-            elemtxt = self._get_element_text(elem).rstrip()
-            if len(elemtxt) == 0:
-                continue
-
-            pxl_coords = self.element_coordinates(elem)
-            pt = self.pt_from_pixel(pxl_coords)
-
-            # draw the bbox border
-            if showBoundingboxes:
-                pdf.rect(
-                    pt.x1, self.height - pt.y2, pt.x2 - pt.x1, pt.y2 - pt.y1,
-                    fill=1)
-
-        # check if element with class 'ocrx_word' are available
-        # otherwise use 'ocr_line' as fallback
-        elemclass = "ocr_line"
-        if self.hocr.find(
-                ".//%sspan[@class='ocrx_word']" % (self.xmlns)) is not None:
-            elemclass = "ocrx_word"
-
-        # itterate all text elements
-        # light green for bounding box of word/line
-        pdf.setStrokeColorRGB(1, 0, 0)
-        pdf.setLineWidth(0.5)		# bounding box line width
-        pdf.setDash(6, 3)		# bounding box is dashed
-        pdf.setFillColorRGB(0, 0, 0)  # text in black
-        for elem in self.hocr.findall(
-                ".//%sspan[@class='%s']" % (self.xmlns, elemclass)):
-
-            elemtxt = self._get_element_text(elem).rstrip()
-
-            elemtxt = self.replace_unsupported_chars(elemtxt)
-
-            if len(elemtxt) == 0:
-                continue
-
-            pxl_coords = self.element_coordinates(elem)
-            pt = self.pt_from_pixel(pxl_coords)
-
-            # draw the bbox border
-            if showBoundingboxes:
-                pdf.rect(
-                    pt.x1, self.height - pt.y2, pt.x2 - pt.x1, pt.y2 - pt.y1,
-                    fill=0)
-
-            text = pdf.beginText()
-            fontsize = pt.y2 - pt.y1
-            text.setFont(fontname, fontsize)
-            if invisibleText:
-                text.setTextRenderMode(3)  # Invisible (indicates OCR text)
-
-            # set cursor to bottom left corner of bbox (adjust for dpi)
-            text.setTextOrigin(pt.x1, self.height - pt.y2)
-
-            # scale the width of the text to fill the width of the bbox
-            text.setHorizScale(
-                100 * (pt.x2 - pt.x1) / pdf.stringWidth(
-                    elemtxt, fontname, fontsize))
-
-            # write the text to the page
-            text.textLine(elemtxt)
-            pdf.drawText(text)
-
-        # put the image on the page, scaled to fill the page
-        if imageFileName is not None:
-            pdf.drawImage(imageFileName, 0, 0,
-                          width=self.width, height=self.height)
-
-        # finish up the page and save it
-        pdf.showPage()
-        pdf.save()
-
-
-if __name__ == "__main__":
-    parser = argparse.ArgumentParser(description='Convert hocr file to PDF')
-    parser.add_argument('-b', '--boundingboxes', action="store_true",
-                        default=False, help='Show bounding boxes borders')
-    parser.add_argument('-r', '--resolution', type=int,
-                        default=300,
-                        help='Resolution of the image that was OCRed')
-    parser.add_argument('-i', '--image', default=None,
-                        help='Path to the image to be placed above the text')
-    parser.add_argument('hocrfile', help='Path to the hocr file to be parsed')
-    parser.add_argument(
-        'outputfile', help='Path to the PDF file to be generated')
-    args = parser.parse_args()
-
-    hocr = HocrTransform(args.hocrfile, args.resolution)
-    hocr.to_pdf(args.outputfile, args.image, args.boundingboxes)

ocrmypdf/jhove/COPYING

@@ -1,502 +0,0 @@
-		  GNU LESSER GENERAL PUBLIC LICENSE
-		       Version 2.1, February 1999
-
- Copyright (C) 1991, 1999 Free Software Foundation, Inc.
-     59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
-
-[This is the first released version of the Lesser GPL.  It also counts
- as the successor of the GNU Library Public License, version 2, hence
- the version number 2.1.]
-
-			    Preamble
-
-  The licenses for most software are designed to take away your
-freedom to share and change it.  By contrast, the GNU General Public
-Licenses are intended to guarantee your freedom to share and change
-free software--to make sure the software is free for all its users.
-
-  This license, the Lesser General Public License, applies to some
-specially designated software packages--typically libraries--of the
-Free Software Foundation and other authors who decide to use it.  You
-can use it too, but we suggest you first think carefully about whether
-this license or the ordinary General Public License is the better
-strategy to use in any particular case, based on the explanations below.
-
-  When we speak of free software, we are referring to freedom of use,
-not price.  Our General Public Licenses are designed to make sure that
-you have the freedom to distribute copies of free software (and charge
-for this service if you wish); that you receive source code or can get
-it if you want it; that you can change the software and use pieces of
-it in new free programs; and that you are informed that you can do
-these things.
-
-  To protect your rights, we need to make restrictions that forbid
-distributors to deny you these rights or to ask you to surrender these
-rights.  These restrictions translate to certain responsibilities for
-you if you distribute copies of the library or if you modify it.
-
-  For example, if you distribute copies of the library, whether gratis
-or for a fee, you must give the recipients all the rights that we gave
-you.  You must make sure that they, too, receive or can get the source
-code.  If you link other code with the library, you must provide
-complete object files to the recipients, so that they can relink them
-with the library after making changes to the library and recompiling
-it.  And you must show them these terms so they know their rights.
-
-  We protect your rights with a two-step method: (1) we copyright the
-library, and (2) we offer you this license, which gives you legal
-permission to copy, distribute and/or modify the library.
-
-  To protect each distributor, we want to make it very clear that
-there is no warranty for the free library.  Also, if the library is
-modified by someone else and passed on, the recipients should know
-that what they have is not the original version, so that the original
-author's reputation will not be affected by problems that might be
-introduced by others.
-
-  Finally, software patents pose a constant threat to the existence of
-any free program.  We wish to make sure that a company cannot
-effectively restrict the users of a free program by obtaining a
-restrictive license from a patent holder.  Therefore, we insist that
-any patent license obtained for a version of the library must be
-consistent with the full freedom of use specified in this license.
-
-  Most GNU software, including some libraries, is covered by the
-ordinary GNU General Public License.  This license, the GNU Lesser
-General Public License, applies to certain designated libraries, and
-is quite different from the ordinary General Public License.  We use
-this license for certain libraries in order to permit linking those
-libraries into non-free programs.
-
-  When a program is linked with a library, whether statically or using
-a shared library, the combination of the two is legally speaking a
-combined work, a derivative of the original library.  The ordinary
-General Public License therefore permits such linking only if the
-entire combination fits its criteria of freedom.  The Lesser General
-Public License permits more lax criteria for linking other code with
-the library.
-
-  We call this license the "Lesser" General Public License because it
-does Less to protect the user's freedom than the ordinary General
-Public License.  It also provides other free software developers Less
-of an advantage over competing non-free programs.  These disadvantages
-are the reason we use the ordinary General Public License for many
-libraries.  However, the Lesser license provides advantages in certain
-special circumstances.
-
-  For example, on rare occasions, there may be a special need to
-encourage the widest possible use of a certain library, so that it becomes
-a de-facto standard.  To achieve this, non-free programs must be
-allowed to use the library.  A more frequent case is that a free
-library does the same job as widely used non-free libraries.  In this
-case, there is little to gain by limiting the free library to free
-software only, so we use the Lesser General Public License.
-
-  In other cases, permission to use a particular library in non-free
-programs enables a greater number of people to use a large body of
-free software.  For example, permission to use the GNU C Library in
-non-free programs enables many more people to use the whole GNU
-operating system, as well as its variant, the GNU/Linux operating
-system.
-
-  Although the Lesser General Public License is Less protective of the
-users' freedom, it does ensure that the user of a program that is
-linked with the Library has the freedom and the wherewithal to run
-that program using a modified version of the Library.
-
-  The precise terms and conditions for copying, distribution and
-modification follow.  Pay close attention to the difference between a
-"work based on the library" and a "work that uses the library".  The
-former contains code derived from the library, whereas the latter must
-be combined with the library in order to run.
-
-		  GNU LESSER GENERAL PUBLIC LICENSE
-   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
-
-  0. This License Agreement applies to any software library or other
-program which contains a notice placed by the copyright holder or
-other authorized party saying it may be distributed under the terms of
-this Lesser General Public License (also called "this License").
-Each licensee is addressed as "you".
-
-  A "library" means a collection of software functions and/or data
-prepared so as to be conveniently linked with application programs
-(which use some of those functions and data) to form executables.
-
-  The "Library", below, refers to any such software library or work
-which has been distributed under these terms.  A "work based on the
-Library" means either the Library or any derivative work under
-copyright law: that is to say, a work containing the Library or a
-portion of it, either verbatim or with modifications and/or translated
-straightforwardly into another language.  (Hereinafter, translation is
-included without limitation in the term "modification".)
-
-  "Source code" for a work means the preferred form of the work for
-making modifications to it.  For a library, complete source code means
-all the source code for all modules it contains, plus any associated
-interface definition files, plus the scripts used to control compilation
-and installation of the library.
-
-  Activities other than copying, distribution and modification are not
-covered by this License; they are outside its scope.  The act of
-running a program using the Library is not restricted, and output from
-such a program is covered only if its contents constitute a work based
-on the Library (independent of the use of the Library in a tool for
-writing it).  Whether that is true depends on what the Library does
-and what the program that uses the Library does.
-  
-  1. You may copy and distribute verbatim copies of the Library's
-complete source code as you receive it, in any medium, provided that
-you conspicuously and appropriately publish on each copy an
-appropriate copyright notice and disclaimer of warranty; keep intact
-all the notices that refer to this License and to the absence of any
-warranty; and distribute a copy of this License along with the
-Library.
-
-  You may charge a fee for the physical act of transferring a copy,
-and you may at your option offer warranty protection in exchange for a
-fee.
-
-  2. You may modify your copy or copies of the Library or any portion
-of it, thus forming a work based on the Library, and copy and
-distribute such modifications or work under the terms of Section 1
-above, provided that you also meet all of these conditions:
-
-    a) The modified work must itself be a software library.
-
-    b) You must cause the files modified to carry prominent notices
-    stating that you changed the files and the date of any change.
-
-    c) You must cause the whole of the work to be licensed at no
-    charge to all third parties under the terms of this License.
-
-    d) If a facility in the modified Library refers to a function or a
-    table of data to be supplied by an application program that uses
-    the facility, other than as an argument passed when the facility
-    is invoked, then you must make a good faith effort to ensure that,
-    in the event an application does not supply such function or
-    table, the facility still operates, and performs whatever part of
-    its purpose remains meaningful.
-
-    (For example, a function in a library to compute square roots has
-    a purpose that is entirely well-defined independent of the
-    application.  Therefore, Subsection 2d requires that any
-    application-supplied function or table used by this function must
-    be optional: if the application does not supply it, the square
-    root function must still compute square roots.)
-
-These requirements apply to the modified work as a whole.  If
-identifiable sections of that work are not derived from the Library,
-and can be reasonably considered independent and separate works in
-themselves, then this License, and its terms, do not apply to those
-sections when you distribute them as separate works.  But when you
-distribute the same sections as part of a whole which is a work based
-on the Library, the distribution of the whole must be on the terms of
-this License, whose permissions for other licensees extend to the
-entire whole, and thus to each and every part regardless of who wrote
-it.
-
-Thus, it is not the intent of this section to claim rights or contest
-your rights to work written entirely by you; rather, the intent is to
-exercise the right to control the distribution of derivative or
-collective works based on the Library.
-
-In addition, mere aggregation of another work not based on the Library
-with the Library (or with a work based on the Library) on a volume of
-a storage or distribution medium does not bring the other work under
-the scope of this License.
-
-  3. You may opt to apply the terms of the ordinary GNU General Public
-License instead of this License to a given copy of the Library.  To do
-this, you must alter all the notices that refer to this License, so
-that they refer to the ordinary GNU General Public License, version 2,
-instead of to this License.  (If a newer version than version 2 of the
-ordinary GNU General Public License has appeared, then you can specify
-that version instead if you wish.)  Do not make any other change in
-these notices.
-
-  Once this change is made in a given copy, it is irreversible for
-that copy, so the ordinary GNU General Public License applies to all
-subsequent copies and derivative works made from that copy.
-
-  This option is useful when you wish to copy part of the code of
-the Library into a program that is not a library.
-
-  4. You may copy and distribute the Library (or a portion or
-derivative of it, under Section 2) in object code or executable form
-under the terms of Sections 1 and 2 above provided that you accompany
-it with the complete corresponding machine-readable source code, which
-must be distributed under the terms of Sections 1 and 2 above on a
-medium customarily used for software interchange.
-
-  If distribution of object code is made by offering access to copy
-from a designated place, then offering equivalent access to copy the
-source code from the same place satisfies the requirement to
-distribute the source code, even though third parties are not
-compelled to copy the source along with the object code.
-
-  5. A program that contains no derivative of any portion of the
-Library, but is designed to work with the Library by being compiled or
-linked with it, is called a "work that uses the Library".  Such a
-work, in isolation, is not a derivative work of the Library, and
-therefore falls outside the scope of this License.
-
-  However, linking a "work that uses the Library" with the Library
-creates an executable that is a derivative of the Library (because it
-contains portions of the Library), rather than a "work that uses the
-library".  The executable is therefore covered by this License.
-Section 6 states terms for distribution of such executables.
-
-  When a "work that uses the Library" uses material from a header file
-that is part of the Library, the object code for the work may be a
-derivative work of the Library even though the source code is not.
-Whether this is true is especially significant if the work can be
-linked without the Library, or if the work is itself a library.  The
-threshold for this to be true is not precisely defined by law.
-
-  If such an object file uses only numerical parameters, data
-structure layouts and accessors, and small macros and small inline
-functions (ten lines or less in length), then the use of the object
-file is unrestricted, regardless of whether it is legally a derivative
-work.  (Executables containing this object code plus portions of the
-Library will still fall under Section 6.)
-
-  Otherwise, if the work is a derivative of the Library, you may
-distribute the object code for the work under the terms of Section 6.
-Any executables containing that work also fall under Section 6,
-whether or not they are linked directly with the Library itself.
-
-  6. As an exception to the Sections above, you may also combine or
-link a "work that uses the Library" with the Library to produce a
-work containing portions of the Library, and distribute that work
-under terms of your choice, provided that the terms permit
-modification of the work for the customer's own use and reverse
-engineering for debugging such modifications.
-
-  You must give prominent notice with each copy of the work that the
-Library is used in it and that the Library and its use are covered by
-this License.  You must supply a copy of this License.  If the work
-during execution displays copyright notices, you must include the
-copyright notice for the Library among them, as well as a reference
-directing the user to the copy of this License.  Also, you must do one
-of these things:
-
-    a) Accompany the work with the complete corresponding
-    machine-readable source code for the Library including whatever
-    changes were used in the work (which must be distributed under
-    Sections 1 and 2 above); and, if the work is an executable linked
-    with the Library, with the complete machine-readable "work that
-    uses the Library", as object code and/or source code, so that the
-    user can modify the Library and then relink to produce a modified
-    executable containing the modified Library.  (It is understood
-    that the user who changes the contents of definitions files in the
-    Library will not necessarily be able to recompile the application
-    to use the modified definitions.)
-
-    b) Use a suitable shared library mechanism for linking with the
-    Library.  A suitable mechanism is one that (1) uses at run time a
-    copy of the library already present on the user's computer system,
-    rather than copying library functions into the executable, and (2)
-    will operate properly with a modified version of the library, if
-    the user installs one, as long as the modified version is
-    interface-compatible with the version that the work was made with.
-
-    c) Accompany the work with a written offer, valid for at
-    least three years, to give the same user the materials
-    specified in Subsection 6a, above, for a charge no more
-    than the cost of performing this distribution.
-
-    d) If distribution of the work is made by offering access to copy
-    from a designated place, offer equivalent access to copy the above
-    specified materials from the same place.
-
-    e) Verify that the user has already received a copy of these
-    materials or that you have already sent this user a copy.
-
-  For an executable, the required form of the "work that uses the
-Library" must include any data and utility programs needed for
-reproducing the executable from it.  However, as a special exception,
-the materials to be distributed need not include anything that is
-normally distributed (in either source or binary form) with the major
-components (compiler, kernel, and so on) of the operating system on
-which the executable runs, unless that component itself accompanies
-the executable.
-
-  It may happen that this requirement contradicts the license
-restrictions of other proprietary libraries that do not normally
-accompany the operating system.  Such a contradiction means you cannot
-use both them and the Library together in an executable that you
-distribute.
-
-  7. You may place library facilities that are a work based on the
-Library side-by-side in a single library together with other library
-facilities not covered by this License, and distribute such a combined
-library, provided that the separate distribution of the work based on
-the Library and of the other library facilities is otherwise
-permitted, and provided that you do these two things:
-
-    a) Accompany the combined library with a copy of the same work
-    based on the Library, uncombined with any other library
-    facilities.  This must be distributed under the terms of the
-    Sections above.
-
-    b) Give prominent notice with the combined library of the fact
-    that part of it is a work based on the Library, and explaining
-    where to find the accompanying uncombined form of the same work.
-
-  8. You may not copy, modify, sublicense, link with, or distribute
-the Library except as expressly provided under this License.  Any
-attempt otherwise to copy, modify, sublicense, link with, or
-distribute the Library is void, and will automatically terminate your
-rights under this License.  However, parties who have received copies,
-or rights, from you under this License will not have their licenses
-terminated so long as such parties remain in full compliance.
-
-  9. You are not required to accept this License, since you have not
-signed it.  However, nothing else grants you permission to modify or
-distribute the Library or its derivative works.  These actions are
-prohibited by law if you do not accept this License.  Therefore, by
-modifying or distributing the Library (or any work based on the
-Library), you indicate your acceptance of this License to do so, and
-all its terms and conditions for copying, distributing or modifying
-the Library or works based on it.
-
-  10. Each time you redistribute the Library (or any work based on the
-Library), the recipient automatically receives a license from the
-original licensor to copy, distribute, link with or modify the Library
-subject to these terms and conditions.  You may not impose any further
-restrictions on the recipients' exercise of the rights granted herein.
-You are not responsible for enforcing compliance by third parties with
-this License.
-
-  11. If, as a consequence of a court judgment or allegation of patent
-infringement or for any other reason (not limited to patent issues),
-conditions are imposed on you (whether by court order, agreement or
-otherwise) that contradict the conditions of this License, they do not
-excuse you from the conditions of this License.  If you cannot
-distribute so as to satisfy simultaneously your obligations under this
-License and any other pertinent obligations, then as a consequence you
-may not distribute the Library at all.  For example, if a patent
-license would not permit royalty-free redistribution of the Library by
-all those who receive copies directly or indirectly through you, then
-the only way you could satisfy both it and this License would be to
-refrain entirely from distribution of the Library.
-
-If any portion of this section is held invalid or unenforceable under any
-particular circumstance, the balance of the section is intended to apply,
-and the section as a whole is intended to apply in other circumstances.
-
-It is not the purpose of this section to induce you to infringe any
-patents or other property right claims or to contest validity of any
-such claims; this section has the sole purpose of protecting the
-integrity of the free software distribution system which is
-implemented by public license practices.  Many people have made
-generous contributions to the wide range of software distributed
-through that system in reliance on consistent application of that
-system; it is up to the author/donor to decide if he or she is willing
-to distribute software through any other system and a licensee cannot
-impose that choice.
-
-This section is intended to make thoroughly clear what is believed to
-be a consequence of the rest of this License.
-
-  12. If the distribution and/or use of the Library is restricted in
-certain countries either by patents or by copyrighted interfaces, the
-original copyright holder who places the Library under this License may add
-an explicit geographical distribution limitation excluding those countries,
-so that distribution is permitted only in or among countries not thus
-excluded.  In such case, this License incorporates the limitation as if
-written in the body of this License.
-
-  13. The Free Software Foundation may publish revised and/or new
-versions of the Lesser General Public License from time to time.
-Such new versions will be similar in spirit to the present version,
-but may differ in detail to address new problems or concerns.
-
-Each version is given a distinguishing version number.  If the Library
-specifies a version number of this License which applies to it and
-"any later version", you have the option of following the terms and
-conditions either of that version or of any later version published by
-the Free Software Foundation.  If the Library does not specify a
-license version number, you may choose any version ever published by
-the Free Software Foundation.
-
-  14. If you wish to incorporate parts of the Library into other free
-programs whose distribution conditions are incompatible with these,
-write to the author to ask for permission.  For software which is
-copyrighted by the Free Software Foundation, write to the Free
-Software Foundation; we sometimes make exceptions for this.  Our
-decision will be guided by the two goals of preserving the free status
-of all derivatives of our free software and of promoting the sharing
-and reuse of software generally.
-
-			    NO WARRANTY
-
-  15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
-WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
-EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
-OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
-KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
-PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
-LIBRARY IS WITH YOU.  SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
-THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
-
-  16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
-WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
-AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
-FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
-CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
-LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
-RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
-FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
-SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
-DAMAGES.
-
-		     END OF TERMS AND CONDITIONS
-
-           How to Apply These Terms to Your New Libraries
-
-  If you develop a new library, and you want it to be of the greatest
-possible use to the public, we recommend making it free software that
-everyone can redistribute and change.  You can do so by permitting
-redistribution under these terms (or, alternatively, under the terms of the
-ordinary General Public License).
-
-  To apply these terms, attach the following notices to the library.  It is
-safest to attach them to the start of each source file to most effectively
-convey the exclusion of warranty; and each file should have at least the
-"copyright" line and a pointer to where the full notice is found.
-
-    <one line to give the library's name and a brief idea of what it does.>
-    Copyright (C) <year>  <name of author>
-
-    This library is free software; you can redistribute it and/or
-    modify it under the terms of the GNU Lesser General Public
-    License as published by the Free Software Foundation; either
-    version 2.1 of the License, or (at your option) any later version.
-
-    This library is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-    Lesser General Public License for more details.
-
-    You should have received a copy of the GNU Lesser General Public
-    License along with this library; if not, write to the Free Software
-    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
-
-Also add information on how to contact you by electronic and paper mail.
-
-You should also get your employer (if you work as a programmer) or your
-school, if any, to sign a "copyright disclaimer" for the library, if
-necessary.  Here is a sample; alter the names:
-
-  Yoyodyne, Inc., hereby disclaims all copyright interest in the
-  library `Frob' (a library for tweaking knobs) written by James Random Hacker.
-
-  <signature of Ty Coon>, 1 April 1990
-  Ty Coon, President of Vice
-
-That's all there is to it!

ocrmypdf/jhove/LICENSE

@@ -1,17 +0,0 @@
-JHOVE - JSTOR/Harvard Object Validation Environment
-Copyright 2003-2008 by JSTOR and the President and Fellows of Harvard College
-
-This program is free software; you can redistribute it and/or modify
-it under the terms of the GNU Lessor General Public License as
-published by the Free Software Foundation; either version 2.1 of the
-License, or (at your option) any later version.
-
-This program is distributed in the hope that it will be useful, but
-WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-Lesser General Public License for more details.
-
-You should have received a copy of the GNU Lesser General Public
-License along with this program; if not, write to the Free Software
-Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
-USA

ocrmypdf/jhove/README

@@ -1,227 +0,0 @@
-JHOVE - JSTOR/Harvard Object Validation Environment
-Copyright 2003-2012 by JSTOR and the President and Fellows of Harvard College
-JHOVE is made available under the GNU Lesser General Public License (LGPL;
-see the file LICENSE for details)
-
-Rev. 1.11, 2013-09-29
-
-JHOVE (the JSTOR/Harvard Object Validation Environment, pronounced "jhove")
-is an extensible software framework for performing format identification,
-validation, and characterization of digital objects.
-
-o Format identification is the process of determining the format to which a
-  digital object conforms: "I have a digital object; what format is it?"
-o Format validation is the process of determining the level of compliance of a
-  digital object to the specification for its purported format: "I have an
-  object purportedly of format F; is it?"
-o Format characterization is the process of determing the format-specific
-  significant properties of an object of a given format: "I have an object of
-  format F; what are its salient properties?"
-
-These actions are frequently necessary during routine operation of digital
-repositories and for digital preservation activities.
-
-The output from JHOVE is controlled by output handlers. JHOVE uses an
-extensible plug-in architecture; it can be configured at the time of its
-invocation to include whatever specific format modules and output handlers
-that are desired. The initial release of JHOVE includes modules for
-arbitrary byte streams, ASCII and UTF-8 encoded text, AIFF and WAVE audio,
-GIF, JPEG, JPEG 2000, TIFF, and PDF; and text and XML output handlers.
-
-The JHOVE project is a collaboration of JSTOR and the Harvard University
-Library.  Development of JHOVE was funded in part by the Andrew W. Mellon
-Foundation.  JHOVE is made available under the GNU Lesser General Public
-License (LGPL; see the file LICENSE for details).
-
-JHOVE is currently being maintained by indpendent developers.
-
-REQUIREMENTS
-
-1. Java J2SE 1.5
-(JHOVE was originally implemented using the Sun J2SE SDK 1.4.1 and has
-been tested to work with 1.5)
-
-2. If you would like to compile the JHOVE source code, then
-Apache Ant, a Java-based build tool <http://ant.apache.org/> is necessary.
-Note that the JAVA_HOME environment variable must be set appropriately for
-Ant to work properly.
-(JHOVE was implemented and tested using Ant 1.5.1.)
-
-DISTRIBUTION
-
-The JHOVE distribution package includes:
-
-    jhove/                                 # JHOVE home directory
-          COPYING                          # GNU Lesser General Public License
-          LICENSE                          # JHOVE license information
-          README
-          RELEASENOTES                     # JHOVE release notes
-          bin/
-                    jhove.jar              # JHOVE API package
-                    jhove-handler.jar      # Standard output handler package
-                    jhove-module.jar       # Standard module package
-                    JhoveApp.jar           # JHOVE command line application
-                    JhoveView.jar          # JHOVE with Swing GUI front-end
-          build.xml                        # Ant configuration file
-          classes/
-                    build.xml              # Ant configuration file
-                    edu/ ...               # JHOVE API packages
-                    ADump.*                # AIFF dump utility class
-                    GDump.*                # GIF dump utility class
-                    Jhove.*                # JHOVE main class
-                    JDump.*                # JPEG dump utility class
-                    J2Dump.*               # JPEG 2000 dump utility class
-                    PDump.*                # PDF dump utility class
-                    TDump.*                # TIFF dump utility class
-                    UserHome.*             # user.home property utility class
-                    WDump.*                # WAVE dump utility class
-          conf/
-                   jhove.conf              # JHOVE configuration file
-                   jhove.xsd               # JHOVE output schema
-                   jhoveConfig.xsd         # JHOVE configuration file schema
-          doc/
-                   *.html                  # API documentation
-                   ...
-          examples/                        # Sample files
-                   ascii/ ...
-                   gif/   ...
-                   jpeg/  ...
-                   jpeg2000/ ...
-                   pdf/   ...
-                   tiff/  ...
-                   utf-8/ ...
-          adump*                           # AIFF dump Bourne shell driver
-          adump.bat*                       # AIFF dump DOS shell driver script
-          gdump*                           # GIF dump Bourne shell driver
-          gdump.bat*                       # GIF dump DOS shell driver script
-          jdump*                           # JPEG dump Bourne shell driver
-          jdump.bat*                       # JPEG dump DOS shell driver script
-          j2dump*                          # JPEG 2000 dump Bourne shell driver
-          j2dump.bat*                      # JPEG 2000 dump DOS shell driver
-          jhove.tmpl*                      # Template for JHOVE Bourne shell driver script
-          jhove_bat.tmpl*                  # Template for JHOVE DOS shell driver script
-          pdump*                           # PDF dump Bourne shell driver
-          pdump.bat*                       # PDF dump DOS shell driver script
-          tdump*                           # TIFF dump Bourne shell driver
-          tdump.bat*                       # TIFF dump DOS shell driver script
-          userhome*                        # user.home Bourne shell driver
-          userhome.bat*                    # user.home DOS shell driver script
-          wdump*                           # WAVE dump Bourne shell driver
-          wdump.bat*                       # WAVE dump DOS shell driver script
-
-INSTALLATION
-
-Edit the configuration file, jhove/conf/jhove.conf, and set the absolute
-pathname of the JHOVE home directory and the temporary directory (in which
-temporary files are created):
-
-    <jhoveHome>jhove-home-directory</jhoveHome>
-    <tempDirectory>temporary-directory</tempDirectory>
-
-The JHOVE home directory is the top-most directory in the distribution TAR
-or ZIP file.  On Unix systems, "/var/tmp" is an appropriate temporary
-directory; on Windows, "C:\Temp".  For example, if the distribution TAR
-file is disaggregated on a Unix system in the directory "/users/stephen/
-projects", then the configuration file should read:
-
-    <jhoveHome>/users/stephen/projects/jhove</jhoveHome>
-    <tempDirectory>/var/tmp</jhoveHome>
-
-In the JHOVE home directory, copy the JHOVE Bourne shell driver script
-template, "jhove.tmpl", to "jhove" (or the equivalent Windows shell 
-script, "jhove_bat.tmpl" to "jhove.bat"), and set the
-JHOVE home directory, Java home directory, and Java interpreter:
-
-    JHOVE_HOME=jhove-home-directory
-    JAVA_HOME=java-home-directory
-    JAVA=java-interpreter
-
-The JAVA_HOME property should provide the absolute pathname of the Java
-runtime or SDK installation; JAVA should provide the absolute pathname of the
-Java interpreter.  For example:
-
-    JHOVE_HOME=/users/stephen/projects/jhove
-    JAVA_HOME=/usr/local/j2re1.4.1_02
-    JAVA=$JAVA_HOME/bin/java
-
-In the DOS shell driver script, jhove.bat, the equivalent three
-variables are:
-
-    SET JHOVE_HOME=jhove-home-directory
-    SET JAVA_HOME=java-home-directory
-    SET JAVA=%JAVA_HOME%\bin\java
-
-For example:
-
-    SET JHOVE_HOME="C:\Program Files\jhove"
-    SET JAVA_HOME="C:\Program Files\java\j2re1.4.1_02"
-    SET JAVA=%JAVA_HOME%\bin\java
-
-The quotation marks are necessary because of the embedded space characters.
-On Windows platforms it may also be necessary to add the Java bin subdirectory
-to the System PATH environment variable:
-
-    PATH=C:\Program Files\java\j2re1.4.1_02\bin;...
-
-(For information on setting a Windows environment variable, consult your local
-documentation or system administrator.)
-
-USAGE
-
-    java Jhove [-c config] [-m module] [-h handler] [-e encoding] [-H handler]
-               [-o output] [-x saxclass] [-t tempdir] [-b bufsize]
-               [-l loglevel] [[-krs] dir-file-or-uri [...]]
-
-where -c config   Configuration file pathname
-      -m module   Module name
-      -h handler  Output handler name (defaults to TEXT)
-      -e encoding Character encoding used by output handler (defaults to UTF-8)
-      -H handler  About handler name
-      -o output   Output file pathname (defaults to standard output)
-      -x saxclass SAX parser class (defaults to J2SE default)
-      -t tempdir  Temporary directory in which to create temporary files
-      -b bufsize  Buffer size for buffered I/O (defaults to J2SE 1.4 default)
-      -l loglevel Logging level
-      -k          Calculate CRC32, MD5, and SHA-1 checksums
-      -r          Display raw data flags, not textual equivalents
-      -s          Format identification based on internal signatures only
-      dir-file-or-uri Directory or file pathname or URI of formated content
-                      stream
-
-All named modules and output handlers must be found on the Java CLASSPATH at
-the time of invocation.  The JHOVE driver script, jhove/jhove, automatically
-sets the CLASSPATH and invokes the Jhove main class:
-
-    jhove [-c config] [-m module] [-h handler] [-e encoding] [-H handler]
-          [-o output] [-x saxclass] [-t tempdir] [-b bufsize] [-l loglevel]
-          [[-krs] dir-file-or-uri [...]]
-
-The following additional programs are available, primarily for testing
-and debugging purposes.  They display a minimally processed, human-readable
-version of the contents of AIFF, GIF, JPEG, JPEG 2000, PDF, TIFF, and WAVE
-files:
-
-    java ADump  aiff-file
-    java GDump  gif-file
-    java JDump  jpeg-file
-    java J2Dump jpeg2000-file
-    java PDump  pdf-file
-    java TDump  tiff-file
-    java WDump  wave-file
-
-For convenience, the following driver scripts are also available:
-
-    adump  aiff-file
-    gdump  gif-file
-    jdump  jpeg-file
-    j2dump jpeg2000-file
-    pdump  pdf-file
-    tdump  tiff-file
-    wdump  wave-file
-
-The JHOVE Swing-based GUI interface can be invoked from a command shell from
-the jhove/bin sub-directory:
-
-    java -jar JhoveView.jar -c <configFile>
-
-where <configFile> is the pathname of the JHOVE configuration file.

ocrmypdf/jhove/bin/README

@@ -1,25 +0,0 @@
-JHOVE - JSTOR/Harvard Object Validation Environment
-Copyright 2003 by JSTOR and the President and Fellows of Harvard College
-JHOVE is made available under the GNU General Public License (see the file
-LICENSE for details)
-
-Rev. 2003-11-25
-
-The following jar files are meant to be used for embedding JHOVE functionality
-into new applications or systems.
-
-  jhove.jar          Contains the JHOVE API interfaces and classes
-  jhove-module.jar   Contains the standard JHOVE modules ()
-  jhove-handler.jar  Contains the standard JHOVE output handlers (TEXT and XML)
-
-The following jar file is meant to be used with the stand-alone JHOVE
-application using a command-line interface.  It contains the main Jhove class
-and the contents of jhove.jar, jhove-module.jar, and jhove-handler.jar.
-
-  JhoveApp.jar
-
-The following jar file is meant to be used with the stand-alone JHOVE
-application using a Swing GUI interface.  It contains the main JhoveView class
-and the contents of jhove.jar, jhove-module.jar, and jhove-handler.jar.
-
-  JhoveView.jar

ocrmypdf/jhove/build.xml

@@ -1,78 +0,0 @@
-<project name="Jhove" default="dist" basedir=".">
-  <description>Project build file
-    Jhove - JSTOR/Harvard Object Validation Environment
-    Version 1.0 2004-09-10
-    Copyright 2004 by JSTOR and the President and Fellows of Harvard College
-  </description>
-
-  <!-- ant (or ant dist) Build everything
-       ant debug         Build everything with debug enabled
-       ant clean         Delete backup files
-       ant cleanclass    Delete backup and class files
-       ant cleandist     Delete backup, class, and jar files
-       ant javadoc       Build javadocs
-    -->
-
-  <!-- set global properties for this build -->
-  <property name="bin"     location="bin"/>
-  <property name="classes" location="classes"/>
-  <property name="doc"     location="doc"/>
-
-  <target name="dist" description="Create distribution">
-    <ant dir="${classes}" inheritAll="false">
-      <property name="dbg" value="off"/>
-    </ant>
-  	<chmod file="jhove" perm="ugo+x"/>
-  	<chmod file="${bin}/JhoveView.jar" perm="ugo+x"/>
-  </target>
-
-  <target name="debug" description="Create distribution with debug enabled">
-    <ant dir="${classes}" inheritAll="false">
-      <property name="dbg" value="on"/>
-    </ant>
-  </target>
-
-  <target name="view" description="Create JhoveView application">
-    <ant dir="${classes}" target="view" inheritAll="false">
-      <property name="dbs" value="on"/>
-    </ant>
-  </target>
-
-  <target name="clean" description="Delete backup files">
-    <ant dir="${classes}" target="main-clean" inheritAll="false"/>
-  </target>
-
-  <target name="cleanclass" depends="clean">
-    <ant dir="${classes}" target="main-cleanclass" inheritAll="false"/>
-  </target>
-
-  <target name="cleandist" depends="cleanclass">
-    <delete file="${bin}/jhove.jar"/>
-    <delete file="${bin}/jhove-handler.jar"/>
-    <delete file="${bin}/jhove-module.jar"/>
-    <delete file="${bin}/JhoveApp.jar"/>
-    <delete file="${bin}/JhoveView.jar"/>
-  </target>
-
-  <target name="javadoc">
-    <javadoc sourcepath="${classes}" destdir="${doc}"
-             windowtitle="JHOVE Documentation"
-             Overview="${classes}/overview.html">
-      <package name="edu.harvard.hul.ois.jhove"/>
-      <package name="edu.harvard.hul.ois.jhove.handler"/>
-      <package name="edu.harvard.hul.ois.jhove.handler.audit"/>
-      <package name="edu.harvard.hul.ois.jhove.module"/>
-      <package name="edu.harvard.hul.ois.jhove.module.aiff"/>
-      <package name="edu.harvard.hul.ois.jhove.module.gif"/>
-      <package name="edu.harvard.hul.ois.jhove.module.html"/>
-      <package name="edu.harvard.hul.ois.jhove.module.iff"/>
-      <package name="edu.harvard.hul.ois.jhove.module.jpeg"/>
-      <package name="edu.harvard.hul.ois.jhove.module.jpeg2000"/>
-      <package name="edu.harvard.hul.ois.jhove.module.pdf"/>
-      <package name="edu.harvard.hul.ois.jhove.module.tiff"/>
-      <package name="edu.harvard.hul.ois.jhove.module.wave"/>
-      <package name="edu.harvard.hul.ois.jhove.module.xml"/>
-      <package name="edu.harvard.hul.ois.jhove.viewer"/>
-    </javadoc>
-  </target>
-</project>

ocrmypdf/jhove/conf/README

@@ -1,63 +0,0 @@
-JHOVE - JSTOR/Harvard Object Validation Environment
-Copyright 2003-2007 by JSTOR and the President and Fellows of Harvard College
-JHOVE is made available under the GNU General Public License (see the file
-LICENSE for details)
-
-Rev. 2007-08-30
-
-Edit the configuration file, jhove.conf, and set the JHOVE home
-directory:
-
-    <jhoveHome>jhove-home-directory</jhoveHome>
-
-and temporary directory:
-
-    <tempDirectory>temporary-directory</tempDirectory>
-
-On most Unix systems, a reasonable temporary directory is "/var/tmp";
-on Windows, "C:\temp".
-
-The optional
-
-    <bufferSize>buffer-size</bufferSize>
-
-element defines the buffer size used for buffer I/O operations.
-
-The optional
-
-    <mixVersion>1.0</mixVersion>
-
-element specifies that the XML output handler should conform to the
-MIX 1.0 schema.  The default behavior is for handler output to conform
-to the MIX 0.2 schema.
-
-The optional
-
-    <sigBytes>n</sigBytes>
-
-element specifies that JHOVE modules will look for format signatures
-in the first <n> bytes of the file.  The default value is 1024.
-
-All class names must be fully qualified with their package name:
-
-    <module>
-      <class>fully-package-qualified-class-name</class>
-      <init>optional-initialization-argument</init>
-      <param>optional-invocation-argument</param>
-    </module>
-
-The optional <init> argument is passed to the module once at the time
-its class is instantiated.  See module-specific documentation for a
-description of any initialization options.
-
-The optional <param> argument is passed to the module every time it is
-invoked.  See module-specific documentation for a description of any
-invocation options.
-
-The order in which format modules are defined is important; when
-performing a format identification operation, JHOVE will search for a
-matching module in the order in which the modules are defined in the
-configuration file. In general, the modules for more generic formats
-should come later in the list. For example, the standard module ASCII
-should be defined before the UTF-8 module, since all ASCII objects
-are, by definition, UTF-8 objects, but not vice versa.

ocrmypdf/jhove/conf/jhove-byteoffset=true.conf

@@ -1,47 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<jhoveConfig version="1.0"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xmlns="http://hul.harvard.edu/ois/xml/ns/jhove/jhoveConfig"
- xsi:schemaLocation="http://hul.harvard.edu/ois/xml/ns/jhove/jhoveConfig
-                     http://hul.harvard.edu/ois/xml/xsd/jhove/1.6/jhoveConfig.xsd">
- <jhoveHome>/users/stephen/projects/jhove</jhoveHome>
- <defaultEncoding>utf-8</defaultEncoding>
- <tempDirectory>/var/tmp</tempDirectory>
- <bufferSize>131072</bufferSize>
- <mixVersion>1.0</mixVersion>
- <sigBytes>1024</sigBytes>
- <module>
-  <class>edu.harvard.hul.ois.jhove.module.AiffModule</class>
- </module>
- <module>
-  <class>edu.harvard.hul.ois.jhove.module.WaveModule</class>
- </module>
- <module>
-  <class>edu.harvard.hul.ois.jhove.module.PdfModule</class>
- </module>
- <module>
-  <class>edu.harvard.hul.ois.jhove.module.Jpeg2000Module</class>
- </module>
- <module>
-  <class>edu.harvard.hul.ois.jhove.module.JpegModule</class>
- </module>
- <module>
-  <class>edu.harvard.hul.ois.jhove.module.GifModule</class>
- </module>
- <module>
-  <class>edu.harvard.hul.ois.jhove.module.TiffModule</class>
-  <param>byteoffset=true</param>
- </module>
- <module>
-  <class>edu.harvard.hul.ois.jhove.module.XmlModule</class>
- </module>
- <module>
-  <class>edu.harvard.hul.ois.jhove.module.HtmlModule</class>
- </module>
- <module>
-  <class>edu.harvard.hul.ois.jhove.module.AsciiModule</class>
- </module>
- <module>
-  <class>edu.harvard.hul.ois.jhove.module.Utf8Module</class>
- </module>
-</jhoveConfig>

ocrmypdf/jhove/conf/jhove-withTextMD.conf

@@ -1,51 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<jhoveConfig version="1.0"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xmlns="http://hul.harvard.edu/ois/xml/ns/jhove/jhoveConfig"
- xsi:schemaLocation="http://hul.harvard.edu/ois/xml/ns/jhove/jhoveConfig
-                     http://hul.harvard.edu/ois/xml/xsd/jhove/1.6/jhoveConfig.xsd">
- <jhoveHome>/users/stephen/projects/jhove</jhoveHome>
- <defaultEncoding>utf-8</defaultEncoding>
- <tempDirectory>/var/tmp</tempDirectory>
- <bufferSize>131072</bufferSize>
- <mixVersion>1.0</mixVersion>
- <sigBytes>1024</sigBytes>
- <module>
-  <class>edu.harvard.hul.ois.jhove.module.AiffModule</class>
- </module>
- <module>
-  <class>edu.harvard.hul.ois.jhove.module.WaveModule</class>
- </module>
- <module>
-  <class>edu.harvard.hul.ois.jhove.module.PdfModule</class>
- </module>
- <module>
-  <class>edu.harvard.hul.ois.jhove.module.Jpeg2000Module</class>
- </module>
- <module>
-  <class>edu.harvard.hul.ois.jhove.module.JpegModule</class>
- </module>
- <module>
-  <class>edu.harvard.hul.ois.jhove.module.GifModule</class>
- </module>
- <module>
-  <class>edu.harvard.hul.ois.jhove.module.TiffModule</class>
-  <param>byteoffset=true</param>
- </module>
- <module>
-  <class>edu.harvard.hul.ois.jhove.module.XmlModule</class>
-  <param>withTextMD=true</param>
- </module>
- <module>
-  <class>edu.harvard.hul.ois.jhove.module.HtmlModule</class>
-  <param>withTextMD=true</param>
- </module>
- <module>
-  <class>edu.harvard.hul.ois.jhove.module.AsciiModule</class>
-  <param>withTextMD=true</param>
- </module>
- <module>
-  <class>edu.harvard.hul.ois.jhove.module.Utf8Module</class>
-  <param>withTextMD=true</param>
- </module>
-</jhoveConfig>

ocrmypdf/jhove/conf/jhove.conf

@@ -1,45 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<jhoveConfig version="1.0"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xmlns="http://hul.harvard.edu/ois/xml/ns/jhove/jhoveConfig"
- xsi:schemaLocation="http://hul.harvard.edu/ois/xml/ns/jhove/jhoveConfig
-                     http://hul.harvard.edu/ois/xml/xsd/jhove/1.6/jhoveConfig.xsd">
- <jhoveHome>./jhove/</jhoveHome>
- <defaultEncoding>utf-8</defaultEncoding>
- <tempDirectory>/var/tmp</tempDirectory>
- <bufferSize>131072</bufferSize>
- <module>
-  <class>edu.harvard.hul.ois.jhove.module.AiffModule</class>
- </module>
- <module>
-  <class>edu.harvard.hul.ois.jhove.module.WaveModule</class>
- </module>
- <module>
-  <class>edu.harvard.hul.ois.jhove.module.PdfModule</class>
- </module>
- <module>
-  <class>edu.harvard.hul.ois.jhove.module.Jpeg2000Module</class>
- </module>
- <module>
-  <class>edu.harvard.hul.ois.jhove.module.JpegModule</class>
- </module>
- <module>
-  <class>edu.harvard.hul.ois.jhove.module.GifModule</class>
- </module>
- <module>
-  <class>edu.harvard.hul.ois.jhove.module.TiffModule</class>
- </module>
- <module>
-  <class>edu.harvard.hul.ois.jhove.module.XmlModule</class>
-  <param>schema=http://www.example.com/schema;/home/schemas/exampleschema.xsd</param>
- </module>
- <module>
-  <class>edu.harvard.hul.ois.jhove.module.HtmlModule</class>
- </module>
- <module>
-  <class>edu.harvard.hul.ois.jhove.module.AsciiModule</class>
- </module>
- <module>
-  <class>edu.harvard.hul.ois.jhove.module.Utf8Module</class>
- </module>
-</jhoveConfig>

ocrmypdf/jhove/configure.pl

@@ -1,88 +0,0 @@
-#!/usr/bin/perl
-
-########################################################################
-# Jhove - JSTOR/Harvard Object Validation Environment
-# Copyright 2004 by JSTOR and the President and Fellows of Harvard College
-#
-# A Perl script for plugging local path information into the
-# various script files of JHOVE, as well as conf/jhove.conf.
-#
-# This is configured only for Unix (including OS X).
-#
-#    Usage: configure.pl jhove_home_directory [java_home_directory [java_runtime_directory]]
-#
-#    If invoked with no arguments, it will output a usage message.
-#
-########################################################################
-use File::Copy;
-
-sub mung {
-    my $f = $_[0];
-    my $bak = $f . "~";
-    #If there is no backup file, copy the file to the
-    #backup.  Otherwise work from the backup.
-    if (!(-e $bak)) {
-        rename ($f, $bak);
-    }
-    open (INFILE, $bak);
-    open (OUTFILE, ">" . $f);
-
-    #Walks through each line of file, making substitutions.
-    #Remember that the JAVA_HOME and JAVA arguments are optional.
-    while (<INFILE>) {
-        s/^JHOVE_HOME=.*/JHOVE_HOME=$ARGV[0]/;
-        if ($narg >= 2) {
-            s/^JAVA_HOME=.*/JAVA_HOME=$ARGV[1]/;
-        }
-        if ($narg >= 3) {
-            s/^JAVA=.*/JAVA=$ARGV[2]/;
-        }
-        print OUTFILE;
-    }
-    close (INFILE);
-    close (OUTFILE);
-    if (-e $f) {
-        print ("Fixed " . $f . "\n");
-    }
-}
-
-
-$narg = $#ARGV + 1;
-if ($narg <= 0) {
-    print "Usage: configure.pl jhove_home_directory [java_home_directory [java_runtime_directory]]\n";
-    exit;
-}
-print "JHOVE_HOME will be set to " . $ARGV[0] . "\n";
-if ($narg >= 2) {
-    print "JAVA_HOME will be set to " . $ARGV[1] . "\n";
-}
-if ($narg >= 3) {
-    print "JAVA will be set to " . $ARGV[2] . "\n";
-}
-mung ("jhove");
-mung ("adump");
-mung ("gdump");
-mung ("jdump");
-mung ("j2dump");
-mung ("pdump");
-mung ("tdump");
-mung ("wdump");
-
-#Fix up the config file.  We assume that the <jhoveHome>
-#element is all on one line.
-if (!(-e "conf/jhove.conf~")) {
-    rename ("conf/jhove.conf", "conf/jhove.conf~");
-}
-open (INFILE, "conf/jhove.conf~");
-open (OUTFILE, ">conf/jhove.conf");
-while (<INFILE>) {
-    s!<jhoveHome>.*</jhoveHome>!<jhoveHome>$ARGV[0]</jhoveHome>!;
-    print OUTFILE;
-}
-close (INFILE);
-close (OUTFILE);
-if (-e "conf/jhove.conf") {
-    print "Fixed conf/jhove.conf\n";
-}
-exit;
-

ocrmypdf/jhove/gdump

@@ -1,37 +0,0 @@
-#!/bin/sh
-
-########################################################################
-# gdump - JSTOR/Harvard Object Validation Environment
-# Copyright 2004-2005 by the President and Fellows of Harvard College
-# JHOVE is made available under the GNU General Public License (see the
-# file LICENSE for details)
-#
-# Driver script for the GIF dump utility
-#
-# Usage: gdump file
-#
-# where  file  is a GIF file
-#
-# Configuration constants:
-
-JHOVE_HOME=/users/stephen/projects/jhove
-
-JAVA_HOME=/usr/java      # Java JRE directory
-JAVA=$JAVA_HOME/bin/java # Java interpreter
-
-EXTRA_JARS=              # Extra .jar files to add to CLASSPATH
-
-# NOTE: Nothing below this line should be edited
-########################################################################
-
-CP=${JHOVE_HOME}/bin/JhoveApp.jar:${EXTRA_JARS}
-
-# Retrieve a copy of all command line arguments to pass to the application.
-
-ARGS=""
-for ARG do
-    ARGS="$ARGS $ARG"
-done
-
-# Set the CLASSPATH and invoke the Java loader.
-${JAVA} -classpath $CP GDump $ARGS

ocrmypdf/jhove/j2dump

@@ -1,37 +0,0 @@
-#!/bin/sh
-
-########################################################################
-# j2dump - JSTOR/Harvard Object Validation Environment
-# Copyright 2004-2005 by the President and Fellows of Harvard College
-# JHOVE is made available under the GNU General Public License (see the
-# file LICENSE for details)
-#
-# Driver script for the JPEG 2000 dump utility
-#
-# Usage: j2dump file
-#
-# where  file  is a JPEG file
-#
-# Configuration constants:
-
-JHOVE_HOME=/users/stephen/projects/jhove
-
-JAVA_HOME=/usr/java      # Java JRE directory
-JAVA=$JAVA_HOME/bin/java # Java interpreter
-
-EXTRA_JARS=              # Extra .jar files to add to CLASSPATH
-
-# NOTE: Nothing below this line should be edited
-########################################################################
-
-CP=${JHOVE_HOME}/bin/JhoveApp.jar:${EXTRA_JARS}
-
-# Retrieve a copy of all command line arguments to pass to the application.
-
-ARGS=""
-for ARG do
-    ARGS="$ARGS $ARG"
-done
-
-# Set the CLASSPATH and invoke the Java loader.
-${JAVA} -classpath $CP J2Dump $ARGS

ocrmypdf/jhove/jdump

@@ -1,37 +0,0 @@
-#!/bin/sh
-
-########################################################################
-# jdump - JSTOR/Harvard Object Validation Environment
-# Copyright 2004-2005 by the President and Fellows of Harvard College
-# JHOVE is made available under the GNU General Public License (see the
-# file LICENSE for details)
-#
-# Driver script for the JPEG dump utility
-#
-# Usage: jdump file
-#
-# where  file  is a JPEG file
-#
-# Configuration constants:
-
-JHOVE_HOME=/users/stephen/projects/jhove
-
-JAVA_HOME=/usr/java      # Java JRE directory
-JAVA=$JAVA_HOME/bin/java # Java interpreter
-
-EXTRA_JARS=              # Extra .jar files to add to CLASSPATH
-
-# NOTE: Nothing below this line should be edited
-########################################################################
-
-CP=${JHOVE_HOME}/bin/JhoveApp.jar:${EXTRA_JARS}
-
-# Retrieve a copy of all command line arguments to pass to the application.
-
-ARGS=""
-for ARG do
-    ARGS="$ARGS $ARG"
-done
-
-# Set the CLASSPATH and invoke the Java loader.
-${JAVA} -classpath $CP JDump $ARGS

ocrmypdf/jhove/jhove

@@ -1,58 +0,0 @@
-#!/bin/sh
-
-########################################################################
-# JHOVE - JSTOR/Harvard Object Validation Environment
-# Copyright 2003-2005 by JSTOR and the President and Fellows of Harvard College
-# JHOVE is made available under the GNU General Public License (see the
-# file LICENSE for details)
-#
-# Usage: jhove [-c config] [-m module] [-h handler] [-e encoding] [-H handler]
-#              [-o output] [-x saxclass] [-t tempdir] [-b bufsize]
-#              [-l loglevel] [[-krs] dir-file-or-uri [...]]
-#
-# where -c config   Configuration file pathname
-#       -m module   Module name
-#       -h handler  Output handler name (defaults to TEXT)
-#       -e encoding Character encoding of output handler (defaults to UTF-8)
-#       -H handler  About handler name
-#       -o output   Output file pathname (defaults to standard output)
-#       -x saxclass SAX parser class (defaults to J2SE 1.4 default)
-#       -t tempdir  Temporary directory in which to create temporary files
-#       -b bufsize  Buffer size for buffered I/O (defaults to J2SE 1.4 default)
-#       -k          Calculate CRC32, MD5, and SHA-1 checksums
-#       -r          Display raw data flags, not textual equivalents
-#       -s          Format identification based on internal signatures only
-#       dir-file-or-uri Directory, file pathname or URI of formatted content
-#
-# CHANGE for JHOVE 1.8:
-# You no longer have to figure out where JAVA_HOME is; that's the
-# operating system's job. If the OS tells you it can't find Java, 
-# adjust your shell's path or revert to the old way (commented out).
-# Configuration constants:
-
-#JHOVE_HOME=/users/gary/dev/jhove
-JHOVE_HOME=[fill in path to jhove directory]
-
-JAVA_HOME=/usr/java      # Java JRE directory -- change to your local java home
-JAVA=$JAVA_HOME/bin/java # Java interpreter -- usually won't need change
-
-#XTRA_JARS=/users/stephen/xercesImpl.jar
-EXTRA_JARS=              # Extra .jar files to add to CLASSPATH
-
-# NOTE: Nothing below this line should be edited
-########################################################################
-
-CP=${JHOVE_HOME}/bin/JhoveApp.jar:${EXTRA_JARS}
-
-# Retrieve a copy of all command line arguments to pass to the application.
-
-ARGS=""
-for ARG do
-    ARGS="$ARGS $ARG"
-done
-
-# Set the CLASSPATH and invoke the Java loader.
-#{JAVA} -classpath $CP Jhove $ARGS -x org.apache.xerces.parsers.SAXParser
-#${JAVA} -classpath $CP Jhove $ARGS
-# New way, doesn't require you to use JAVA_HOME.
-java -classpath $CP Jhove $ARGS

ocrmypdf/jhove/jhove.tmpl

@@ -1,54 +0,0 @@
-#!/bin/sh
-
-########################################################################
-# JHOVE - JSTOR/Harvard Object Validation Environment
-# Copyright 2003-2004 by JSTOR and the President and Fellows of Harvard College
-# JHOVE is made available under the GNU General Public License (see the
-# file LICENSE for details)
-#
-# Copy jhove.tmpl to jhove, and replace the value of JHOVE_HOME with
-# the path to your jhove directory.
-#
-# Usage: jhove [-c config] [-m module [-p param]] [-h handler [-P param]]
-#              [-e encoding] [-H handler] [-o output] [-x saxclass]
-#              [-t tempdir] [-b bufsize] [[-krs] dir-file-or-uri [...]]
-#
-# where -c config   Configuration file pathname
-#       -m module   Module name
-#       -p param    Module-specific parameter
-#       -h handler  Output handler name (defaults to TEXT)
-#       -P param    Handler-specific parameter
-#       -o output   Output file pathname (defaults to standard output)
-#       -x saxclass SAX parser class (defaults to J2SE 1.4 default)
-#       -t tempdir  Temporary directory in which to create temporary files
-#       -b bufsize  Buffer size for buffered I/O (defaults to J2SE 1.4 default)
-#       -k          Calculate CRC32, MD5, and SHA-1 checksums
-#       -r          Display raw data flags, not textual equivalents
-#       -s          Format identification based on internal signatures only
-#       dir-file-or-uri Directory, file pathname or URI of formatted content
-#
-# Configuration constants:
-
-JHOVE_HOME=[your directory path]/jhove
-
-JAVA_HOME=/usr/java
-JAVA=/usr/bin/java
-
-#XTRA_JARS=/users/stephen/xercesImpl.jar
-EXTRA_JARS=              # Extra .jar files to add to CLASSPATH
-
-# NOTE: Nothing below this line should be edited
-########################################################################
-
-CP=${JHOVE_HOME}/bin/JhoveApp.jar:${EXTRA_JARS}
-
-# Retrieve a copy of all command line arguments to pass to the application.
-
-ARGS=""
-for ARG do
-    ARGS="$ARGS $ARG"
-done
-
-# Set the CLASSPATH and invoke the Java loader.
-#{JAVA} -classpath $CP Jhove $ARGS -x org.apache.xerces.parsers.SAXParser
-${JAVA} -classpath $CP Jhove $ARGS

ocrmypdf/jhove/jhove_bat.tmpl

@@ -1,60 +0,0 @@
-@ECHO OFF
-REM JHOVE - JSTOR/Harvard Object Validation Environment
-REM Copyright 2003-2005 by JSTOR and the President and Fellows of Harvard College
-REM JHOVE is made available under the GNU General Public License (see the
-REM file LICENSE for details)
-REM
-REM Usage: jhove [-c config] [-m module] [-h handler] [-e encoding]
-REM              [-H handler] [-o output] [-x saxclass] [-t tempdir]
-REM              [-b bufsize] [-l loglevel] [[-krs] dir-file-or-uri [...]]
-REM
-REM For Windows systems, copy jhove_bat.tmpl to jhove.bat and change
-REM the value of JHOVE_HOME to the path to your jhove directory.
-REM
-REM where -c config   Configuration file pathname
-REM       -m module   Module name
-REM       -h handler  Output handler name (defaults to TEXT)
-REM       -e encoding Character encoding of output handler (defaults to UTF-8)
-REM       -H handler  About handler name
-REM       -o output   Output file pathname (defaults to standard output)
-REM       -x saxclass SAX parser class (defaults to J2SE 1.4 default)
-REM       -t tempdir  Temporary directory in which to create temporary files
-REM       -b bufsize  Buffer size for buffered I/O (defaults to J2SE default)
-REM       -l loglevel Logging level
-REM       -k          Calculate CRC32, MD5, and SHA-1 checksums
-REM       -r          Display raw data flags, not textual equivalents
-REM       -s          Format identification based on internal signatures only
-REM       dir-file-or-uri Directory, file pathname, or URI of formatted content
-REM
-REM Configuration constants:
-REM JHOVE_HOME Jhove installation directory
-REM JAVA_HOME  Java JRE directory
-REM JAVA       Java interpreter
-REM EXTRA_JARS Extra jar files to add to CLASSPATH
-
-REM SET JHOVE_HOME="C:\Program Files\jhove"
-SET JHOVE_HOME="[your directory path]\jhove"
-
-SET EXTRA_JARS=
-
-REM NOTE: Nothing below this line should be edited
-REM #########################################################################
-
-
-SET CP=%JHOVE_HOME%\bin\JhoveApp.jar
-IF "%EXTRA_JARS%"=="" GOTO FI
-  SET CP=%CP%:%EXTRA_JARS
-:FI
-
-REM Retrieve a copy of all command line arguments to pass to the application
-
-SET ARGS=
-:WHILE
-IF "%1"=="" GOTO LOOP
-  SET ARGS=%ARGS% %1
-  SHIFT
-  GOTO WHILE
-:LOOP
-
-REM Set the CLASSPATH and invoke the Java loader
-JAVA -classpath %CP% Jhove %ARGS%

ocrmypdf/jhove/md5.pl

@@ -1,14 +0,0 @@
-#!/usr/bin/perl -w
-
-# Generate MD5 checksum
-
-use Digest::MD5;
-
-die "usage: md5.pl file\n" if $#ARGV < 0;
-
-open (FILE, "<$ARGV[0]") or die "can't open file\"$ARGV[0]\"!\n";
-$ctx = Digest::MD5->new->addfile (*FILE);
-close (FILE);
-$digest = $ctx->hexdigest;
-
-print "$digest\n";

ocrmypdf/jhove/packagejhove.sh

@@ -1,44 +0,0 @@
-#!/bin/sh
-#DO NOT RUN THIS ON A DEVELOPEMENT DIRECTORY, ONLY ON A 
-#CHECKED-OUT COPY TO BE PACKAGED!
-
-if [ "$1" = "" ]; then
- echo "Usage: packagejhove.sh [version]"
- echo "e.g., packagejhove.sh 1_8"
- exit 1
-fi
-
-echo "This script will prepare your directory for uploading."
-echo "DO NOT RUN IT unless you're a developer and know what"
-echo "you are doing. "
-
-echo "Start in the top-level directory of the JHOVE checkout."
-echo "Run ant and ant javadoc and do any necessary testing and"
-echo "committing before running this script."
-echo 
-echo
-
-echo "To continue, enter the secret phrase."
-read OATH
-if [ "$OATH" != "I solemnly swear that I am up to no good" ]; then
- exit 1
-fi
-
-cd ..
-cat >>CVSS << EOF
-CVS
-.cvsignore
-EOF
-tar cvfX jhove-$1.tar CVSS jhove
-gzip jhove-$1.tar
-cp -r jhove jhove-zip
-cd jhove-zip
-find . \( -name CVS -o -name .cvsignore \) -exec rm -r {} \;	
-cd ..
-mv jhove jhove-ok
-mv jhove-zip jhove
-zip -r jhove-$1.zip jhove
-rm -r jhove
-mv jhove-ok jhove
-jhove/md5.pl jhove-$1.tar.gz >jhove-$1.tar.gz.md5
-jhove/md5.pl jhove-$1.zip >jhove-$1.zip.md5 

ocrmypdf/jhove/pdump

@@ -1,37 +0,0 @@
-#!/bin/sh
-
-########################################################################
-# pdump - JSTOR/Harvard Object Validation Environment
-# Copyright 2003-2005 by JSTOR and the President and Fellows of Harvard College
-# JHOVE is made available under the GNU General Public License (see the
-# file LICENSE for details)
-#
-# Driver script for the PDF dump utility
-#
-# Usage: pdump file
-#
-# where  file  is a PDF file
-#
-# Configuration constants:
-
-JHOVE_HOME=/users/stephen/projects/jhove
-
-JAVA_HOME=/usr/java      # Java JRE directory
-JAVA=$JAVA_HOME/bin/java # Java interpreter
-
-EXTRA_JARS=              # Extra .jar files to add to CLASSPATH
-
-# NOTE: Nothing below this line should be edited
-########################################################################
-
-CP=${JHOVE_HOME}/bin/JhoveApp.jar:${EXTRA_JARS}
-
-# Retrieve a copy of all command line arguments to pass to the application.
-
-ARGS=""
-for ARG do
-    ARGS="$ARGS $ARG"
-done
-
-# Set the CLASSPATH and invoke the Java loader.
-${JAVA} -classpath $CP PDump $ARGS

ocrmypdf/jhove/userhome

@@ -1,24 +0,0 @@
-#!/bin/sh
-
-########################################################################
-# userhome - JSTOR/Harvard Object Validation Environment
-# Copyright 2004-2006 by the President and Fellows of Harvard College
-# JHOVE is made available under the GNU General Public License (see the
-# file LICENSE for details)
-#
-# Driver script to display the default Java user.home property
-#
-# Usage: userhome
-#
-# Configuration constants:
-
-JHOVE_HOME=/users/stephen/projects/jhove
-
-JAVA_HOME=/usr/java      # Java JRE directory
-JAVA=$JAVA_HOME/bin/java # Java interpreter
-
-# NOTE: Nothing below this line should be edited
-########################################################################
-
-# Set the CLASSPATH and invoke the Java loader.
-${JAVA} -classpath ${JHOVE_HOME}/classes UserHome

ocrmypdf/leptonica.py

@@ -1,331 +0,0 @@
-#!/usr/bin/env python2
-# -*- coding: utf-8 -*-
-#
-# © 2013-15: jbarlow83 from Github (https://github.com/jbarlow83)
-#
-#
-# Use Leptonica to detect find and remove page skew.  Leptonica uses the method
-# of differential square sums, which its author claim is faster and more robust
-# than the Hough transform used by ImageMagick.
-
-from __future__ import print_function, absolute_import, division
-import argparse
-import ctypes as C
-import sys
-import os
-import logging
-from tempfile import TemporaryFile
-
-logger = logging.getLogger(__name__)
-
-
-def stderr(*objs):
-    """Python 2/3 compatible print to stderr.
-    """
-    print("leptonica.py:", *objs, file=sys.stderr)
-
-
-from ctypes.util import find_library
-lept_lib = find_library('lept')
-if not lept_lib:
-    stderr("Could not find the Leptonica library")
-    sys.exit(3)
-try:
-    lept = C.cdll.LoadLibrary(lept_lib)
-except Exception:
-    stderr("Could not load the Leptonica library from %s", lept_lib)
-    sys.exit(3)
-
-
-class _PIXCOLORMAP(C.Structure):
-    """struct PixColormap from Leptonica src/pix.h
-    """
-
-    _fields_ = [
-        ("array", C.c_void_p),
-        ("depth", C.c_int32),
-        ("nalloc", C.c_int32),
-        ("n", C.c_int32)
-    ]
-
-
-class _PIX(C.Structure):
-    """struct Pix from Leptonica src/pix.h
-    """
-
-    _fields_ = [
-        ("w", C.c_uint32),
-        ("h", C.c_uint32),
-        ("d", C.c_uint32),
-        ("wpl", C.c_uint32),
-        ("refcount", C.c_uint32),
-        ("xres", C.c_int32),
-        ("yres", C.c_int32),
-        ("informat", C.c_int32),
-        ("text", C.POINTER(C.c_char)),
-        ("colormap", C.POINTER(_PIXCOLORMAP)),
-        ("data", C.POINTER(C.c_uint32))
-    ]
-
-
-PIX = C.POINTER(_PIX)
-
-lept.pixRead.argtypes = [C.c_char_p]
-lept.pixRead.restype = PIX
-lept.pixScale.argtypes = [PIX, C.c_float, C.c_float]
-lept.pixScale.restype = PIX
-lept.pixDeskew.argtypes = [PIX, C.c_int32]
-lept.pixDeskew.restype = PIX
-lept.pixFindSkew.argtypes = [PIX, C.POINTER(C.c_float), C.POINTER(C.c_float)]
-lept.pixFindSkew.restype = C.c_int32
-lept.pixWriteImpliedFormat.argtypes = [C.c_char_p, PIX, C.c_int32, C.c_int32]
-lept.pixWriteImpliedFormat.restype = C.c_int32
-lept.pixDestroy.argtypes = [C.POINTER(PIX)]
-lept.pixDestroy.restype = None
-lept.getLeptonicaVersion.argtypes = []
-lept.getLeptonicaVersion.restype = C.c_char_p
-
-
-class LeptonicaErrorTrap(object):
-    """Context manager to trap errors reported by Leptonica.
-
-    Leptonica's error return codes are unreliable to the point of being
-    almost useless.  It does, however, write errors to stderr provided that is
-    not disabled at its compile time.  Fortunately this is done using error
-    macros so it is very self-consistent.
-
-    This context manager redirects stderr to a temporary file which is then
-    read and parsed for error messages.  As a side benefit, debug messages
-    from Leptonica are also suppressed.
-
-    """
-    def __enter__(self):
-        self.tmpfile = TemporaryFile()
-
-        # Save the old stderr, and redirect stderr to temporary file
-        self.old_stderr_fileno = os.dup(sys.stderr.fileno())
-        os.dup2(self.tmpfile.fileno(), sys.stderr.fileno())
-        return
-
-    def __exit__(self, exc_type, exc_value, traceback):
-        # Restore old stderr
-        os.dup2(self.old_stderr_fileno, sys.stderr.fileno())
-
-        # Get data from tmpfile (in with block to ensure it is closed)
-        with self.tmpfile as tmpfile:
-            tmpfile.seek(0)  # Cursor will be at end, so move back to beginning
-            leptonica_output = tmpfile.read().decode(errors='replace')
-
-        # If there are Python errors, let them bubble up
-        if exc_type:
-            logger.warning(leptonica_output)
-            return False
-
-        # If there are Leptonica errors, wrap them in Python excpetions
-        if 'Error' in leptonica_output:
-            if 'image file not found' in leptonica_output:
-                raise FileNotFoundError()
-            if 'pixWrite: stream not opened' in leptonica_output:
-                raise LeptonicaIOError()
-            raise LeptonicaError(leptonica_output)
-
-        return False
-
-
-class LeptonicaError(Exception):
-    pass
-
-
-class LeptonicaIOError(LeptonicaError):
-    pass
-
-
-def pixRead(filename):
-    """Load an image file into a PIX object.
-
-    Leptonica can load TIFF, PNM (PBM, PGM, PPM), PNG, and JPEG.  If loading
-    fails then the object will wrap a C null pointer.
-
-    """
-    with LeptonicaErrorTrap():
-        return lept.pixRead(filename.encode(sys.getfilesystemencoding()))
-
-
-def pixScale(pix, scalex, scaley):
-    """Returns the pix object rescaled according to the proportions given."""
-    with LeptonicaErrorTrap():
-        return lept.pixScale(pix, scalex, scaley)
-
-
-def pixDeskew(pix, reduction_factor=0):
-    """Returns the deskewed pix object.
-
-    A clone of the original is returned when the algorithm cannot find a skew
-    angle with sufficient confidence.
-
-    reduction_factor -- amount to downsample (0 for default) when searching
-        for skew angle
-
-    """
-    with LeptonicaErrorTrap():
-        return lept.pixDeskew(pix, reduction_factor)
-
-
-def pixFindSkew(pix):
-    """Returns a tuple (deskew angle in degrees, confidence value).
-
-    Returns (None, None) if no angle is available.
-
-    """
-    with LeptonicaErrorTrap():
-        angle = C.c_float(0.0)
-        confidence = C.c_float(0.0)
-        result = lept.pixFindSkew(pix, C.byref(angle), C.byref(confidence))
-        if result == 0:
-            return (angle.value, confidence.value)
-        else:
-            return (None, None)
-
-
-def pixWriteImpliedFormat(filename, pix, jpeg_quality=0, jpeg_progressive=0):
-    """Write pix to the filename, with the extension indicating format.
-
-    jpeg_quality -- quality (iff JPEG; 1 - 100, 0 for default)
-    jpeg_progressive -- (iff JPEG; 0 for baseline seq., 1 for progressive)
-
-    """
-    fileroot, extension = os.path.splitext(filename)
-    fix_pnm = False
-    if extension.lower() in ('.pbm', '.pgm', '.ppm'):
-        # Leptonica does not process handle these extensions correctly, but
-        # does handle .pnm correctly.  Add another .pnm suffix.
-        filename += '.pnm'
-        fix_pnm = True
-
-    with LeptonicaErrorTrap():
-        lept.pixWriteImpliedFormat(
-            filename.encode(sys.getfilesystemencoding()),
-            pix, jpeg_quality, jpeg_progressive)
-
-    if fix_pnm:
-        from shutil import move
-        move(filename, filename[:-4])   # Remove .pnm suffix
-
-
-def pixDestroy(pix):
-    """Destroy the pix object.
-
-    Function signature is pixDestroy(struct Pix **), hence C.byref() to pass
-    the address of the pointer.
-
-    """
-    with LeptonicaErrorTrap():
-        lept.pixDestroy(C.byref(pix))
-
-
-def getLeptonicaVersion():
-    """Get Leptonica version string.
-
-    Caveat: Leptonica expects the caller to free this memory.  We don't,
-    since that would involve binding to libc to access libc.free(),
-    a pointless effort to reclaim 100 bytes of memory.
-
-    """
-    return lept.getLeptonicaVersion().decode()
-
-
-def deskew(infile, outfile, dpi):
-    try:
-        pix_source = pixRead(infile)
-    except LeptonicaIOError:
-        raise LeptonicaIOError("Failed to open file: %s" % infile)
-
-    if dpi < 150:
-        reduction_factor = 1  # Don't downsample too much if DPI is already low
-    else:
-        reduction_factor = 0  # Use default
-    pix_deskewed = pixDeskew(pix_source, reduction_factor)
-
-    try:
-        pixWriteImpliedFormat(outfile, pix_deskewed)
-    except LeptonicaIOError:
-        raise LeptonicaIOError("Failed to open destination file: %s" % outfile)
-    pixDestroy(pix_source)
-    pixDestroy(pix_deskewed)
-
-
-if __name__ == '__main__':
-    parser = argparse.ArgumentParser(
-        description="Python wrapper to access Leptonica")
-
-    subparsers = parser.add_subparsers(title='commands',
-                                       description='supported operations')
-
-    parser_deskew = subparsers.add_parser('deskew')
-    parser_deskew.add_argument('-r', '--dpi', dest='dpi', action='store',
-                               type=int, default=300, help='input resolution')
-    parser_deskew.add_argument('infile', help='image to deskew')
-    parser_deskew.add_argument('outfile', help='deskewed output image')
-    parser_deskew.set_defaults(func=deskew)
-
-    args = parser.parse_args()
-
-    if getLeptonicaVersion() != u'leptonica-1.69':
-        print("Unexpected leptonica version: %s" % getLeptonicaVersion())
-
-    args.func(args)
-
-
-def _test_output(mode, extension, im_format):
-    from PIL import Image
-    from tempfile import NamedTemporaryFile
-
-    with NamedTemporaryFile(prefix='test-lept-pnm', suffix=extension, delete=True) as tmpfile:
-        im = Image.new(mode=mode, size=(100, 100))
-        im.save(tmpfile)
-
-        pix = pixRead(tmpfile.name)
-        pixWriteImpliedFormat(tmpfile.name, pix)
-        pixDestroy(pix)
-
-        im_roundtrip = Image.open(tmpfile.name)
-        assert im_roundtrip.mode == im.mode, "leptonica mode differs"
-        assert im_roundtrip.format == im_format, \
-            "{0}: leptonica produced a {1}".format(
-                extension,
-                im_roundtrip.format)
-
-
-def test_pnm_output():
-    params = [['1', '.pbm', 'PPM'], ['L', '.pgm', 'PPM'],
-              ['RGB', '.ppm', 'PPM']]
-    for param in params:
-        _test_output(*param)
-
-
-def test_skew_angle():
-    from PIL import Image, ImageDraw
-    from tempfile import NamedTemporaryFile
-
-    im = Image.new(mode='1', size=(1000, 1000), color=1)
-
-    draw = ImageDraw.Draw(im)
-    for n in range(20):
-        draw.line([(50, 25 + 50*n), (950, 25 + 50*n)], width=1)
-    del draw
-
-    test_angles = [0.1 * ang for ang in range(1, 10)] + \
-                  [float(ang) for ang in range(1, 7)]
-    test_angles += [-ang for ang in test_angles]
-    test_angles = sorted(test_angles)
-
-    for rotate_angle in test_angles:
-        rotated_im = im.rotate(rotate_angle)
-        with NamedTemporaryFile(prefix='lept-skew', suffix='.png', delete=True) as tmpfile:
-            rotated_im.save(tmpfile)
-            pix = pixRead(tmpfile.name)
-            angle, confidence = pixFindSkew(pix)
-            pixDestroy(pix)
-            print('{0} {1}  {2}'.format(rotate_angle, angle, confidence), file=sys.stderr)
-
-

ocrmypdf/main.py

@@ -1,842 +0,0 @@
-#!/usr/bin/env python3
-# © 2015 James R. Barlow: github.com/jbarlow83
-
-from contextlib import suppress
-from tempfile import NamedTemporaryFile, mkdtemp
-import sys
-import os
-import fileinput
-import re
-import shutil
-import warnings
-import multiprocessing
-import atexit
-import textwrap
-
-import PyPDF2 as pypdf
-from PIL import Image
-
-from subprocess import Popen, check_call, PIPE, CalledProcessError, \
-    TimeoutExpired
-try:
-    from subprocess import DEVNULL
-except ImportError:
-    DEVNULL = open(os.devnull, 'wb')
-
-
-from ruffus import transform, suffix, merge, active_if, regex, jobs_limit, \
-    formatter, follows, split, collate, check_if_uptodate
-import ruffus.cmdline as cmdline
-
-from .hocrtransform import HocrTransform
-from .pageinfo import pdf_get_all_pageinfo
-from .pdfa import generate_pdfa_def
-from . import ghostscript
-from . import tesseract
-
-
-warnings.simplefilter('ignore', pypdf.utils.PdfReadWarning)
-
-
-BASEDIR = os.path.dirname(os.path.realpath(__file__))
-JHOVE_PATH = os.path.realpath(os.path.join(BASEDIR, 'jhove'))
-JHOVE_JAR = os.path.join(JHOVE_PATH, 'bin', 'JhoveApp.jar')
-JHOVE_CFG = os.path.join(JHOVE_PATH, 'conf', 'jhove.conf')
-
-EXIT_BAD_ARGS = 1
-EXIT_BAD_INPUT_FILE = 2
-EXIT_MISSING_DEPENDENCY = 3
-EXIT_INVALID_OUTPUT_PDFA = 4
-EXIT_FILE_ACCESS_ERROR = 5
-EXIT_ALREADY_DONE_OCR = 6
-EXIT_OTHER_ERROR = 15
-
-# -------------
-# External dependencies
-
-MINIMUM_TESS_VERSION = '3.02.02'
-
-
-def complain(message):
-    print(textwrap.wrap(message), file=sys.stderr)
-
-
-if tesseract.version() < MINIMUM_TESS_VERSION:
-    complain(
-        "Please install tesseract {0} or newer "
-        "(currently installed version is {1})".format(
-            MINIMUM_TESS_VERSION, tesseract.version()))
-    sys.exit(EXIT_MISSING_DEPENDENCY)
-
-
-# -------------
-# Parser
-
-parser = cmdline.get_argparse(
-    prog="ocrmypdf",
-    description="Generate searchable PDF file from an image-only PDF file.",
-    version='3.0rc2',
-    fromfile_prefix_chars='@',
-    ignored_args=[
-        'touch_files_only', 'recreate_database', 'checksum_file_name',
-        'key_legend_in_graph', 'draw_graph_horizontally', 'flowchart_format',
-        'forced_tasks', 'target_tasks'])
-
-parser.add_argument(
-    'input_file',
-    help="PDF file containing the images to be OCRed")
-parser.add_argument(
-    'output_file',
-    help="output searchable PDF file")
-parser.add_argument(
-    '-l', '--language', action='append',
-    help="language of the file to be OCRed")
-
-metadata = parser.add_argument_group(
-    "Metadata options",
-    "Set output PDF/A metadata (default: use input document's title)")
-metadata.add_argument(
-    '--title', type=str,
-    help="set document title (place multiple words in quotes)")
-metadata.add_argument(
-    '--author', type=str,
-    help="set document author")
-metadata.add_argument(
-    '--subject', type=str,
-    help="set document")
-metadata.add_argument(
-    '--keywords', type=str,
-    help="set document keywords")
-
-
-preprocessing = parser.add_argument_group(
-    "Preprocessing options",
-    "Improve OCR quality and final image")
-preprocessing.add_argument(
-    '-d', '--deskew', action='store_true',
-    help="deskew each page before performing OCR")
-preprocessing.add_argument(
-    '-c', '--clean', action='store_true',
-    help="clean pages with unpaper before performing OCR")
-preprocessing.add_argument(
-    '-i', '--clean-final', action='store_true',
-    help="incorporate the cleaned image in the final PDF file")
-preprocessing.add_argument(
-    '--oversample', metavar='DPI', type=int, default=0,
-    help="oversample images to improve OCR results slightly")
-
-parser.add_argument(
-    '-f', '--force-ocr', action='store_true',
-    help="force image into OCR, even if the page already contains text")
-parser.add_argument(
-    '-s', '--skip-text', action='store_true',
-    help="skip OCR on any pages that already contain text")
-parser.add_argument(
-    '--skip-big', type=float, metavar='MPixels',
-    help="skip OCR on pages larger than the specified amount of megapixels")
-# parser.add_argument(
-#     '--exact-image', action='store_true',
-#     help="Use original page from PDF without re-rendering")
-
-advanced = parser.add_argument_group(
-    "Advanced",
-    "Advanced options for power users")
-advanced.add_argument(
-    '--tesseract-config', default=[], type=list, action='append',
-    help="additional Tesseract configuration files")
-advanced.add_argument(
-    '--pdf-renderer', choices=['tesseract', 'hocr'], default='hocr',
-    help='choose OCR PDF renderer')
-advanced.add_argument(
-    '--tesseract-timeout', default=180.0, type=float,
-    help='give up on OCR after timeout')
-
-debugging = parser.add_argument_group(
-    "Debugging",
-    "Arguments to help with troubleshooting and debugging")
-debugging.add_argument(
-    '-k', '--keep-temporary-files', action='store_true',
-    help="keep temporary files (helpful for debugging)")
-debugging.add_argument(
-    '-g', '--debug-rendering', action='store_true',
-    help="render each page twice with debug information on second page")
-
-options = parser.parse_args()
-
-
-# ----------
-# Languages
-
-if not options.language:
-    options.language = ['eng']  # Enforce English hegemony
-
-# Support v2.x "eng+deu" language syntax
-if '+' in options.language[0]:
-    options.language = options.language[0].split('+')
-
-if not set(options.language).issubset(tesseract.languages()):
-    complain(
-        "The installed version of tesseract does not have language "
-        "data for the following requested languages: ")
-    for lang in (set(options.language) - tesseract.languages()):
-        complain(lang, file=sys.stderr)
-    sys.exit(EXIT_BAD_ARGS)
-
-
-# ----------
-# Arguments
-
-
-if any((options.deskew, options.clean, options.clean_final)):
-    try:
-        from . import unpaper
-    except ImportError:
-        complain(
-            "Install the 'unpaper' program to use --deskew or --clean.")
-        sys.exit(EXIT_BAD_ARGS)
-else:
-    unpaper = None
-
-if options.debug_rendering and options.pdf_renderer == 'tesseract':
-    complain(
-        "Ignoring --debug-rendering because it is not supported with"
-        "--pdf-renderer=tesseract.")
-
-if options.force_ocr and options.skip_text:
-    complain(
-        "Error: --force-ocr and --skip-text are mutually incompatible.")
-    sys.exit(EXIT_BAD_ARGS)
-
-if options.clean and not options.clean_final \
-        and options.pdf_renderer == 'tesseract':
-    complain(
-        "Tesseract PDF renderer cannot render --clean pages without "
-        "also performing --clean-final, so --clean-final is assumed.")
-
-
-# ----------
-# Logging
-
-
-_logger, _logger_mutex = cmdline.setup_logging(__name__, options.log_file,
-                                               options.verbose)
-
-
-class WrappedLogger:
-
-    def __init__(self, my_logger, my_mutex):
-        self.logger = my_logger
-        self.mutex = my_mutex
-
-    def log(self, *args, **kwargs):
-        with self.mutex:
-            self.logger.log(*args, **kwargs)
-
-    def debug(self, *args, **kwargs):
-        with self.mutex:
-            self.logger.debug(*args, **kwargs)
-
-    def info(self, *args, **kwargs):
-        with self.mutex:
-            self.logger.info(*args, **kwargs)
-
-    def warning(self, *args, **kwargs):
-        with self.mutex:
-            self.logger.warning(*args, **kwargs)
-
-    def error(self, *args, **kwargs):
-        with self.mutex:
-            self.logger.error(*args, **kwargs)
-
-    def critical(self, *args, **kwargs):
-        with self.mutex:
-            self.logger.critical(*args, **kwargs)
-
-_log = WrappedLogger(_logger, _logger_mutex)
-
-
-def re_symlink(input_file, soft_link_name, log=_log):
-    """
-    Helper function: relinks soft symbolic link if necessary
-    """
-    # Guard against soft linking to oneself
-    if input_file == soft_link_name:
-        log.debug("Warning: No symbolic link made. You are using " +
-                  "the original data directory as the working directory.")
-        return
-
-    # Soft link already exists: delete for relink?
-    if os.path.lexists(soft_link_name):
-        # do not delete or overwrite real (non-soft link) file
-        if not os.path.islink(soft_link_name):
-            raise Exception("%s exists and is not a link" % soft_link_name)
-        try:
-            os.unlink(soft_link_name)
-        except:
-            log.debug("Can't unlink %s" % (soft_link_name))
-
-    if not os.path.exists(input_file):
-        raise Exception("trying to create a broken symlink to %s" % input_file)
-
-    log.debug("os.symlink(%s, %s)" % (input_file, soft_link_name))
-
-    # Create symbolic link using absolute path
-    os.symlink(
-        os.path.abspath(input_file),
-        soft_link_name
-    )
-
-
-# -------------
-# The Pipeline
-
-manager = multiprocessing.Manager()
-_pdfinfo = manager.list()
-_pdfinfo_lock = manager.Lock()
-
-work_folder = mkdtemp(prefix="com.github.ocrmypdf.")
-
-
-@atexit.register
-def cleanup_working_files(*args):
-    if options.keep_temporary_files:
-        print("Temporary working files saved at:")
-        print(work_folder)
-    else:
-        with suppress(FileNotFoundError):
-            shutil.rmtree(work_folder)
-
-
-@transform(
-    input=options.input_file,
-    filter=suffix('.pdf'),
-    output='.repaired.pdf',
-    output_dir=work_folder,
-    extras=[_log, _pdfinfo, _pdfinfo_lock])
-def repair_pdf(
-        input_file,
-        output_file,
-        log,
-        pdfinfo,
-        pdfinfo_lock):
-    args_mutool = [
-        'mutool', 'clean',
-        input_file, output_file
-    ]
-    check_call(args_mutool)
-
-    with pdfinfo_lock:
-        pdfinfo.extend(pdf_get_all_pageinfo(output_file))
-        log.info(pdfinfo)
-
-
-def get_pageinfo(input_file, pdfinfo, pdfinfo_lock):
-    pageno = int(os.path.basename(input_file)[0:6]) - 1
-    with pdfinfo_lock:
-        pageinfo = pdfinfo[pageno].copy()
-    return pageinfo
-
-
-def is_ocr_required(pageinfo, log):
-    page = pageinfo['pageno'] + 1
-    ocr_required = True
-    if not pageinfo['images']:
-        # If the page has no images, then it contains vector content or text
-        # or both. It seems quite unlikely that one would find meaningful text
-        # from rasterizing vector content. So skip the page.
-        log.info(
-            "Page {0} has no images - skipping OCR".format(page)
-        )
-        ocr_required = False
-    elif pageinfo['has_text']:
-        s = "Page {0} already has text! – {1}"
-
-        if not options.force_ocr and not options.skip_text:
-            log.error(s.format(page,
-                               "aborting (use --force-ocr to force OCR)"))
-            sys.exit(EXIT_ALREADY_DONE_OCR)
-        elif options.force_ocr:
-            log.info(s.format(page,
-                              "rasterizing text and running OCR anyway"))
-            ocr_required = True
-        elif options.skip_text:
-            log.info(s.format(page,
-                              "skipping all processing on this page"))
-            ocr_required = False
-
-    if ocr_required and options.skip_big:
-        pixel_count = pageinfo['width_pixels'] * pageinfo['height_pixels']
-        if pixel_count > (options.skip_big * 1000000):
-            ocr_required = False
-            log.info(
-                "Page {0} is very large; skipping due to -b".format(page))
-
-    return ocr_required
-
-
-@split(
-    repair_pdf,
-    os.path.join(work_folder, '*.page.pdf'),
-    extras=[_log, _pdfinfo, _pdfinfo_lock])
-def split_pages(
-        input_file,
-        output_files,
-        log,
-        pdfinfo,
-        pdfinfo_lock):
-
-    for oo in output_files:
-        with suppress(FileNotFoundError):
-            os.unlink(oo)
-    args_pdfseparate = [
-        'pdfseparate',
-        input_file,
-        os.path.join(work_folder, '%06d.page.pdf')
-    ]
-    check_call(args_pdfseparate)
-
-    from glob import glob
-    for filename in glob(os.path.join(work_folder, '*.page.pdf')):
-        pageinfo = get_pageinfo(filename, pdfinfo, pdfinfo_lock)
-
-        alt_suffix = '.ocr.page.pdf' if is_ocr_required(pageinfo, log) \
-                     else '.skip.page.pdf'
-        re_symlink(
-            filename,
-            os.path.join(
-                work_folder,
-                os.path.basename(filename)[0:6] + alt_suffix))
-
-
-@transform(
-    input=split_pages,
-    filter=suffix('.ocr.page.pdf'),
-    output='.page.png',
-    output_dir=work_folder,
-    extras=[_log, _pdfinfo, _pdfinfo_lock])
-def rasterize_with_ghostscript(
-        input_file,
-        output_file,
-        log,
-        pdfinfo,
-        pdfinfo_lock):
-
-    pageinfo = get_pageinfo(input_file, pdfinfo, pdfinfo_lock)
-
-    device = 'png16m'  # 24-bit
-    if all(image['comp'] == 1 for image in pageinfo['images']):
-        if all(image['bpc'] == 1 for image in pageinfo['images']):
-            device = 'pngmono'
-        elif not any(image['color'] == 'color'
-                     for image in pageinfo['images']):
-            device = 'pnggray'
-
-    xres = max(pageinfo['xres'], options.oversample or 0)
-    yres = max(pageinfo['yres'], options.oversample or 0)
-
-    ghostscript.rasterize_pdf(input_file, output_file, xres, yres, device, log)
-
-
-@transform(
-    input=rasterize_with_ghostscript,
-    filter=suffix(".page.png"),
-    output=".pp-deskew.png",
-    extras=[_log, _pdfinfo, _pdfinfo_lock])
-def preprocess_deskew(
-        input_file,
-        output_file,
-        log,
-        pdfinfo,
-        pdfinfo_lock):
-
-    if not options.deskew:
-        re_symlink(input_file, output_file, log)
-        return
-
-    pageinfo = get_pageinfo(input_file, pdfinfo, pdfinfo_lock)
-    dpi = int(pageinfo['xres'])
-
-    unpaper.deskew(input_file, output_file, dpi, log)
-
-
-@transform(
-    input=preprocess_deskew,
-    filter=suffix(".pp-deskew.png"),
-    output=".pp-clean.png",
-    extras=[_log, _pdfinfo, _pdfinfo_lock])
-def preprocess_clean(
-        input_file,
-        output_file,
-        log,
-        pdfinfo,
-        pdfinfo_lock):
-
-    if not options.clean:
-        re_symlink(input_file, output_file, log)
-        return
-
-    pageinfo = get_pageinfo(input_file, pdfinfo, pdfinfo_lock)
-    dpi = int(pageinfo['xres'])
-
-    unpaper.clean(input_file, output_file, dpi, log)
-
-
-@active_if(options.pdf_renderer == 'hocr')
-@transform(
-    input=preprocess_clean,
-    filter=suffix(".pp-clean.png"),
-    output=".hocr",
-    extras=[_log, _pdfinfo, _pdfinfo_lock])
-def ocr_tesseract_hocr(
-        input_file,
-        output_file,
-        log,
-        pdfinfo,
-        pdfinfo_lock):
-
-    pageinfo = get_pageinfo(input_file, pdfinfo, pdfinfo_lock)
-
-    args_tesseract = [
-        'tesseract',
-        '-l', '+'.join(options.language),
-        input_file,
-        output_file,
-        'hocr'
-    ] + options.tesseract_config
-    p = Popen(args_tesseract, close_fds=True, stdout=PIPE, stderr=PIPE,
-              universal_newlines=True)
-    try:
-        stdout, stderr = p.communicate(timeout=options.tesseract_timeout)
-    except TimeoutExpired:
-        p.kill()
-        stdout, stderr = p.communicate()
-        # Generate a HOCR file with no recognized text if tesseract times out
-        # Temporary workaround to hocrTransform not being able to function if
-        # it does not have a valid hOCR file.
-        with open(output_file, 'w', encoding="utf-8") as f:
-            f.write(tesseract.HOCR_TEMPLATE.format(
-                pageinfo['width_pixels'],
-                pageinfo['height_pixels']))
-    else:
-        if stdout:
-            log.info(stdout)
-        if stderr:
-            log.error(stderr)
-
-        if p.returncode != 0:
-            raise CalledProcessError(p.returncode, args_tesseract)
-
-        if os.path.exists(output_file + '.html'):
-            # Tesseract 3.02 appends suffix ".html" on its own (.hocr.html)
-            shutil.move(output_file + '.html', output_file)
-        elif os.path.exists(output_file + '.hocr'):
-            # Tesseract 3.03 appends suffix ".hocr" on its own (.hocr.hocr)
-            shutil.move(output_file + '.hocr', output_file)
-
-        # Tesseract 3.03 inserts source filename into hocr file without
-        # escaping it, creating invalid XML and breaking the parser.
-        # As a workaround, rewrite the hocr file, replacing the filename
-        # with a space.
-        regex_nested_single_quotes = re.compile(
-            r"""title='image "([^"]*)";""")
-        with fileinput.input(files=(output_file,), inplace=True) as f:
-            for line in f:
-                line = regex_nested_single_quotes.sub(
-                    r"""title='image " ";""", line)
-                print(line, end='')  # fileinput.input redirects stdout
-
-
-@active_if(options.pdf_renderer == 'hocr')
-@collate(
-    input=[rasterize_with_ghostscript, preprocess_deskew, preprocess_clean],
-    filter=regex(r".*/(\d{6})(?:\.page|\.pp-deskew|\.pp-clean)\.png"),
-    output=os.path.join(work_folder, r'\1.image'),
-    extras=[_log, _pdfinfo, _pdfinfo_lock])
-def select_image_for_pdf(
-        infiles,
-        output_file,
-        log,
-        pdfinfo,
-        pdfinfo_lock):
-    if options.clean_final:
-        image_suffix = '.pp-clean.png'
-    elif options.deskew:
-        image_suffix = '.pp-deskew.png'
-    else:
-        image_suffix = '.page.png'
-    image = next(ii for ii in infiles if ii.endswith(image_suffix))
-
-    pageinfo = get_pageinfo(image, pdfinfo, pdfinfo_lock)
-    if all(image['enc'] == 'jpeg' for image in pageinfo['images']):
-        # If all images were JPEGs originally, produce a JPEG as output
-        Image.open(image).save(output_file, format='JPEG')
-    else:
-        re_symlink(image, output_file)
-
-
-@active_if(options.pdf_renderer == 'hocr')
-@collate(
-    input=[select_image_for_pdf, ocr_tesseract_hocr],
-    filter=regex(r".*/(\d{6})(?:\.image|\.hocr)"),
-    output=os.path.join(work_folder, r'\1.rendered.pdf'),
-    extras=[_log, _pdfinfo, _pdfinfo_lock])
-def render_hocr_page(
-        infiles,
-        output_file,
-        log,
-        pdfinfo,
-        pdfinfo_lock):
-    hocr = next(ii for ii in infiles if ii.endswith('.hocr'))
-    image = next(ii for ii in infiles if ii.endswith('.image'))
-
-    pageinfo = get_pageinfo(image, pdfinfo, pdfinfo_lock)
-    dpi = round(max(pageinfo['xres'], pageinfo['yres'], options.oversample))
-
-    hocrtransform = HocrTransform(hocr, dpi)
-    hocrtransform.to_pdf(output_file, imageFileName=image,
-                         showBoundingboxes=False, invisibleText=True)
-
-
-@active_if(options.pdf_renderer == 'hocr')
-@active_if(options.debug_rendering)
-@collate(
-    input=[select_image_for_pdf, ocr_tesseract_hocr],
-    filter=regex(r".*/(\d{6})(?:\.image|\.hocr)"),
-    output=os.path.join(work_folder, r'\1.debug.pdf'),
-    extras=[_log, _pdfinfo, _pdfinfo_lock])
-def render_hocr_debug_page(
-        infiles,
-        output_file,
-        log,
-        pdfinfo,
-        pdfinfo_lock):
-    hocr = next(ii for ii in infiles if ii.endswith('.hocr'))
-    image = next(ii for ii in infiles if ii.endswith('.image'))
-
-    pageinfo = get_pageinfo(image, pdfinfo, pdfinfo_lock)
-    dpi = round(max(pageinfo['xres'], pageinfo['yres'], options.oversample))
-
-    hocrtransform = HocrTransform(hocr, dpi)
-    hocrtransform.to_pdf(output_file, imageFileName=None,
-                         showBoundingboxes=True, invisibleText=False)
-
-
-@active_if(options.pdf_renderer == 'tesseract')
-@collate(
-    input=[preprocess_clean, split_pages],
-    filter=regex(r".*/(\d{6})(?:\.pp-clean\.png|\.page\.pdf)"),
-    output=os.path.join(work_folder, r'\1.rendered.pdf'),
-    extras=[_log, _pdfinfo, _pdfinfo_lock])
-def tesseract_ocr_and_render_pdf(
-        input_files,
-        output_file,
-        log,
-        pdfinfo,
-        pdfinfo_lock):
-
-    input_image = next((ii for ii in input_files if ii.endswith('.png')), '')
-    input_pdf = next((ii for ii in input_files if ii.endswith('.pdf')))
-    if not input_image:
-        # Skipping this page
-        re_symlink(input_pdf, output_file)
-        return
-
-    args_tesseract = [
-        'tesseract',
-        '-l', '+'.join(options.language),
-        input_image,
-        os.path.splitext(output_file)[0],  # Tesseract appends suffix
-        'pdf'
-    ] + options.tesseract_config
-    p = Popen(args_tesseract, close_fds=True, stdout=PIPE, stderr=PIPE,
-              universal_newlines=True)
-
-    try:
-        stdout, stderr = p.communicate(timeout=options.tesseract_timeout)
-        if stdout:
-            log.info(stdout)
-        if stderr:
-            log.error(stderr)
-    except TimeoutError:
-        p.kill()
-        log.info("Tesseract - page timed out")
-        re_symlink(input_pdf, output_file)
-
-
-@transform(
-    input=repair_pdf,
-    filter=suffix('.repaired.pdf'),
-    output='.pdfa_def.ps',
-    output_dir=work_folder,
-    extras=[_log])
-def generate_postscript_stub(
-        input_file,
-        output_file,
-        log):
-
-    pdf = pypdf.PdfFileReader(input_file)
-
-    def from_document_info(key):
-        # pdf.documentInfo.get() DOES NOT work as expected
-        try:
-            s = pdf.documentInfo[key]
-            return str(s)
-        except KeyError:
-            return ''
-
-    pdfmark = {
-        'title': from_document_info('/Title'),
-        'author': from_document_info('/Author'),
-        'keywords': from_document_info('/Keywords'),
-        'subject': from_document_info('/Subject'),
-    }
-    if options.title:
-        pdfmark['title'] = options.title
-    if options.author:
-        pdfmark['author'] = options.author
-    if options.keywords:
-        pdfmark['keywords'] = options.keywords
-    if options.subject:
-        pdfmark['subject'] = options.subject
-
-    generate_pdfa_def(output_file, pdfmark)
-
-
-@transform(
-    input=split_pages,
-    filter=suffix('.skip.page.pdf'),
-    output='.done.pdf',
-    output_dir=work_folder,
-    extras=[_log])
-def skip_page(
-        input_file,
-        output_file,
-        log):
-    re_symlink(input_file, output_file, log)
-
-
-@merge(
-    input=[render_hocr_page, render_hocr_debug_page, skip_page,
-           tesseract_ocr_and_render_pdf, generate_postscript_stub],
-    output=os.path.join(work_folder, 'merged.pdf'),
-    extras=[_log, _pdfinfo, _pdfinfo_lock])
-def merge_pages(
-        input_files,
-        output_file,
-        log,
-        pdfinfo,
-        pdfinfo_lock):
-
-    def input_file_order(s):
-        '''Sort order: All rendered pages followed
-        by their debug page, if any, followed by Postscript stub.
-        Ghostscript documentation has the Postscript stub at the
-        beginning, but it works at the end and also gets document info
-        right that way.'''
-        if s.endswith('.ps'):
-            return 99999999
-        key = int(os.path.basename(s)[0:6]) * 10
-        if 'debug' in os.path.basename(s):
-            key += 1
-        return key
-
-    pdf_pages = sorted(input_files, key=input_file_order)
-    log.info(pdf_pages)
-    ghostscript.generate_pdfa(pdf_pages, output_file)
-
-
-@transform(
-    input=merge_pages,
-    filter=formatter(),
-    output=options.output_file,
-    extras=[_log, _pdfinfo, _pdfinfo_lock])
-def validate_pdfa(
-        input_file,
-        output_file,
-        log,
-        pdfinfo,
-        pdfinfo_lock):
-
-    args_jhove = [
-        'java',
-        '-jar', JHOVE_JAR,
-        '-c', JHOVE_CFG,
-        '-m', 'PDF-hul',
-        input_file
-    ]
-    p_jhove = Popen(args_jhove, close_fds=True, universal_newlines=True,
-                    stdout=PIPE, stderr=DEVNULL)
-    stdout, _ = p_jhove.communicate()
-
-    log.debug(stdout)
-    if p_jhove.returncode != 0:
-        log.error(stdout)
-        raise RuntimeError(
-            "Unexpected error while checking compliance to PDF/A file.")
-
-    pdf_is_valid = True
-    if re.search(r'ErrorMessage', stdout,
-                 re.IGNORECASE | re.MULTILINE):
-        pdf_is_valid = False
-    if re.search(r'^\s+Status.*not valid', stdout,
-                 re.IGNORECASE | re.MULTILINE):
-        pdf_is_valid = False
-    if re.search(r'^\s+Status.*Not well-formed', stdout,
-                 re.IGNORECASE | re.MULTILINE):
-        pdf_is_valid = False
-
-    pdf_is_pdfa = False
-    if re.search(r'^\s+Profile:.*PDF/A-1', stdout,
-                 re.IGNORECASE | re.MULTILINE):
-        pdf_is_pdfa = True
-
-    if not pdf_is_valid:
-        log.warning('Output file: The generated PDF/A file is INVALID')
-    elif pdf_is_valid and not pdf_is_pdfa:
-        log.warning('Output file: Generated file is a VALID PDF but not PDF/A')
-    elif pdf_is_valid and pdf_is_pdfa:
-        log.info('Output file: The generated PDF/A file is VALID')
-    shutil.copy(input_file, output_file)
-
-
-# @active_if(ocr_required and options.exact_image)
-# @merge([render_hocr_blank_page, extract_single_page],
-#        os.path.join(work_folder, "%04i.merged.pdf") % pageno)
-# def merge_hocr_with_original_page(infiles, output_file):
-#     with open(infiles[0], 'rb') as hocr_input, \
-#             open(infiles[1], 'rb') as page_input, \
-#             open(output_file, 'wb') as output:
-#         hocr_reader = pypdf.PdfFileReader(hocr_input)
-#         page_reader = pypdf.PdfFileReader(page_input)
-#         writer = pypdf.PdfFileWriter()
-
-#         the_page = hocr_reader.getPage(0)
-#         the_page.mergePage(page_reader.getPage(0))
-#         writer.addPage(the_page)
-#         writer.write(output)
-
-
-def available_cpu_count():
-    try:
-        return multiprocessing.cpu_count()
-    except NotImplementedError:
-        pass
-
-    try:
-        import psutil
-        return psutil.cpu_count()
-    except (ImportError, AttributeError):
-        pass
-
-    complain(
-        "Could not get CPU count.  Assuming one (1) CPU."
-        "Use -j N to set manually.")
-    return 1
-
-
-def run_pipeline():
-    cmdline.run(options, multiprocess=available_cpu_count())
-
-
-if __name__ == '__main__':
-    run_pipeline()

ocrmypdf/pageinfo.py

@@ -1,137 +0,0 @@
-#!/usr/bin/env python3
-# © 2015 James R. Barlow: github.com/jbarlow83
-
-from subprocess import Popen, PIPE
-from decimal import Decimal, getcontext
-import re
-import sys
-import PyPDF2 as pypdf
-
-
-FRIENDLY_COLORSPACE = {
-    '/DeviceGray': 'gray',
-    '/CalGray': 'gray',
-    '/DeviceRGB': 'rgb',
-    '/CalRGB': 'rgb',
-    '/DeviceCMYK': 'cmyk',
-    '/Lab': 'lab',
-    '/ICCBased': 'icc',
-    '/Indexed': 'index',
-    '/Separation': 'sep',
-    '/DeviceN': 'devn',
-    '/Pattern': '-'
-}
-
-FRIENDLY_ENCODING = {
-    '/CCITTFaxDecode': 'ccitt',
-    '/DCTDecode': 'jpeg',
-    '/JPXDecode': 'jpx',
-    '/JBIG2Decode': 'jbig2',
-}
-
-FRIENDLY_COMP = {
-    'gray': 1,
-    'rgb': 3,
-    'cmyk': 4,
-    'lab': 3,
-}
-
-
-def _page_has_inline_images(page):
-    # PDF always uses \r\n for separator regardless of platform
-    # Really basic heuristic that might trigger the odd false positive
-    # This is only finds the first image and is not quite spec compliant
-    contents = page.getContents()
-    data = contents.getData()
-    begin_image, image_data, end_image = False, False, False
-    for data in re.split(b'\s+', data):
-        if data == b'BI':
-            begin_image = True
-        elif data == b'ID':
-            image_data = True
-        elif data == b'EI':
-            end_image = True
-        if all((begin_image, image_data, end_image)):
-            return True
-
-
-def _find_page_images(page, pageinfo):
-    try:
-        page['/Resources']['/XObject']
-    except KeyError:
-        return
-
-    # Look for XObject (out of line images)
-    for xobj in page['/Resources']['/XObject']:
-        # PyPDF2 returns the keys as an iterator
-        pdfimage = page['/Resources']['/XObject'][xobj]
-        if pdfimage['/Subtype'] != '/Image':
-            continue
-        if '/ImageMask' in pdfimage:
-            if pdfimage['/ImageMask']:
-                continue
-        image = {}
-        image['width'] = pdfimage['/Width']
-        image['height'] = pdfimage['/Height']
-        image['bpc'] = pdfimage['/BitsPerComponent']
-        if '/Filter' in pdfimage:
-            filter_ = pdfimage['/Filter']
-            if isinstance(filter_, pypdf.generic.ArrayObject):
-                filter_ = filter_[0]
-            image['enc'] = FRIENDLY_ENCODING.get(filter_, 'image')
-        else:
-            image['enc'] = 'image'
-        if '/ColorSpace' in pdfimage:
-            cs = pdfimage['/ColorSpace']
-            if isinstance(cs, pypdf.generic.ArrayObject):
-                cs = cs[0]
-            image['color'] = FRIENDLY_COLORSPACE.get(cs, '-')
-        else:
-            image['color'] = 'jpx' if image['enc'] == 'jpx' else '?'
-
-        image['comp'] = FRIENDLY_COMP.get(image['color'], '?')
-        image['dpi_w'] = image['width'] / pageinfo['width_inches']
-        image['dpi_h'] = image['height'] / pageinfo['height_inches']
-        image['dpi'] = (image['dpi_w'] * image['dpi_h']) ** Decimal(0.5)
-        yield image
-
-
-def _pdf_get_pageinfo(infile, page: int):
-    pageinfo = {}
-    pageinfo['pageno'] = page
-    pageinfo['images'] = []
-
-    pdf = pypdf.PdfFileReader(infile)
-    page = pdf.pages[page - 1]
-
-    text = page.extractText()
-    pageinfo['has_text'] = (text.strip() != '')
-
-    width_pt = page['/MediaBox'][2] - page['/MediaBox'][0]
-    height_pt = page['/MediaBox'][3] - page['/MediaBox'][1]
-    pageinfo['width_inches'] = width_pt / Decimal(72.0)
-    pageinfo['height_inches'] = height_pt / Decimal(72.0)
-
-    pageinfo['images'] = [im for im in _find_page_images(page, pageinfo)]
-
-    # Look for inline images
-    if _page_has_inline_images(page):
-        raise NotImplementedError(
-            "Warning: input PDF contains inline images - not supported")
-
-    if pageinfo['images']:
-        xres = max(image['dpi_w'] for image in pageinfo['images'])
-        yres = max(image['dpi_h'] for image in pageinfo['images'])
-        pageinfo['xres'], pageinfo['yres'] = xres, yres
-        pageinfo['width_pixels'] = \
-            int(round(xres * pageinfo['width_inches']))
-        pageinfo['height_pixels'] = \
-            int(round(yres * pageinfo['height_inches']))
-
-    return pageinfo
-
-
-def pdf_get_all_pageinfo(infile):
-    pdf = pypdf.PdfFileReader(infile)
-    getcontext().prec = 6
-    return [_pdf_get_pageinfo(infile, n) for n in range(pdf.numPages)]

ocrmypdf/pdfa.py

@@ -1,130 +0,0 @@
-#!/usr/bin/env python3
-# © 2015 James R. Barlow: github.com/jbarlow83
-#
-# Generate a PDFA_def.ps file for Ghostscript >= 9.14
-
-from __future__ import print_function, absolute_import, division
-from string import Template
-from subprocess import Popen, PIPE
-import os
-import codecs
-
-
-# This is a template written in PostScript which is needed to create PDF/A
-# files, from the Ghostscript documentation. Lines beginning with % are
-# comments. Python substitution variables have a '$' prefix.
-pdfa_def_template = u"""%!
-% This is a sample prefix file for creating a PDF/A document.
-% Feel free to modify entries marked with "Customize".
-% This assumes an ICC profile to reside in the file (ISO Coated sb.icc),
-% unless the user modifies the corresponding line below.
-
-% Define entries in the document Info dictionary :
-/ICCProfile ($icc_profile)
-def
-
-[ /Title <$title>
-  /Author <$author>
-  /Subject <$subject>
-  /Keywords <$keywords>
-  /DOCINFO pdfmark
-
-% Define an ICC profile :
-
-[/_objdef {icc_PDFA} /type /stream /OBJ pdfmark
-[{icc_PDFA}
-<<
-  /N currentpagedevice /ProcessColorModel known {
-    currentpagedevice /ProcessColorModel get dup /DeviceGray eq
-    {pop 1} {
-      /DeviceRGB eq
-      {3}{4} ifelse
-    } ifelse
-  } {
-    (ERROR, unable to determine ProcessColorModel) == flush
-  } ifelse
->> /PUT pdfmark
-[{icc_PDFA} ICCProfile (r) file /PUT pdfmark
-
-% Define the output intent dictionary :
-
-[/_objdef {OutputIntent_PDFA} /type /dict /OBJ pdfmark
-[{OutputIntent_PDFA} <<
-  /Type /OutputIntent             % Must be so (the standard requires).
-  /S /GTS_PDFA1                   % Must be so (the standard requires).
-  /DestOutputProfile {icc_PDFA}            % Must be so (see above).
-  /OutputConditionIdentifier ($icc_identifier)
->> /PUT pdfmark
-[{Catalog} <</OutputIntents [ {OutputIntent_PDFA} ]>> /PUT pdfmark
-"""
-
-
-def encode_text_string(s: str) -> str:
-    '''Encode text string to hex string for use in a PDF
-
-    From PDF 32000-1:2008 a string object may be included in hexademical form
-    if it is enclosed in angle brackets.  For general Unicode the string should
-    be UTF-16 (big endian) with byte order marks.  A non-hexademical
-    representation is doable but this is preferable since it allows the output
-    Postscript file to be completely ASCII and no escaping of Postscript
-    characters is necessary.
-    '''
-    if s == '':
-        return ''
-    utf16_bytes = s.encode('utf-16be')
-    ascii_hex_bytes = codecs.encode(b'\xfe\xff' + utf16_bytes, 'hex')
-    ascii_hex_str = ascii_hex_bytes.decode('ascii').lower()
-    return ascii_hex_str
-
-
-def _get_pdfa_def(icc_profile, icc_identifier, pdfmark):
-    pdfmark_utf16 = {k: encode_text_string(v) for k, v in pdfmark.items()}
-
-    t = Template(pdfa_def_template)
-    result = t.substitute(icc_profile=icc_profile,
-                          icc_identifier=icc_identifier,
-                          title=pdfmark_utf16.get('title', ''),
-                          author=pdfmark_utf16.get('author', ''),
-                          subject=pdfmark_utf16.get('subject', ''),
-                          keywords=pdfmark_utf16.get('keywords', ''))
-    return result
-
-
-def _get_postscript_icc_path():
-    "Parse Ghostscript's help message to find where iccprofiles are stored"
-
-    p_gs = Popen(['gs', '--help'], close_fds=True, universal_newlines=True,
-                 stdout=PIPE, stderr=PIPE)
-    out, _ = p_gs.communicate()
-    lines = out.splitlines()
-
-    def search_paths(lines):
-        seeking = True
-        for line in lines:
-            if seeking:
-                if line.startswith('Search path'):
-                    seeking = False
-                    continue
-            else:
-                if line.strip().startswith('/'):
-                    yield from (
-                        path.strip() for path in line.split(':')
-                        if path.strip() != '')
-    for root in search_paths(lines):
-        path = os.path.realpath(os.path.join(root, '../iccprofiles'))
-        if os.path.exists(path):
-            return path
-
-
-def generate_pdfa_def(target_filename, pdfmark, icc='sRGB'):
-    if icc == 'sRGB':
-        icc_profile = os.path.join(_get_postscript_icc_path(), 'srgb.icc')
-    else:
-        raise NotImplementedError("Only supporting sRGB")
-
-    ps = _get_pdfa_def(icc_profile, icc, pdfmark)
-
-    # Since PostScript might not handle UTF-8 (it's hard to get a clear
-    # answer), insist on ascii
-    with open(target_filename, 'w', encoding='ascii') as f:
-        f.write(ps)

ocrmypdf/tesseract.py

@@ -1,61 +0,0 @@
-#!/usr/bin/env python3
-# © 2015 James R. Barlow: github.com/jbarlow83
-
-from subprocess import STDOUT, CalledProcessError, check_output
-import sys
-import os
-import re
-from functools import lru_cache
-
-
-@lru_cache(maxsize=1)
-def version():
-    args_tess = [
-        'tesseract',
-        '--version'
-    ]
-    try:
-        versions = check_output(
-                args_tess, close_fds=True, universal_newlines=True,
-                stderr=STDOUT)
-    except CalledProcessError:
-        print("Could not find Tesseract executable on system PATH.")
-        sys.exit(1)
-
-    tesseract_version = re.match(r'tesseract\s(.+)', versions).group(1)
-    return tesseract_version
-
-
-@lru_cache(maxsize=1)
-def languages():
-    args_tess = [
-        'tesseract',
-        '--list-langs'
-    ]
-    langs = check_output(
-            args_tess, close_fds=True, universal_newlines=True,
-            stderr=STDOUT)
-    return set(lang.strip() for lang in langs.splitlines()[1:])
-
-
-HOCR_TEMPLATE = '''<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
- <head>
-  <title></title>
-  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-  <meta name='ocr-system' content='tesseract 3.02.02' />
-  <meta name='ocr-capabilities' content='ocr_page ocr_carea ocr_par ocr_line ocrx_word'/>
- </head>
- <body>
-  <div class='ocr_page' id='page_1' title='image "x.tif"; bbox 0 0 {0} {1}; ppageno 0'>
-   <div class='ocr_carea' id='block_1_1' title="bbox 0 1 {0} {1}">
-    <p class='ocr_par' dir='ltr' id='par_1' title="bbox 0 1 {0} {1}">
-     <span class='ocr_line' id='line_1' title="bbox 0 1 {0} {1}"><span class='ocrx_word' id='word_1' title="bbox 0 1 {0} {1}"> </span>
-     </span>
-    </p>
-   </div>
-  </div>
- </body>
-</html>'''

ocrmypdf/test/test_pageinfo.py

@@ -1,107 +0,0 @@
-#!/usr/bin/env python3
-# © 2015 James R. Barlow: github.com/jbarlow83
-
-from ocrmypdf import pageinfo
-from reportlab.pdfgen.canvas import Canvas
-from PIL import Image
-from tempfile import NamedTemporaryFile
-from contextlib import suppress
-import os
-import sys
-import shutil
-import pytest
-from pkg_resources import Requirement, resource_filename
-
-req = Requirement.parse('ocrmypdf')
-
-TEST_OUTPUT = os.path.join(os.path.dirname(__file__), 'output')
-
-
-def setup_module():
-    with suppress(FileNotFoundError):
-        shutil.rmtree(TEST_OUTPUT)
-    with suppress(FileExistsError):
-        os.mkdir(TEST_OUTPUT)
-
-
-def test_single_page_text():
-    filename = os.path.join(TEST_OUTPUT, 'text.pdf')
-    pdf = Canvas(filename, pagesize=(8*72, 6*72))
-    text = pdf.beginText()
-    text.setFont('Helvetica', 12)
-    text.setTextOrigin(1*72, 3*72)
-    text.textLine("Methink'st thou art a general offence and every"
-                  " man should beat thee.")
-    pdf.drawText(text)
-    pdf.showPage()
-    pdf.save()
-
-    pdfinfo = pageinfo.pdf_get_all_pageinfo(filename)
-
-    assert len(pdfinfo) == 1
-    page = pdfinfo[0]
-
-    assert page['has_text']
-    assert len(page['images']) == 0
-
-
-def test_single_page_image():
-    filename = os.path.join(TEST_OUTPUT, 'image-mono.pdf')
-    pdf = Canvas(filename, pagesize=(72, 72))
-    with NamedTemporaryFile() as im_tmp:
-        im = Image.new('1', (8, 8), 0)
-        for n in range(8):
-            im.putpixel((n, n), 1)
-        im.save(im_tmp.name, format='PNG')
-        # Draw image in a 72x72 pt or 1"x1" area
-        pdf.drawImage(im_tmp.name, 0, 0, width=72, height=72)
-        pdf.showPage()
-        pdf.save()
-
-    pdfinfo = pageinfo.pdf_get_all_pageinfo(filename)
-
-    assert len(pdfinfo) == 1
-    page = pdfinfo[0]
-
-    assert not page['has_text']
-    assert len(page['images']) == 1
-
-    pdfimage = page['images'][0]
-    assert pdfimage['width'] == 8
-    # assert pdfimage['color'] == 'gray'
-
-    # While unexpected, this is correct
-    # PDF spec says /FlateDecode image must have /BitsPerComponent 8
-    # So mono images get upgraded to 8-bit
-    assert pdfimage['bpc'] == 8
-
-    # DPI in a 1"x1" is the image width
-    assert pdfimage['dpi_w'] == 8
-    assert pdfimage['dpi_h'] == 8
-
-
-def test_single_page_inline_image():
-    filename = os.path.join(TEST_OUTPUT, 'image-mono-inline.pdf')
-    pdf = Canvas(filename, pagesize=(8*72, 6*72))
-    with NamedTemporaryFile() as im_tmp:
-        im = Image.new('1', (8, 8), 0)
-        for n in range(8):
-            im.putpixel((n, n), 1)
-        im.save(im_tmp.name, format='PNG')
-        # Draw image in a 72x72 pt or 1"x1" area
-        pdf.drawInlineImage(im_tmp.name, 0, 0, width=72, height=72)
-        pdf.showPage()
-        pdf.save()
-
-    with pytest.raises(NotImplementedError):
-        pageinfo.pdf_get_all_pageinfo(filename)
-
-
-def test_jpeg():
-    filename = resource_filename(req, 'tests/resources/c02-22.pdf')
-
-    pdfinfo = pageinfo.pdf_get_all_pageinfo(filename)
-
-    pdfimage = pdfinfo[0]['images'][0]
-    assert pdfimage['enc'] == 'jpeg'
-

ocrmypdf/unpaper.py

@@ -1,84 +0,0 @@
-#!/usr/bin/env python3
-# © 2015 James R. Barlow: github.com/jbarlow83
-# unpaper documentation:
-# https://github.com/Flameeyes/unpaper/blob/master/doc/basic-concepts.md
-
-from subprocess import Popen, PIPE
-from tempfile import NamedTemporaryFile
-import sys
-import os
-from functools import lru_cache
-
-
-@lru_cache(maxsize=1)
-def version():
-    args_unpaper = [
-        'unpaper',
-        '--version'
-    ]
-    p_unpaper = Popen(args_unpaper, close_fds=True, universal_newlines=True,
-                      stdout=PIPE, stderr=PIPE)
-    version, _ = p_unpaper.communicate(timeout=5)
-
-    return version.strip()
-
-
-try:
-    from PIL import Image
-except ImportError:
-    print("Could not find Python3 imaging library", file=sys.stderr)
-    raise
-
-
-def run(input_file, output_file, dpi, log, mode_args):
-    args_unpaper = [
-        'unpaper',
-        '-v',
-        '--dpi', str(dpi)
-    ] + mode_args
-
-    SUFFIXES = {'1': '.pbm', 'L': '.pgm', 'RGB': '.ppm'}
-    suffix = ''
-
-    im = Image.open(input_file)
-    suffix = SUFFIXES[im.mode]
-    with NamedTemporaryFile(suffix=suffix) as input_pnm, \
-            NamedTemporaryFile(suffix=suffix, mode="r+b") as output_pnm:
-        im.save(input_pnm, format='PPM')
-        im.close()
-
-        os.unlink(output_pnm.name)
-
-        args_unpaper.extend([input_pnm.name, output_pnm.name])
-        p_unpaper = Popen(
-            args_unpaper, close_fds=True,
-            universal_newlines=True, stdout=PIPE, stderr=PIPE
-            )
-        out, err = p_unpaper.communicate()
-        log.debug(out)
-        log.debug(err)
-
-        Image.open(output_pnm.name).save(output_file)
-
-
-def deskew(input_file, output_file, dpi, log):
-    run(input_file, output_file, dpi, log, [
-        '--mask-scan-size', '100',  # don't blank out narrow columns
-        '--no-border-align',  # don't align visible content to borders
-        '--no-mask-center',   # don't center visible content within page
-        '--no-grayfilter',    # don't remove light gray areas
-        '--no-blackfilter',   # don't remove solid black areas
-        '--no-noisefilter',   # don't remove salt and pepper noise
-        '--no-blurfilter'     # don't remove blurry objects/debris
-    ])
-
-
-def clean(input_file, output_file, dpi, log):
-    run(input_file, output_file, dpi, log, [
-        '--mask-scan-size', '100',  # don't blank out narrow columns
-        '--no-border-align',  # don't align visible content to borders
-        '--no-mask-center',   # don't center visible content within page
-        '--no-grayfilter',    # don't remove light gray areas
-        '--no-blackfilter',   # don't remove solid black areas
-        '--no-deskew',        # don't deskew
-    ])

pipeline.svg

@@ -1,235 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
- "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
-<!-- Generated by graphviz version 2.38.0 (20140413.2041)
- -->
-<!-- Title: Pipeline: Pages: 1 -->
-<svg width="728pt" height="651pt"
- viewBox="0.00 0.00 728.00 650.53" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
-<g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(4 646.53)">
-<title>Pipeline:</title>
-<polygon fill="white" stroke="none" points="-4,4 -4,-646.53 724,-646.53 724,4 -4,4"/>
-<g id="clust1" class="cluster"><title>clustertasks</title>
-<polygon fill="none" stroke="black" points="8,-8 8,-634.53 712,-634.53 712,-8 8,-8"/>
-<text text-anchor="middle" x="360" y="-606.53" font-family="Times,serif" font-size="30.00" fill="#ff3232">Pipeline:</text>
-</g>
-<!-- t0 -->
-<g id="node1" class="node"><title>t0</title>
-<polygon fill="#efa03b" stroke="#006000" points="481.791,-588.53 386.209,-588.53 382.209,-584.53 382.209,-552.53 477.791,-552.53 481.791,-556.53 481.791,-588.53"/>
-<polyline fill="none" stroke="#006000" points="477.791,-584.53 382.209,-584.53 "/>
-<polyline fill="none" stroke="#006000" points="477.791,-584.53 477.791,-552.53 "/>
-<polyline fill="none" stroke="#006000" points="477.791,-584.53 481.791,-588.53 "/>
-<text text-anchor="middle" x="432" y="-564.53" font-family="Times,serif" font-size="20.00" fill="#006000">repair_pdf</text>
-</g>
-<!-- t1 -->
-<g id="node2" class="node"><title>t1</title>
-<polygon fill="#efa03b" stroke="black" points="466.782,-509.564 374,-526.497 281.218,-509.564 281.304,-482.165 466.696,-482.165 466.782,-509.564"/>
-<polygon fill="none" stroke="black" points="470.799,-512.902 374,-530.569 277.201,-512.902 277.311,-478.159 470.689,-478.159 470.799,-512.902"/>
-<text text-anchor="middle" x="374" y="-495.991" font-family="Times,serif" font-size="20.00">split_pages</text>
-</g>
-<!-- t0&#45;&gt;t1 -->
-<g id="edge1" class="edge"><title>t0&#45;&gt;t1</title>
-<path fill="none" stroke="gray" d="M417.064,-552.394C412.296,-546.925 406.86,-540.689 401.493,-534.532"/>
-<polygon fill="gray" stroke="gray" points="403.996,-532.077 394.787,-526.838 398.719,-536.676 403.996,-532.077"/>
-</g>
-<!-- t10 -->
-<g id="node12" class="node"><title>t10</title>
-<polygon fill="#efa03b" stroke="#006000" points="704.338,-451.452 493.662,-451.452 489.662,-447.452 489.662,-415.452 700.338,-415.452 704.338,-419.452 704.338,-451.452"/>
-<polyline fill="none" stroke="#006000" points="700.338,-447.452 489.662,-447.452 "/>
-<polyline fill="none" stroke="#006000" points="700.338,-447.452 700.338,-415.452 "/>
-<polyline fill="none" stroke="#006000" points="700.338,-447.452 704.338,-451.452 "/>
-<text text-anchor="middle" x="597" y="-427.452" font-family="Times,serif" font-size="20.00" fill="#006000">generate_postscript_stub</text>
-</g>
-<!-- t0&#45;&gt;t10 -->
-<g id="edge16" class="edge"><title>t0&#45;&gt;t10</title>
-<path fill="none" stroke="gray" d="M453.048,-552.468C461.441,-545.654 471.185,-537.73 480,-530.53 510.227,-505.84 544.753,-477.467 568.421,-457.99"/>
-<polygon fill="gray" stroke="gray" points="570.818,-460.55 576.315,-451.493 566.369,-455.146 570.818,-460.55"/>
-</g>
-<!-- t2 -->
-<g id="node3" class="node"><title>t2</title>
-<polygon fill="#efa03b" stroke="black" points="451.555,-451.452 228.445,-451.452 224.445,-447.452 224.445,-415.452 447.555,-415.452 451.555,-419.452 451.555,-451.452"/>
-<polyline fill="none" stroke="black" points="447.555,-447.452 224.445,-447.452 "/>
-<polyline fill="none" stroke="black" points="447.555,-447.452 447.555,-415.452 "/>
-<polyline fill="none" stroke="black" points="447.555,-447.452 451.555,-451.452 "/>
-<text text-anchor="middle" x="338" y="-427.452" font-family="Times,serif" font-size="20.00">rasterize_with_ghostscript</text>
-</g>
-<!-- t1&#45;&gt;t2 -->
-<g id="edge2" class="edge"><title>t1&#45;&gt;t2</title>
-<path fill="none" stroke="#0044a0" d="M361.611,-478.092C358.514,-472.369 355.171,-466.19 352.003,-460.333"/>
-<polygon fill="#0044a0" stroke="#0044a0" points="355.064,-458.636 347.227,-451.506 348.907,-461.967 355.064,-458.636"/>
-</g>
-<!-- t11 -->
-<g id="node10" class="node"><title>t11</title>
-<polygon fill="#efa03b" stroke="black" points="644.594,-393.452 551.406,-393.452 547.406,-389.452 547.406,-357.452 640.594,-357.452 644.594,-361.452 644.594,-393.452"/>
-<polyline fill="none" stroke="black" points="640.594,-389.452 547.406,-389.452 "/>
-<polyline fill="none" stroke="black" points="640.594,-389.452 640.594,-357.452 "/>
-<polyline fill="none" stroke="black" points="640.594,-389.452 644.594,-393.452 "/>
-<text text-anchor="middle" x="596" y="-369.452" font-family="Times,serif" font-size="20.00">skip_page</text>
-</g>
-<!-- t1&#45;&gt;t11 -->
-<g id="edge13" class="edge"><title>t1&#45;&gt;t11</title>
-<path fill="none" stroke="#0044a0" d="M425.139,-478.007C437.834,-470.731 450.731,-461.83 461,-451.452 473.874,-438.442 466.946,-427.178 481,-415.452 490.212,-407.766 513.965,-399.205 537.508,-392.067"/>
-<polygon fill="#0044a0" stroke="#0044a0" points="538.592,-395.396 547.189,-389.203 536.607,-388.683 538.592,-395.396"/>
-</g>
-<!-- t9 -->
-<g id="node11" class="node"><title>t9</title>
-<polygon fill="#efa03b" stroke="black" points="272.496,-277.452 19.5039,-277.452 15.5039,-273.452 15.5039,-241.452 268.496,-241.452 272.496,-245.452 272.496,-277.452"/>
-<polyline fill="none" stroke="black" points="268.496,-273.452 15.5039,-273.452 "/>
-<polyline fill="none" stroke="black" points="268.496,-273.452 268.496,-241.452 "/>
-<polyline fill="none" stroke="black" points="268.496,-273.452 272.496,-277.452 "/>
-<text text-anchor="middle" x="144" y="-253.452" font-family="Times,serif" font-size="20.00">tesseract_ocr_and_render_pdf</text>
-</g>
-<!-- t1&#45;&gt;t9 -->
-<g id="edge15" class="edge"><title>t1&#45;&gt;t9</title>
-<path fill="none" stroke="#0044a0" d="M277.341,-486.044C254.708,-478.702 232.21,-467.759 215,-451.452 168.207,-407.114 152.056,-329.127 146.633,-287.855"/>
-<polygon fill="#0044a0" stroke="#0044a0" points="150.084,-287.235 145.422,-277.721 143.133,-288.065 150.084,-287.235"/>
-</g>
-<!-- t3 -->
-<g id="node4" class="node"><title>t3</title>
-<polygon fill="#efa03b" stroke="black" points="458.999,-393.452 291.001,-393.452 287.001,-389.452 287.001,-357.452 454.999,-357.452 458.999,-361.452 458.999,-393.452"/>
-<polyline fill="none" stroke="black" points="454.999,-389.452 287.001,-389.452 "/>
-<polyline fill="none" stroke="black" points="454.999,-389.452 454.999,-357.452 "/>
-<polyline fill="none" stroke="black" points="454.999,-389.452 458.999,-393.452 "/>
-<text text-anchor="middle" x="373" y="-369.452" font-family="Times,serif" font-size="20.00">preprocess_deskew</text>
-</g>
-<!-- t2&#45;&gt;t3 -->
-<g id="edge3" class="edge"><title>t2&#45;&gt;t3</title>
-<path fill="none" stroke="#0044a0" d="M348.691,-415.346C351.337,-411.112 354.23,-406.485 357.066,-401.946"/>
-<polygon fill="#0044a0" stroke="#0044a0" points="360.042,-403.788 362.374,-393.453 354.106,-400.078 360.042,-403.788"/>
-</g>
-<!-- t6 -->
-<g id="node6" class="node"><title>t6</title>
-<polygon fill="#efa03b" stroke="black" points="664.375,-277.452 477.625,-277.452 473.625,-273.452 473.625,-241.452 660.375,-241.452 664.375,-245.452 664.375,-277.452"/>
-<polyline fill="none" stroke="black" points="660.375,-273.452 473.625,-273.452 "/>
-<polyline fill="none" stroke="black" points="660.375,-273.452 660.375,-241.452 "/>
-<polyline fill="none" stroke="black" points="660.375,-273.452 664.375,-277.452 "/>
-<text text-anchor="middle" x="569" y="-253.452" font-family="Times,serif" font-size="20.00">select_image_for_pdf</text>
-</g>
-<!-- t2&#45;&gt;t6 -->
-<g id="edge7" class="edge"><title>t2&#45;&gt;t6</title>
-<path fill="none" stroke="#0044a0" d="M423.032,-415.374C438.812,-409.925 454.543,-402.785 468,-393.452 508.201,-365.571 539.287,-316.662 555.808,-286.558"/>
-<polygon fill="#0044a0" stroke="#0044a0" points="559.024,-287.965 560.653,-277.496 552.851,-284.664 559.024,-287.965"/>
-</g>
-<!-- t4 -->
-<g id="node5" class="node"><title>t4</title>
-<polygon fill="#efa03b" stroke="black" points="449.705,-335.452 300.295,-335.452 296.295,-331.452 296.295,-299.452 445.705,-299.452 449.705,-303.452 449.705,-335.452"/>
-<polyline fill="none" stroke="black" points="445.705,-331.452 296.295,-331.452 "/>
-<polyline fill="none" stroke="black" points="445.705,-331.452 445.705,-299.452 "/>
-<polyline fill="none" stroke="black" points="445.705,-331.452 449.705,-335.452 "/>
-<text text-anchor="middle" x="373" y="-311.452" font-family="Times,serif" font-size="20.00">preprocess_clean</text>
-</g>
-<!-- t3&#45;&gt;t4 -->
-<g id="edge4" class="edge"><title>t3&#45;&gt;t4</title>
-<path fill="none" stroke="#0044a0" d="M373,-357.346C373,-353.655 373,-349.665 373,-345.695"/>
-<polygon fill="#0044a0" stroke="#0044a0" points="376.5,-345.453 373,-335.453 369.5,-345.453 376.5,-345.453"/>
-</g>
-<!-- t3&#45;&gt;t6 -->
-<g id="edge6" class="edge"><title>t3&#45;&gt;t6</title>
-<path fill="none" stroke="#0044a0" d="M414.399,-357.412C428.785,-351.039 444.852,-343.405 459,-335.452 466.909,-331.007 506.49,-303.805 535.921,-283.431"/>
-<polygon fill="#0044a0" stroke="#0044a0" points="538.073,-286.198 544.299,-277.625 534.086,-280.444 538.073,-286.198"/>
-</g>
-<!-- t4&#45;&gt;t6 -->
-<g id="edge5" class="edge"><title>t4&#45;&gt;t6</title>
-<path fill="none" stroke="#0044a0" d="M432.605,-299.422C453.701,-293.395 477.617,-286.561 499.465,-280.319"/>
-<polygon fill="#0044a0" stroke="#0044a0" points="500.687,-283.61 509.341,-277.497 498.764,-276.879 500.687,-283.61"/>
-</g>
-<!-- t5 -->
-<g id="node7" class="node"><title>t5</title>
-<polygon fill="#efa03b" stroke="black" points="455.922,-277.452 294.078,-277.452 290.078,-273.452 290.078,-241.452 451.922,-241.452 455.922,-245.452 455.922,-277.452"/>
-<polyline fill="none" stroke="black" points="451.922,-273.452 290.078,-273.452 "/>
-<polyline fill="none" stroke="black" points="451.922,-273.452 451.922,-241.452 "/>
-<polyline fill="none" stroke="black" points="451.922,-273.452 455.922,-277.452 "/>
-<text text-anchor="middle" x="373" y="-253.452" font-family="Times,serif" font-size="20.00">ocr_tesseract_hocr</text>
-</g>
-<!-- t4&#45;&gt;t5 -->
-<g id="edge8" class="edge"><title>t4&#45;&gt;t5</title>
-<path fill="none" stroke="#0044a0" d="M373,-299.346C373,-295.655 373,-291.665 373,-287.695"/>
-<polygon fill="#0044a0" stroke="#0044a0" points="376.5,-287.453 373,-277.453 369.5,-287.453 376.5,-287.453"/>
-</g>
-<!-- t4&#45;&gt;t9 -->
-<g id="edge14" class="edge"><title>t4&#45;&gt;t9</title>
-<path fill="none" stroke="#0044a0" d="M303.36,-299.422C278.157,-293.259 249.509,-286.253 223.521,-279.898"/>
-<polygon fill="#0044a0" stroke="#0044a0" points="224.249,-276.473 213.704,-277.497 222.586,-283.273 224.249,-276.473"/>
-</g>
-<!-- t7 -->
-<g id="node8" class="node"><title>t7</title>
-<polygon fill="#efa03b" stroke="black" points="426.366,-219.452 269.634,-219.452 265.634,-215.452 265.634,-183.452 422.366,-183.452 426.366,-187.452 426.366,-219.452"/>
-<polyline fill="none" stroke="black" points="422.366,-215.452 265.634,-215.452 "/>
-<polyline fill="none" stroke="black" points="422.366,-215.452 422.366,-183.452 "/>
-<polyline fill="none" stroke="black" points="422.366,-215.452 426.366,-219.452 "/>
-<text text-anchor="middle" x="346" y="-195.452" font-family="Times,serif" font-size="20.00">render_hocr_page</text>
-</g>
-<!-- t6&#45;&gt;t7 -->
-<g id="edge9" class="edge"><title>t6&#45;&gt;t7</title>
-<path fill="none" stroke="#0044a0" d="M501.184,-241.422C476.75,-235.286 448.99,-228.315 423.772,-221.982"/>
-<polygon fill="#0044a0" stroke="#0044a0" points="424.429,-218.538 413.877,-219.497 422.724,-225.328 424.429,-218.538"/>
-</g>
-<!-- t8 -->
-<g id="node9" class="node"><title>t8</title>
-<polygon fill="#efa03b" stroke="black" points="663.742,-219.452 448.258,-219.452 444.258,-215.452 444.258,-183.452 659.742,-183.452 663.742,-187.452 663.742,-219.452"/>
-<polyline fill="none" stroke="black" points="659.742,-215.452 444.258,-215.452 "/>
-<polyline fill="none" stroke="black" points="659.742,-215.452 659.742,-183.452 "/>
-<polyline fill="none" stroke="black" points="659.742,-215.452 663.742,-219.452 "/>
-<text text-anchor="middle" x="554" y="-195.452" font-family="Times,serif" font-size="20.00">render_hocr_debug_page</text>
-</g>
-<!-- t6&#45;&gt;t8 -->
-<g id="edge11" class="edge"><title>t6&#45;&gt;t8</title>
-<path fill="none" stroke="#0044a0" d="M564.418,-241.346C563.4,-237.546 562.298,-233.43 561.203,-229.345"/>
-<polygon fill="#0044a0" stroke="#0044a0" points="564.522,-228.207 558.554,-219.453 557.761,-230.018 564.522,-228.207"/>
-</g>
-<!-- t5&#45;&gt;t7 -->
-<g id="edge10" class="edge"><title>t5&#45;&gt;t7</title>
-<path fill="none" stroke="#0044a0" d="M364.752,-241.346C362.816,-237.329 360.708,-232.958 358.629,-228.645"/>
-<polygon fill="#0044a0" stroke="#0044a0" points="361.693,-226.941 354.197,-219.453 355.387,-229.981 361.693,-226.941"/>
-</g>
-<!-- t5&#45;&gt;t8 -->
-<g id="edge12" class="edge"><title>t5&#45;&gt;t8</title>
-<path fill="none" stroke="#0044a0" d="M428.289,-241.346C447.587,-235.375 469.416,-228.622 489.404,-222.437"/>
-<polygon fill="#0044a0" stroke="#0044a0" points="490.53,-225.753 499.049,-219.453 488.461,-219.065 490.53,-225.753"/>
-</g>
-<!-- t12 -->
-<g id="node13" class="node"><title>t12</title>
-<polygon fill="#efa03b" stroke="black" points="473.845,-105.456 554,-78.0208 634.155,-105.456 634.08,-149.848 473.92,-149.848 473.845,-105.456"/>
-<polygon fill="none" stroke="black" points="469.836,-102.581 554,-73.7729 638.164,-102.581 638.078,-153.869 469.922,-153.869 469.836,-102.581"/>
-<text text-anchor="middle" x="554" y="-111.726" font-family="Times,serif" font-size="20.00">merge_pages</text>
-</g>
-<!-- t7&#45;&gt;t12 -->
-<g id="edge20" class="edge"><title>t7&#45;&gt;t12</title>
-<path fill="none" stroke="#0044a0" d="M389.35,-183.419C409.937,-175.33 435.398,-165.326 460.092,-155.624"/>
-<polygon fill="#0044a0" stroke="#0044a0" points="461.479,-158.839 469.507,-151.924 458.919,-152.324 461.479,-158.839"/>
-</g>
-<!-- t8&#45;&gt;t12 -->
-<g id="edge19" class="edge"><title>t8&#45;&gt;t12</title>
-<path fill="none" stroke="#0044a0" d="M554,-183.12C554,-177.585 554,-171.177 554,-164.592"/>
-<polygon fill="#0044a0" stroke="#0044a0" points="557.5,-164.201 554,-154.201 550.5,-164.201 557.5,-164.201"/>
-</g>
-<!-- t11&#45;&gt;t12 -->
-<g id="edge17" class="edge"><title>t11&#45;&gt;t12</title>
-<path fill="none" stroke="#0044a0" d="M615.939,-357.13C634.767,-339.333 661.745,-309.733 673,-277.452 686.754,-238.003 694.347,-219.364 673,-183.452 666.345,-172.256 656.999,-162.875 646.44,-155.047"/>
-<polygon fill="#0044a0" stroke="#0044a0" points="648.378,-152.132 638.152,-149.36 644.417,-157.904 648.378,-152.132"/>
-</g>
-<!-- t9&#45;&gt;t12 -->
-<g id="edge18" class="edge"><title>t9&#45;&gt;t12</title>
-<path fill="none" stroke="#0044a0" d="M164.711,-241.235C186.394,-224.08 222.088,-198.224 257,-183.452 321.895,-155.994 399.893,-139.571 459.67,-130.141"/>
-<polygon fill="#0044a0" stroke="#0044a0" points="460.504,-133.554 469.855,-128.574 459.439,-126.635 460.504,-133.554"/>
-</g>
-<!-- t10&#45;&gt;t12 -->
-<g id="edge22" class="edge"><title>t10&#45;&gt;t12</title>
-<path fill="none" stroke="gray" d="M629.379,-415.337C660.552,-396.255 703,-362.233 703,-318.452 703,-318.452 703,-318.452 703,-258.452 703,-224.066 705.581,-210.223 684,-183.452 673.976,-171.017 660.952,-160.773 647.026,-152.396"/>
-<polygon fill="gray" stroke="gray" points="648.682,-149.312 638.258,-147.419 645.227,-155.4 648.682,-149.312"/>
-</g>
-<!-- t13 -->
-<g id="node14" class="node"><title>t13</title>
-<polygon fill="#efa03b" stroke="black" points="616.338,-52 495.662,-52 491.662,-48 491.662,-16 612.338,-16 616.338,-20 616.338,-52"/>
-<polyline fill="none" stroke="black" points="612.338,-48 491.662,-48 "/>
-<polyline fill="none" stroke="black" points="612.338,-48 612.338,-16 "/>
-<polyline fill="none" stroke="black" points="612.338,-48 616.338,-52 "/>
-<text text-anchor="middle" x="554" y="-28" font-family="Times,serif" font-size="20.00">validate_pdfa</text>
-</g>
-<!-- t12&#45;&gt;t13 -->
-<g id="edge21" class="edge"><title>t12&#45;&gt;t13</title>
-<path fill="none" stroke="#0044a0" d="M554,-73.9482C554,-69.9654 554,-66.007 554,-62.2247"/>
-<polygon fill="#0044a0" stroke="#0044a0" points="557.5,-62.1573 554,-52.1573 550.5,-62.1574 557.5,-62.1573"/>
-</g>
-</g>
-</svg>

pyproject.toml

@@ -0,0 +1,80 @@
+[build-system]
+requires = [
+  "setuptools >= 30.3.0",
+  "wheel",
+  "setuptools_scm[toml] >= 3.4",
+  "setuptools_scm_git_archive"
+]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools_scm]
+version_scheme = "post-release"
+
+[tool.black]
+line-length = 88
+target-version = ["py36", "py37", "py38"]
+skip-string-normalization = true
+include = '\.pyi?$'
+exclude = '''
+/(
+    \.eggs
+  | \.git
+  | \.hg
+  | \.mypy_cache
+  | \.tox
+  | \.venv
+  | _build
+  | buck-out
+  | build
+  | dist
+  | docs
+  | misc
+  | \.egg-info
+)/
+'''
+
+[tool.coverage.run]
+branch = true
+parallel = true
+concurrency = ["multiprocessing"]
+
+[tool.coverage.paths]
+source = ["src/ocrmypdf"]
+
+[tool.coverage.report]
+# Regexes for lines to exclude from consideration
+exclude_lines = [
+    # Have to re-enable the standard pragma
+    "pragma: no cover",
+
+    # Don't complain if tests don't hit defensive assertion code:
+    "raise AssertionError",
+    "raise NotImplementedError",
+
+    # Don't complain if non-runnable code isn't run:
+    "if 0:",
+	  "if False:",
+    "if __name__ == .__main__.:",
+    "if TYPE_CHECKING:"
+]
+
+[tool.isort]
+profile = "black"
+known_first_party = "ocrmypdf"
+known_third_party = ["PIL", "flask", "img2pdf", "ocrmypdf", "pdfminer", "pikepdf", "pkg_resources", "pluggy", "pytest", "reportlab", "setuptools", "sphinx_rtd_theme", "tqdm", "watchdog", "werkzeug"]
+
+[tool.pytest.ini_options]
+minversion = "6.0"
+norecursedirs = ["lib", ".pc", ".git", "venv", "output", "cache", "resources"]
+testpaths = ["tests"]
+addopts = "-n auto"
+markers = ["slow"]
+filterwarnings = ["ignore:.*XMLParser.*:DeprecationWarning"]
+
+[tool.mypy]
+
+[[tool.mypy.overrides]]
+module = [
+  'pluggy', 'tqdm', 'coloredlogs', 'img2pdf', 'pdfminer.*', 'reportlab.*'
+]
+ignore_missing_imports = true

setup.cfg

@@ -1,2 +1,112 @@
+[metadata]
+name = ocrmypdf
+description = OCRmyPDF adds an OCR text layer to scanned PDF files, allowing them to be searched
+long_description = file: README.md
+long_description_content_type = text/markdown
+url = https://github.com/jbarlow83/OCRmyPDF
+author = James R. Barlow
+author_email = james@purplerock.ca
+license = MPL-2.0
+license_file = LICENSE
+license_files =
+    LICENSE
+classifiers =
+    Development Status :: 5 - Production/Stable
+    Environment :: Console
+    Intended Audience :: End Users/Desktop
+    Intended Audience :: Science/Research
+    Intended Audience :: System Administrators
+    License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
+    Operating System :: MacOS :: MacOS X
+    Operating System :: Microsoft :: Windows :: Windows 10
+    Operating System :: POSIX
+    Operating System :: POSIX :: BSD
+    Operating System :: POSIX :: Linux
+    Programming Language :: Python :: 3
+    Programming Language :: Python :: 3 :: Only
+    Programming Language :: Python :: 3.7
+    Programming Language :: Python :: 3.8
+    Programming Language :: Python :: 3.9
+    Programming Language :: Python :: 3.10
+    Topic :: Scientific/Engineering :: Image Recognition
+    Topic :: Text Processing :: Indexing
+    Topic :: Text Processing :: Linguistic
+keywords =
+    PDF
+    OCR
+    optical character recognition
+    PDF/A
+    scanning
+project_urls =
+    Documentation = https://ocrmypdf.readthedocs.io/
+    Source = https://github.com/jbarlow83/ocrmypdf
+    Tracker = https://github.com/jbarlow83/ocrmypdf/issues
+
+[options]
+packages = find:
+install_requires =
+    Pillow>=8.2.0
+    coloredlogs>=14.0  # strictly optional
+    img2pdf>=0.3.0,<0.5  # pure Python
+    pdfminer.six!=20200720,>=20191110,<=20211012
+    pikepdf>=4.0.0
+    pluggy>=0.13.0,<2
+    reportlab>=3.5.66
+    tqdm>=4
+    importlib-metadata>=4;python_version<'3.8'  # until Python 3.8
+    importlib-resources>=5;python_version<'3.9'  # until Python 3.9
+python_requires = >=3.7
+include_package_data = True
+package_dir =
+    =src
+platforms = any
+setup_requires =
+    setuptools-scm
+    setuptools-scm-git-archive
+zip_safe = False
+
+[options.packages.find]
+where = src
+
+[options.entry_points]
+console_scripts =
+    ocrmypdf = ocrmypdf.__main__:run
+
+[options.extras_require]
+docs =
+    sphinx
+    sphinx-issues
+    sphinx-rtd-theme
+extended_test =
+    PyMuPDF==1.19.1
+test =
+    coverage[toml]>=5
+    pytest>=6.0.0
+    pytest-cov>=2.11.1
+    pytest-xdist>=2.2.0
+    python-xmp-toolkit==2.0.1  # also requires apt-get install libexempi3
+watcher =
+    watchdog>=1.0.2,<3
+webservice =
+    Flask>=1,<3
+
+[options.package_data]
+ocrmypdf =
+    data/sRGB.icc
+    py.typed
+
 [bdist_wheel]
-python-tag = py34
+python-tag = py37
+
+[aliases]
+test = pytest
+
+[check-manifest]
+ignore =
+    .github
+
+[flake8]
+ignore = D203,F401,W503,E501,E203,F841
+exclude = .git,__pycache__,docs/conf.py,build,dist,.venv,.venvpp,.eggs,tmp,src/ocrmypdf/lib/
+max-complexity = 10
+max-line-length = 100

setup.py

@@ -1,214 +1,17 @@
-#!/usr/bin/env python3
-# © 2015 James R. Barlow: github.com/jbarlow83
+# © 2021 James R. Barlow: github.com/jbarlow83
+#
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
 
 from setuptools import setup
-from subprocess import Popen, STDOUT, check_output, CalledProcessError
-from string import Template
-import re
-import sys
-
-
-missing_program = '''
-The program '{program}' could not be executed or was not found on your
-system PATH.
-'''
-
-unknown_version = '''
-OCRmyPDF requires '{program}' {need_version} or higher.  Your system has
-'{program}' but we cannot tell what version is installed.  Contact the
-package maintainer.
-'''
-
-old_version = '''
-OCRmyPDF requires '{program}' {need_version} or higher.  Your system appears
-to have {found_version}.  Please update this program.
-'''
-
-okay_its_optional = '''
-This program is OPTIONAL, so installation of OCRmyPDF can proceed, but
-some functionality may be missing.
-'''
-
-not_okay_its_required = '''
-This program is REQUIRED for OCRmyPDF to work.  Installation will abort.
-'''
-
-osx_install_advice = '''
-If you have homebrew installed, try these command to install the missing
-packages:
-    brew update
-    brew upgrade
-    brew install {package}
-'''
-
-linux_install_advice = '''
-On systems with the aptitude package manager (Debian, Ubuntu), try these
-commands:
-    sudo apt-get update
-    sudo apt-get install {package}
-
-On RPM-based systems (Red Hat, Fedora), search for instructions on
-installing the RPM for {package}.
-'''
-
-
-def _error_trailer(program, package, optional):
-    if program == 'java':
-        return  # You're fucked
-
-    if optional:
-        print(okay_its_optional.format(**locals()), file=sys.stderr)
-    else:
-        print(not_okay_its_required.format(**locals()), file=sys.stderr)
-    if sys.platform.startswith('darwin'):
-        print(osx_install_advice.format(**locals()), file=sys.stderr)
-    elif sys.platform.startswith('linux'):
-        print(linux_install_advice.format(**locals()), file=sys.stderr)
-
-
-def error_missing_program(
-        program,
-        package,
-        optional
-        ):
-    print(missing_program.format(**locals()), file=sys.stderr)
-    _error_trailer(**locals())
-
-
-def error_unknown_version(
-        program,
-        package,
-        optional
-        ):
-    print(unknown_version.format(**locals()), file=sys.stderr)
-    _error_trailer(**locals())
-
-
-def error_old_version(
-        program,
-        package,
-        optional,
-        need_version
-        ):
-    print(old_version.format(**locals()), file=sys.stderr)
-    _error_trailer(**locals())
-
-
-def check_external_program(
-        program,
-        minimum_version,
-        package,
-        version_check_args=['--version'],
-        version_scrape_regex=re.compile(r'(\d+\.\d+(?:\.\d+)?)'),
-        optional=False):
-
-    print('Checking for {program} >= {minimum_version}...'.format(
-            program=program, minimum_version=minimum_version))
-    try:
-        result = check_output(
-                [program] + version_check_args,
-                universal_newlines=True, stderr=STDOUT)
-    except CalledProcessError:
-        error_missing_program(program, package, optional)
-        if not optional:
-            sys.exit(1)
-
-    try:
-        version = version_scrape_regex.search(result).group(1)
-    except AttributeError:
-        error_unknown_version(program, package, optional, minimum_version)
-        if not optional:
-            sys.exit(1)
-
-    if version < minimum_version:
-        error_old_version(program, package, optional, minimum_version)
-
-    print('Found {program} {version}'.format(
-            program=program, version=version))
-
-command = next((arg for arg in sys.argv[1:] if not arg.startswith('-')), '')
-
-if command.startswith('install') or \
-        command in ['check', 'test', 'nosetests', 'easy_install', 'egg_info']:
-    check_external_program(
-        program='tesseract',
-        minimum_version='3.02.02',
-        package='tesseract'
-    )
-    check_external_program(
-        program='gs',
-        minimum_version='9.14',
-        package='ghostscript'
-    )
-    check_external_program(
-        program='unpaper',
-        minimum_version='6.1',
-        package='unpaper',
-        optional=True
-    )
-    # Deprecated
-    check_external_program(
-        program='pdfseparate',
-        minimum_version='0.29.0',
-        package='poppler',
-        version_check_args=['-v']
-    )
-    check_external_program(
-        program='java',
-        minimum_version='1.5.0',
-        package='Java Runtime Environment',
-        version_check_args=['-version']
-    )
-    check_external_program(
-        program='mutool',
-        minimum_version='1.7a',
-        version_check_args=['-v'],
-        version_scrape_regex=re.compile(r'(\d+\.\d+[a-z]+)'),
-        package='mupdf-tools'
-    )
 
+# Minimal setup to support older setuptools/setuptools_scm
 setup(
-    name='ocrmypdf',
-    version='3.0rc2',
-    description='OCRmyPDF adds an OCR text layer to scanned PDF files, allowing them to be searched',
-    url='https://github.com/fritz-hh/OCRmyPDF',
-    author='J. R. Barlow',
-    author_email='jim@purplerock.ca',
-    license='Public Domain',
-    packages=['ocrmypdf'],
-    keywords=['PDF', 'OCR', 'optical character recognition', 'PDF/A', 'scanning'],
-    classifiers=[
-        "Programming Language :: Python :: 3",
-        "Development Status :: 4 - Beta",
-        "Environment :: Console",
-        "Intended Audience :: End Users/Desktop",
-        "Intended Audience :: Science/Research",
-        "Intended Audience :: System Administrators",
-        "License :: Public Domain",
-        "Operating System :: MacOS :: MacOS X",
-        "Operating System :: POSIX",
-        "Operating System :: POSIX :: BSD",
-        "Operating System :: POSIX :: Linux",
-        "Topic :: Scientific/Engineering :: Image Recognition",
-        "Topic :: Text Processing :: Indexing",
-        "Topic :: Text Processing :: Linguistic",
-        ],
-    install_requires=[
-        'ruffus>=2.6.3',
-        'Pillow>=2.7.0',
-        'lxml>=3.4.2',
-        'reportlab>=3.1.44',
-        'PyPDF2>=1.25.1'
+    setup_requires=[  # can be removed whenever we can drop pip 9 support
+        'setuptools_scm',  # so that version will work
+        'setuptools_scm_git_archive',  # enable version from github tarballs
     ],
-    entry_points={
-        'console_scripts': [
-            'ocrmypdf = ocrmypdf.main:run_pipeline'
-        ],
-    },
-    eager_resources=[
-        'ocrmypdf/jhove/bin/*.jar',
-        'ocrmypdf/jhove/conf/*.conf',
-        'ocrmypdf/jhove/lib/*.jar'
-    ],
-    include_package_data=True,
-    zip_safe=False)
+    use_scm_version={'version_scheme': 'post-release'},
+)

src/ocrmypdf/RELEASE.md

@@ -0,0 +1,35 @@
+# Release checklist
+
+## Patch release
+
+- Check `pytest`
+
+- Update release notes
+
+## Minor release
+
+## Major release
+
+- Run `pre-commit autoupdate`
+
+- Check README.md
+
+- Check setup.py
+
+    - Are classifiers up to date?
+    - Is `python_requires` correct?
+    - Python 3.6 is EOL on December 2021-12. Could drop support then.
+    - Can we tighten any `install_requires` dependencies?
+
+- Search for old version shims we can remove
+
+    - "shim"
+    - ` pikepdf.__version__`
+
+- Search for deprecation: search all files for deprec*, etc.
+
+- Check requirements in setup.cfg
+
+- Delete `tests/cache`, do `pytest --runslow`, and update cache.
+
+- Do `pytest --cov-report html`

src/ocrmypdf/__init__.py

@@ -0,0 +1,32 @@
+# © 2017 James R. Barlow: github.com/jbarlow83
+#
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+
+from pluggy import HookimplMarker as _HookimplMarker
+
+from ocrmypdf import helpers, hocrtransform, pdfa, pdfinfo
+from ocrmypdf._concurrent import Executor
+from ocrmypdf._jobcontext import PageContext, PdfContext
+from ocrmypdf._version import PROGRAM_NAME, __version__
+from ocrmypdf.api import Verbosity, configure_logging, ocr
+from ocrmypdf.exceptions import (
+    BadArgsError,
+    DpiError,
+    EncryptedPdfError,
+    ExitCode,
+    ExitCodeException,
+    InputFileError,
+    MissingDependencyError,
+    OutputFileAccessError,
+    PdfMergeFailedError,
+    PriorOcrFoundError,
+    SubprocessOutputError,
+    TesseractConfigError,
+    UnsupportedImageFormatError,
+)
+from ocrmypdf.pluginspec import OcrEngine, OrientationConfidence
+
+hookimpl = _HookimplMarker('ocrmypdf')

src/ocrmypdf/__main__.py

@@ -0,0 +1,75 @@
+#!/usr/bin/env python3
+# © 2015-19 James R. Barlow: github.com/jbarlow83
+#
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+
+import logging
+import os
+import signal
+import sys
+from multiprocessing import set_start_method
+
+from ocrmypdf import __version__
+from ocrmypdf._plugin_manager import get_parser_options_plugins
+from ocrmypdf._sync import run_pipeline
+from ocrmypdf._validation import check_options
+from ocrmypdf.api import Verbosity, configure_logging
+from ocrmypdf.exceptions import (
+    BadArgsError,
+    ExitCode,
+    InputFileError,
+    MissingDependencyError,
+)
+
+log = logging.getLogger('ocrmypdf')
+
+
+def sigbus(*args):
+    raise InputFileError("Lost access to the input file")
+
+
+def run(args=None):
+    _parser, options, plugin_manager = get_parser_options_plugins(args=args)
+
+    if hasattr(os, 'nice'):
+        os.nice(5)
+
+    verbosity = options.verbose
+    if not os.isatty(sys.stderr.fileno()):
+        options.progress_bar = False
+    if options.quiet:
+        verbosity = Verbosity.quiet
+        options.progress_bar = False
+    configure_logging(
+        verbosity,
+        progress_bar_friendly=options.progress_bar,
+        manage_root_logger=True,
+        plugin_manager=plugin_manager,
+    )
+    log.debug('ocrmypdf %s', __version__)
+    try:
+        check_options(options, plugin_manager)
+    except ValueError as e:
+        log.error(e)
+        return ExitCode.bad_args
+    except BadArgsError as e:
+        log.error(e)
+        return e.exit_code
+    except MissingDependencyError as e:
+        log.error(e)
+        return ExitCode.missing_dependency
+
+    if hasattr(signal, 'SIGBUS'):
+        signal.signal(signal.SIGBUS, sigbus)
+
+    result = run_pipeline(options=options, plugin_manager=plugin_manager)
+    return result
+
+
+if __name__ == '__main__':
+    if sys.platform == 'darwin' and sys.version_info < (3, 8):
+        set_start_method('spawn')  # see python bpo-33725
+    sys.exit(run())

src/ocrmypdf/_concurrent.py

@@ -0,0 +1,133 @@
+# © 2020 James R. Barlow: github.com/jbarlow83
+#
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+import threading
+from abc import ABC, abstractmethod
+from typing import Callable, Iterable, Optional
+
+
+def _task_noop(*_args, **_kwargs):
+    return
+
+
+class NullProgressBar:
+    def __init__(self, **kwargs):
+        pass
+
+    def __enter__(self):
+        return self
+
+    def __exit__(self, exc_type, exc_value, traceback):
+        return False
+
+    def update(self, _arg=None):
+        return
+
+
+class Executor(ABC):
+    pool_lock = threading.Lock()
+    pbar_class = NullProgressBar
+
+    def __init__(self, *, pbar_class=None):
+        if pbar_class:
+            self.pbar_class = pbar_class
+
+    def __call__(
+        self,
+        *,
+        use_threads: bool,
+        max_workers: int,
+        tqdm_kwargs: dict,
+        worker_initializer: Optional[Callable] = None,
+        task: Optional[Callable] = None,
+        task_arguments: Optional[Iterable] = None,
+        task_finished: Optional[Callable] = None,
+    ) -> None:
+        """
+        Set up parallel execution and progress reporting.
+
+        Args:
+            use_threads: If ``False``, the workload is the sort that will benefit from
+                running in a multiprocessing context (for example, it uses Python
+                heavily, and parallelizing it with threads is not expected to be
+                performant).
+            max_workers: The maximum number of workers that should be run.
+            tdqm_kwargs: Arguments to set up the progress bar.
+            worker_initializer: Called when a worker is initialized, in the worker's
+                execution context. If the child workers are processes, it must be
+                possible to marshall/pickle the worker initializer.
+                ``functools.partial`` can be used to bind parameters.
+            task: Called when the worker starts a new task, in the worker's execution
+                context. Must be possible to marshall to the worker.
+            task_finished: Called when a worker finishes a task, in the parent's
+                context.
+            task_arguments: An iterable that generates a group of parameters for each
+                task. This runs in the parent's context, but the parameters must be
+                marshallable to the worker.
+        """
+
+        if not task_arguments:
+            return  # Nothing to do!
+        if not worker_initializer:
+            worker_initializer = _task_noop
+        if not task_finished:
+            task_finished = _task_noop
+        if not task:
+            task = _task_noop
+
+        with self.pool_lock:
+            self._execute(
+                use_threads=use_threads,
+                max_workers=max_workers,
+                tqdm_kwargs=tqdm_kwargs,
+                worker_initializer=worker_initializer,
+                task=task,
+                task_arguments=task_arguments,
+                task_finished=task_finished,
+            )
+
+    @abstractmethod
+    def _execute(
+        self,
+        *,
+        use_threads: bool,
+        max_workers: int,
+        tqdm_kwargs: dict,
+        worker_initializer: Callable,
+        task: Callable,
+        task_arguments: Iterable,
+        task_finished: Callable,
+    ):
+        """Custom executors should override this method."""
+
+
+def setup_executor(plugin_manager) -> Executor:
+    pbar_class = plugin_manager.hook.get_progressbar_class()
+    return plugin_manager.hook.get_executor(progressbar_class=pbar_class)
+
+
+class SerialExecutor(Executor):
+    """Implements a purely sequential executor using the parallel protocol.
+
+    The current process/thread will be the worker that executes all tasks
+    in order. As such, ``worker_initializer`` will never be called.
+    """
+
+    def _execute(
+        self,
+        *,
+        use_threads: bool,
+        max_workers: int,
+        tqdm_kwargs: dict,
+        worker_initializer: Callable,
+        task: Callable,
+        task_arguments: Iterable,
+        task_finished: Callable,
+    ):  # pylint: disable=unused-argument
+        with self.pbar_class(**tqdm_kwargs) as pbar:
+            for args in task_arguments:
+                result = task(args)
+                task_finished(result, pbar)