summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorSean Whitton <spwhitton@spwhitton.name>2022-08-16 14:14:35 -0700
committerSean Whitton <spwhitton@spwhitton.name>2022-08-16 14:14:35 -0700
commitbd6faad8c254005d330115fd8669e498288c27c3 (patch)
tree5672d4ee84c240b5d6320ee10e19b4f5c3d23705
parent9c7019e91a0e882c776ae02f221064d2dfe94f30 (diff)
parent367163d1e61a2d1a5a6762a680f10090d3e708dd (diff)
downloadocrmypdf-bd6faad8c254005d330115fd8669e498288c27c3.tar.gz
Merge tag 'v13.7.0+dfsg' into debian
DFSG-clean upstream version v13.7.0
-rw-r--r--.docker/Dockerfile2
-rw-r--r--.git_archival.txt5
-rw-r--r--.github/ISSUE_TEMPLATE/2-problem-with-a-specific-input-file.md2
-rw-r--r--.github/ISSUE_TEMPLATE/3-feature_request.md2
-rw-r--r--.github/dependabot.yml11
-rw-r--r--.github/workflows/build.yml38
-rw-r--r--.pre-commit-config.yaml12
-rw-r--r--LICENSES/AGPL-3.0-or-later.txt235
-rw-r--r--LICENSES/CC-BY-SA-1.0.txt81
-rw-r--r--LICENSES/CC-BY-SA-2.0.txt85
-rw-r--r--LICENSES/CC-BY-SA-2.5.txt85
-rw-r--r--LICENSES/CC-BY-SA-3.0.txt99
-rw-r--r--LICENSES/CC-BY-SA-4.0.txt170
-rw-r--r--LICENSES/GFDL-1.2-or-later.txt130
-rw-r--r--LICENSES/MIT.txt9
-rw-r--r--LICENSES/MPL-2.0.txt373
-rw-r--r--LICENSES/Zlib.txt11
-rw-r--r--README.md21
-rw-r--r--docs/advanced.rst17
-rw-r--r--docs/api.rst4
-rw-r--r--docs/apiref.rst4
-rw-r--r--docs/batch.rst36
-rwxr-xr-xdocs/conf.py8
-rw-r--r--docs/contributing.rst4
-rw-r--r--docs/cookbook.rst29
-rw-r--r--docs/docker.rst4
-rw-r--r--docs/errors.rst4
-rw-r--r--docs/index.rst4
-rw-r--r--docs/installation.rst187
-rw-r--r--docs/introduction.rst4
-rw-r--r--docs/jbig2.rst6
-rw-r--r--docs/languages.rst4
-rw-r--r--docs/maintainers.rst14
-rw-r--r--docs/optimizer.rst4
-rw-r--r--docs/pdfsecurity.rst4
-rw-r--r--docs/performance.rst4
-rw-r--r--docs/plugins.rst18
-rw-r--r--docs/release_notes.rst77
-rw-r--r--misc/batch.py24
-rw-r--r--misc/completion/ocrmypdf.bash25
-rw-r--r--misc/completion/ocrmypdf.fish29
-rw-r--r--misc/example_plugin.py23
-rw-r--r--misc/synology.py24
-rw-r--r--misc/watcher.py43
-rw-r--r--misc/webservice.py19
-rw-r--r--pyproject.toml16
-rw-r--r--setup.cfg19
-rw-r--r--setup.py18
-rw-r--r--snapcraft.yaml72
-rw-r--r--src/ocrmypdf/__init__.py10
-rwxr-xr-xsrc/ocrmypdf/__main__.py15
-rw-r--r--src/ocrmypdf/_concurrent.py25
-rw-r--r--src/ocrmypdf/_exec/__init__.py10
-rw-r--r--src/ocrmypdf/_exec/ghostscript.py51
-rw-r--r--src/ocrmypdf/_exec/jbig2enc.py10
-rw-r--r--src/ocrmypdf/_exec/pngquant.py10
-rw-r--r--src/ocrmypdf/_exec/tesseract.py60
-rw-r--r--src/ocrmypdf/_exec/unpaper.py86
-rw-r--r--src/ocrmypdf/_graft.py23
-rw-r--r--src/ocrmypdf/_jobcontext.py14
-rw-r--r--src/ocrmypdf/_logging.py13
-rw-r--r--src/ocrmypdf/_pipeline.py86
-rw-r--r--src/ocrmypdf/_plugin_manager.py27
-rw-r--r--src/ocrmypdf/_sync.py49
-rw-r--r--src/ocrmypdf/_validation.py144
-rw-r--r--src/ocrmypdf/_version.py17
-rw-r--r--src/ocrmypdf/api.py39
-rw-r--r--src/ocrmypdf/builtin_plugins/__init__.py9
-rw-r--r--src/ocrmypdf/builtin_plugins/concurrency.py36
-rw-r--r--src/ocrmypdf/builtin_plugins/default_filters.py10
-rw-r--r--src/ocrmypdf/builtin_plugins/ghostscript.py9
-rw-r--r--src/ocrmypdf/builtin_plugins/optimize.py155
-rw-r--r--src/ocrmypdf/builtin_plugins/tesseract_ocr.py12
-rw-r--r--src/ocrmypdf/cli.py94
-rw-r--r--src/ocrmypdf/data/__init__.py11
-rw-r--r--src/ocrmypdf/exceptions.py44
-rw-r--r--src/ocrmypdf/extra_plugins/__init__.py3
-rw-r--r--src/ocrmypdf/extra_plugins/semfree.py41
-rw-r--r--src/ocrmypdf/helpers.py40
-rwxr-xr-xsrc/ocrmypdf/hocrtransform.py63
-rw-r--r--src/ocrmypdf/optimize.py80
-rw-r--r--src/ocrmypdf/pdfa.py27
-rw-r--r--src/ocrmypdf/pdfinfo/__init__.py10
-rw-r--r--src/ocrmypdf/pdfinfo/info.py183
-rw-r--r--src/ocrmypdf/pdfinfo/layout.py9
-rw-r--r--src/ocrmypdf/pluginspec.py117
-rw-r--r--src/ocrmypdf/py.typed2
-rw-r--r--src/ocrmypdf/quality.py10
-rw-r--r--src/ocrmypdf/subprocess/__init__.py145
-rw-r--r--src/ocrmypdf/subprocess/_windows.py59
-rw-r--r--tests/__init__.py9
-rw-r--r--tests/cache/francais/__-l__deu__000001_ocr.png__000001_ocr_tess__pdf__txt/pdf.binbin0 -> 3626 bytes
-rw-r--r--tests/cache/francais/__-l__deu__000001_ocr.png__000001_ocr_tess__pdf__txt/stderr.bin1
-rw-r--r--tests/cache/francais/__-l__deu__000001_ocr.png__000001_ocr_tess__pdf__txt/stdout.bin0
-rw-r--r--tests/cache/francais/__-l__deu__000001_ocr.png__000001_ocr_tess__pdf__txt/txt.bin13
-rw-r--r--tests/cache/manifest.jsonl1
-rw-r--r--tests/conftest.py10
-rw-r--r--tests/plugins/gs_feature_elision.py24
-rw-r--r--tests/plugins/gs_pdfa_failure.py24
-rw-r--r--tests/plugins/gs_raster_failure.py24
-rw-r--r--tests/plugins/gs_render_failure.py24
-rw-r--r--tests/plugins/tesseract_badutf8.py24
-rw-r--r--tests/plugins/tesseract_big_image_error.py23
-rw-r--r--tests/plugins/tesseract_cache.py25
-rwxr-xr-xtests/plugins/tesseract_crash.py23
-rw-r--r--tests/plugins/tesseract_debug_rotate.py25
-rw-r--r--tests/plugins/tesseract_noop.py25
-rw-r--r--tests/plugins/tesseract_simulate_oom_killer.py33
-rw-r--r--tests/test_acroform.py8
-rw-r--r--tests/test_api.py8
-rw-r--r--tests/test_check_pdf.py8
-rw-r--r--tests/test_completion.py8
-rw-r--r--tests/test_concurrency.py9
-rw-r--r--tests/test_ghostscript.py8
-rw-r--r--tests/test_graft.py8
-rw-r--r--tests/test_helpers.py8
-rw-r--r--tests/test_hocrtransform.py8
-rw-r--r--tests/test_image_input.py8
-rw-r--r--tests/test_logging.py9
-rw-r--r--tests/test_main.py69
-rw-r--r--tests/test_metadata.py48
-rw-r--r--tests/test_optimize.py8
-rw-r--r--tests/test_page_numbers.py8
-rw-r--r--tests/test_pdfa.py33
-rw-r--r--tests/test_pdfinfo.py52
-rw-r--r--tests/test_pipeline.py9
-rw-r--r--tests/test_preprocessing.py8
-rw-r--r--tests/test_quality.py8
-rw-r--r--tests/test_rotation.py8
-rw-r--r--tests/test_stdio.py21
-rw-r--r--tests/test_tesseract.py8
-rw-r--r--tests/test_unpaper.py8
-rw-r--r--tests/test_userunit.py8
-rw-r--r--tests/test_validation.py69
134 files changed, 3139 insertions, 1601 deletions
diff --git a/.docker/Dockerfile b/.docker/Dockerfile
index c7614a8b..9e52ca93 100644
--- a/.docker/Dockerfile
+++ b/.docker/Dockerfile
@@ -1,7 +1,7 @@
# OCRmyPDF
#
-FROM debian:bookworm-slim as base
+FROM ubuntu:22.04 as base
ENV LANG=C.UTF-8
ENV TZ=UTC
diff --git a/.git_archival.txt b/.git_archival.txt
index 082d6c25..3994ec0a 100644
--- a/.git_archival.txt
+++ b/.git_archival.txt
@@ -1 +1,4 @@
-ref-names: $Format:%D$ \ No newline at end of file
+node: $Format:%H$
+node-date: $Format:%cI$
+describe-name: $Format:%(describe:tags=true)$
+ref-names: $Format:%D$
diff --git a/.github/ISSUE_TEMPLATE/2-problem-with-a-specific-input-file.md b/.github/ISSUE_TEMPLATE/2-problem-with-a-specific-input-file.md
index 595d9cee..d98bf847 100644
--- a/.github/ISSUE_TEMPLATE/2-problem-with-a-specific-input-file.md
+++ b/.github/ISSUE_TEMPLATE/2-problem-with-a-specific-input-file.md
@@ -22,7 +22,7 @@ Run with verbosity or higher `-v1` to see more detailed logging. This informatio
**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.
+Please provide an input file with no personal or confidential information. At your option you may [GPG-encrypt the file](https://github.com/ocrmypdf/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.
diff --git a/.github/ISSUE_TEMPLATE/3-feature_request.md b/.github/ISSUE_TEMPLATE/3-feature_request.md
index fc3ba503..4f27440d 100644
--- a/.github/ISSUE_TEMPLATE/3-feature_request.md
+++ b/.github/ISSUE_TEMPLATE/3-feature_request.md
@@ -19,7 +19,7 @@ A clear and concise description of any alternative solutions or features you've
**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.
+Please provide an input file with no personal or confidential information. At your option you may [GPG-encrypt the file](https://github.com/ocrmypdf/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.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
new file mode 100644
index 00000000..90e05c40
--- /dev/null
+++ b/.github/dependabot.yml
@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+ - package-ecosystem: "github-actions" # See documentation for possible values
+ directory: "/" # Location of package manifests
+ schedule:
+ interval: "weekly"
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
index d5e0915b..a895b0fc 100644
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -31,7 +31,7 @@ jobs:
- os: ubuntu-latest
python: "3.9"
- os: ubuntu-latest
- python: "pypy-3.7"
+ python: "pypy-3.8"
- os: ubuntu-latest
python: "3.9"
tesseract5: true
@@ -41,11 +41,11 @@ jobs:
PYTHON: ${{ matrix.python }}
steps:
- - uses: actions/checkout@v2
+ - uses: actions/checkout@v3
with:
fetch-depth: "0" # 0=all, needed for setuptools-scm to resolve version tags
- - uses: actions/setup-python@v2
+ - uses: actions/setup-python@v4
name: Install Python
with:
python-version: ${{ matrix.python }}
@@ -111,7 +111,7 @@ jobs:
python -m pytest --cov-report xml --cov=ocrmypdf --cov=tests/ -n0 tests/
- name: Upload coverage to Codecov
- uses: codecov/codecov-action@v1
+ uses: codecov/codecov-action@v3
with:
files: ./coverage.xml
env_vars: OS,PYTHON
@@ -129,11 +129,11 @@ jobs:
PYTHON: ${{ matrix.python }}
steps:
- - uses: actions/checkout@v2
+ - uses: actions/checkout@v3
with:
fetch-depth: "0" # 0=all, needed for setuptools-scm to resolve version tags
- - uses: actions/setup-python@v2
+ - uses: actions/setup-python@v4
name: Install Python
with:
python-version: ${{ matrix.python }}
@@ -166,7 +166,7 @@ jobs:
python -m pytest --cov-report xml --cov=ocrmypdf --cov=tests/ -n0 tests/
- name: Upload coverage to Codecov
- uses: codecov/codecov-action@v1
+ uses: codecov/codecov-action@v3
with:
files: ./coverage.xml
env_vars: OS,PYTHON
@@ -184,11 +184,11 @@ jobs:
PYTHON: ${{ matrix.python }}
steps:
- - uses: actions/checkout@v2
+ - uses: actions/checkout@v3
with:
fetch-depth: "0" # 0=all, needed for setuptools-scm to resolve version tags
- - uses: actions/setup-python@v2
+ - uses: actions/setup-python@v4
name: Install Python
with:
python-version: ${{ matrix.python }}
@@ -196,7 +196,7 @@ jobs:
- name: Install system packages
run: |
choco install --yes --no-progress --pre tesseract
- choco install --yes --no-progress --ignore-checksums ghostscript pngquant
+ choco install --yes --no-progress --ignore-checksums ghostscript
- name: Install Python packages
run: |
@@ -208,7 +208,7 @@ jobs:
python -m pytest --cov-report xml --cov=ocrmypdf --cov=tests/ -n0 tests/
- name: Upload coverage to Codecov
- uses: codecov/codecov-action@v1
+ uses: codecov/codecov-action@v3
with:
files: ./coverage.xml
env_vars: OS,PYTHON
@@ -217,11 +217,11 @@ jobs:
name: Build sdist and wheels
runs-on: ubuntu-latest
steps:
- - uses: actions/checkout@v2
+ - uses: actions/checkout@v3
with:
fetch-depth: "0" # 0=all, needed for setuptools-scm to resolve version tags
- - uses: actions/setup-python@v2
+ - uses: actions/setup-python@v4
name: Install Python
with:
python-version: "3.7"
@@ -232,7 +232,7 @@ jobs:
python setup.py sdist
python setup.py bdist_wheel
- - uses: actions/upload-artifact@v2
+ - uses: actions/upload-artifact@v3
with:
path: |
./dist/*.whl
@@ -244,7 +244,7 @@ jobs:
runs-on: ubuntu-latest
if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags/v')
steps:
- - uses: actions/download-artifact@v2
+ - uses: actions/download-artifact@v3
with:
name: artifact
path: dist
@@ -274,22 +274,22 @@ jobs:
- name: Set image name
run: echo "DOCKER_IMAGE_NAME=ocrmypdf" >> $GITHUB_ENV
- - uses: actions/checkout@v2
+ - uses: actions/checkout@v3
with:
fetch-depth: "0" # 0=all, needed for setuptools-scm to resolve version tags
- name: Login to Docker Hub
- uses: docker/login-action@v1
+ uses: docker/login-action@v2
with:
username: jbarlow83
password: ${{ secrets.DOCKERHUB_TOKEN }}
- name: Set up QEMU
- uses: docker/setup-qemu-action@v1
+ uses: docker/setup-qemu-action@v2
- name: Set up Docker Buildx
id: buildx
- uses: docker/setup-buildx-action@v1
+ uses: docker/setup-buildx-action@v2
- name: Print image tag
run: echo "Building image ${DOCKER_REPOSITORY}/${DOCKER_IMAGE_NAME}:${DOCKER_IMAGE_TAG}"
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index f913fc40..8fb0a293 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -1,6 +1,6 @@
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
- rev: v4.1.0
+ rev: v4.3.0
hooks:
- id: check-case-conflict
- id: check-merge-conflict
@@ -11,23 +11,23 @@ repos:
rev: 5.10.1
hooks:
- id: isort
- args: ["--profile", "black"]
+ args: ["--profile", "black", "-a", "from __future__ import annotations"]
- repo: https://github.com/psf/black
- rev: 22.3.0
+ rev: 22.6.0
hooks:
- id: black
language_version: python
- repo: https://github.com/asottile/setup-cfg-fmt
- rev: v1.20.1
+ rev: v1.20.2
hooks:
- id: setup-cfg-fmt
- repo: https://github.com/asottile/pyupgrade
- rev: v2.31.1
+ rev: v2.37.2
hooks:
- id: pyupgrade
args: ["--py37-plus"]
- repo: https://github.com/pre-commit/mirrors-mypy
- rev: v0.942
+ rev: v0.971
hooks:
- id: mypy
additional_dependencies:
diff --git a/LICENSES/AGPL-3.0-or-later.txt b/LICENSES/AGPL-3.0-or-later.txt
new file mode 100644
index 00000000..0c97efd2
--- /dev/null
+++ b/LICENSES/AGPL-3.0-or-later.txt
@@ -0,0 +1,235 @@
+GNU AFFERO GENERAL PUBLIC LICENSE
+Version 3, 19 November 2007
+
+Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+
+Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
+
+ Preamble
+
+The GNU Affero General Public License is a free, copyleft license for software and other kinds of works, specifically designed to ensure cooperation with the community in the case of network server software.
+
+The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, our General Public Licenses are intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users.
+
+When we speak of free software, we are referring to freedom, 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 them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things.
+
+Developers that use our General Public Licenses protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License which gives you legal permission to copy, distribute and/or modify the software.
+
+A secondary benefit of defending all users' freedom is that improvements made in alternate versions of the program, if they receive widespread use, become available for other developers to incorporate. Many developers of free software are heartened and encouraged by the resulting cooperation. However, in the case of software used on network servers, this result may fail to come about. The GNU General Public License permits making a modified version and letting the public access it on a server without ever releasing its source code to the public.
+
+The GNU Affero General Public License is designed specifically to ensure that, in such cases, the modified source code becomes available to the community. It requires the operator of a network server to provide the source code of the modified version running there to the users of that server. Therefore, public use of a modified version, on a publicly accessible server, gives the public access to the source code of the modified version.
+
+An older license, called the Affero General Public License and published by Affero, was designed to accomplish similar goals. This is a different license, not a version of the Affero GPL, but Affero has released a new version of the Affero GPL which permits relicensing under this license.
+
+The precise terms and conditions for copying, distribution and modification follow.
+
+ TERMS AND CONDITIONS
+
+0. Definitions.
+
+"This License" refers to version 3 of the GNU Affero General Public License.
+
+"Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks.
+
+"The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations.
+
+To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work.
+
+A "covered work" means either the unmodified Program or a work based on the Program.
+
+To "propagate" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well.
+
+To "convey" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying.
+
+An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion.
+
+1. Source Code.
+The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source form of a work.
+
+A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language.
+
+The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it.
+
+The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source.
+
+The Corresponding Source for a work in source code form is that same work.
+
+2. Basic Permissions.
+All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law.
+
+You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you.
+
+Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary.
+
+3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures.
+
+When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures.
+
+4. Conveying Verbatim Copies.
+You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program.
+
+You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee.
+
+5. Conveying Modified Source Versions.
+You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions:
+
+ a) The work must carry prominent notices stating that you modified it, and giving a relevant date.
+
+ b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices".
+
+ c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it.
+
+ d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so.
+
+A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate.
+
+6. Conveying Non-Source Forms.
+You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways:
+
+ a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange.
+
+ b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge.
+
+ c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b.
+
+ d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements.
+
+ e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d.
+
+A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work.
+
+A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product.
+
+"Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made.
+
+If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM).
+
+The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network.
+
+Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying.
+
+7. Additional Terms.
+"Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions.
+
+When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission.
+
+Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms:
+
+ a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or
+
+ b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or
+
+ c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or
+
+ d) Limiting the use for publicity purposes of names of licensors or authors of the material; or
+
+ e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or
+
+ f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors.
+
+All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying.
+
+If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms.
+
+Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way.
+
+8. Termination.
+
+You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11).
+
+However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.
+
+Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.
+
+Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10.
+
+9. Acceptance Not Required for Having Copies.
+
+You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so.
+
+10. Automatic Licensing of Downstream Recipients.
+
+Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License.
+
+An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts.
+
+You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it.
+
+11. Patents.
+
+A "contributor" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version".
+
+A contributor's "essential patent claims" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License.
+
+Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version.
+
+In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party.
+
+If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent
+license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid.
+
+If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it.
+
+A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007.
+
+Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law.
+
+12. No Surrender of Others' Freedom.
+
+If 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 convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may
+not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program.
+
+13. Remote Network Interaction; Use with the GNU General Public License.
+
+Notwithstanding any other provision of this License, if you modify the Program, your modified version must prominently offer all users interacting with it remotely through a computer network (if your version supports such interaction) an opportunity to receive the Corresponding Source of your version by providing access to the Corresponding Source from a network server at no charge, through some standard or customary means of facilitating copying of software. This Corresponding Source shall include the Corresponding Source for any work covered by version 3 of the GNU General Public License that is incorporated pursuant to the following paragraph.
+
+Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the work with which it is combined will remain governed by version 3 of the GNU General Public License.
+
+14. Revised Versions of this License.
+
+The Free Software Foundation may publish revised and/or new versions of the GNU Affero 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 Program specifies that a certain numbered version of the GNU Affero General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU Affero General Public License, you may choose any version ever published by the Free Software Foundation.
+
+If the Program specifies that a proxy can decide which future versions of the GNU Affero General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program.
+
+Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version.
+
+15. Disclaimer of Warranty.
+
+THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "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 PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+16. Limitation of Liability.
+
+IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM 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 PROGRAM (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 PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
+
+17. Interpretation of Sections 15 and 16.
+
+If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee.
+
+END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms.
+
+To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state 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 program's name and a brief idea of what it does.>
+ Copyright (C) <year> <name of author>
+
+ 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 <http://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If your software can interact with users remotely through a computer network, you should also make sure that it provides a way for users to get its source. For example, if your program is a web application, its interface could display a "Source" link that leads users to an archive of the code. There are many ways you could offer source, and different solutions will be better for different programs; see section 13 for the specific requirements.
+
+You should also get your employer (if you work as a programmer) or school, if any, to sign a "copyright disclaimer" for the program, if necessary. For more information on this, and how to apply and follow the GNU AGPL, see <http://www.gnu.org/licenses/>.
diff --git a/LICENSES/CC-BY-SA-1.0.txt b/LICENSES/CC-BY-SA-1.0.txt
new file mode 100644
index 00000000..9930ef7b
--- /dev/null
+++ b/LICENSES/CC-BY-SA-1.0.txt
@@ -0,0 +1,81 @@
+Creative Commons Attribution-ShareAlike 1.0
+
+ CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE LEGAL SERVICES. DISTRIBUTION OF THIS DRAFT LICENSE DOES NOT CREATE AN ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES REGARDING THE INFORMATION PROVIDED, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM ITS USE.
+
+License
+
+THE WORK (AS DEFINED BELOW) IS PROVIDED UNDER THE TERMS OF THIS CREATIVE COMMONS PUBLIC LICENSE ("CCPL" OR "LICENSE"). THE WORK IS PROTECTED BY COPYRIGHT AND/OR OTHER APPLICABLE LAW. ANY USE OF THE WORK OTHER THAN AS AUTHORIZED UNDER THIS LICENSE IS PROHIBITED.
+
+BY EXERCISING ANY RIGHTS TO THE WORK PROVIDED HERE, YOU ACCEPT AND AGREE TO BE BOUND BY THE TERMS OF THIS LICENSE. THE LICENSOR GRANTS YOU THE RIGHTS CONTAINED HERE IN CONSIDERATION OF YOUR ACCEPTANCE OF SUCH TERMS AND CONDITIONS.
+
+1. Definitions
+
+ a. "Collective Work" means a work, such as a periodical issue, anthology or encyclopedia, in which the Work in its entirety in unmodified form, along with a number of other contributions, constituting separate and independent works in themselves, are assembled into a collective whole. A work that constitutes a Collective Work will not be considered a Derivative Work (as defined below) for the purposes of this License.
+
+ b. "Derivative Work" means a work based upon the Work or upon the Work and other pre-existing works, such as a translation, musical arrangement, dramatization, fictionalization, motion picture version, sound recording, art reproduction, abridgment, condensation, or any other form in which the Work may be recast, transformed, or adapted, except that a work that constitutes a Collective Work will not be considered a Derivative Work for the purpose of this License.
+
+ c. "Licensor" means the individual or entity that offers the Work under the terms of this License.
+
+ d. "Original Author" means the individual or entity who created the Work.
+
+ e. "Work" means the copyrightable work of authorship offered under the terms of this License.
+
+ f. "You" means an individual or entity exercising rights under this License who has not previously violated the terms of this License with respect to the Work, or who has received express permission from the Licensor to exercise rights under this License despite a previous violation.
+
+2. Fair Use Rights. Nothing in this license is intended to reduce, limit, or restrict any rights arising from fair use, first sale or other limitations on the exclusive rights of the copyright owner under copyright law or other applicable laws.
+
+3. License Grant. Subject to the terms and conditions of this License, Licensor hereby grants You a worldwide, royalty-free, non-exclusive, perpetual (for the duration of the applicable copyright) license to exercise the rights in the Work as stated below:
+
+ a. to reproduce the Work, to incorporate the Work into one or more Collective Works, and to reproduce the Work as incorporated in the Collective Works;
+
+ b. to create and reproduce Derivative Works;
+
+ c. to distribute copies or phonorecords of, display publicly, perform publicly, and perform publicly by means of a digital audio transmission the Work including as incorporated in Collective Works;
+
+ d. to distribute copies or phonorecords of, display publicly, perform publicly, and perform publicly by means of a digital audio transmission Derivative Works;
+
+The above rights may be exercised in all media and formats whether now known or hereafter devised. The above rights include the right to make such modifications as are technically necessary to exercise the rights in other media and formats. All rights not expressly granted by Licensor are hereby reserved.
+
+4. Restrictions. The license granted in Section 3 above is expressly made subject to and limited by the following restrictions:
+
+ a. You may distribute, publicly display, publicly perform, or publicly digitally perform the Work only under the terms of this License, and You must include a copy of, or the Uniform Resource Identifier for, this License with every copy or phonorecord of the Work You distribute, publicly display, publicly perform, or publicly digitally perform. You may not offer or impose any terms on the Work that alter or restrict the terms of this License or the recipients' exercise of the rights granted hereunder. You may not sublicense the Work. You must keep intact all notices that refer to this License and to the disclaimer of warranties. You may not distribute, publicly display, publicly perform, or publicly digitally perform the Work with any technological measures that control access or use of the Work in a manner inconsistent with the terms of this License Agreement. The above applies to the Work as incorporated in a Collective Work, but this does not require the Collective Work apart from the Work itself to be made subject to the terms of this License. If You create a Collective Work, upon notice from any Licensor You must, to the extent practicable, remove from the Collective Work any reference to such Licensor or the Original Author, as requested. If You create a Derivative Work, upon notice from any Licensor You must, to the extent practicable, remove from the Derivative Work any reference to such Licensor or the Original Author, as requested.
+
+ b. You may distribute, publicly display, publicly perform, or publicly digitally perform a Derivative Work only under the terms of this License, and You must include a copy of, or the Uniform Resource Identifier for, this License with every copy or phonorecord of each Derivative Work You distribute, publicly display, publicly perform, or publicly digitally perform. You may not offer or impose any terms on the Derivative Works that alter or restrict the terms of this License or the recipients' exercise of the rights granted hereunder, and You must keep intact all notices that refer to this License and to the disclaimer of warranties. You may not distribute, publicly display, publicly perform, or publicly digitally perform the Derivative Work with any technological measures that control access or use of the Work in a manner inconsistent with the terms of this License Agreement. The above applies to the Derivative Work as incorporated in a Collective Work, but this does not require the Collective Work apart from the Derivative Work itself to be made subject to the terms of this License.
+
+ c. If you distribute, publicly display, publicly perform, or publicly digitally perform the Work or any Derivative Works or Collective Works, You must keep intact all copyright notices for the Work and give the Original Author credit reasonable to the medium or means You are utilizing by conveying the name (or pseudonym if applicable) of the Original Author if supplied; the title of the Work if supplied; in the case of a Derivative Work, a credit identifying the use of the Work in the Derivative Work (e.g., "French translation of the Work by Original Author," or "Screenplay based on original Work by Original Author"). Such credit may be implemented in any reasonable manner; provided, however, that in the case of a Derivative Work or Collective Work, at a minimum such credit will appear where any other comparable authorship credit appears and in a manner at least as prominent as such other comparable authorship credit.
+
+5. Representations, Warranties and Disclaimer
+
+ a. By offering the Work for public release under this License, Licensor represents and warrants that, to the best of Licensor's knowledge after reasonable inquiry:
+
+ i. Licensor has secured all rights in the Work necessary to grant the license rights hereunder and to permit the lawful exercise of the rights granted hereunder without You having any obligation to pay any royalties, compulsory license fees, residuals or any other payments;
+
+ ii. The Work does not infringe the copyright, trademark, publicity rights, common law rights or any other right of any third party or constitute defamation, invasion of privacy or other tortious injury to any third party.
+
+ b. EXCEPT AS EXPRESSLY STATED IN THIS LICENSE OR OTHERWISE AGREED IN WRITING OR REQUIRED BY APPLICABLE LAW, THE WORK IS LICENSED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES REGARDING THE CONTENTS OR ACCURACY OF THE WORK.
+
+6. Limitation on Liability. EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, AND EXCEPT FOR DAMAGES ARISING FROM LIABILITY TO A THIRD PARTY RESULTING FROM BREACH OF THE WARRANTIES IN SECTION 5, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
+
+7. Termination
+
+ a. This License and the rights granted hereunder will terminate automatically upon any breach by You of the terms of this License. Individuals or entities who have received Derivative Works or Collective Works from You under this License, however, will not have their licenses terminated provided such individuals or entities remain in full compliance with those licenses. Sections 1, 2, 5, 6, 7, and 8 will survive any termination of this License.
+
+ b. Subject to the above terms and conditions, the license granted here is perpetual (for the duration of the applicable copyright in the Work). Notwithstanding the above, Licensor reserves the right to release the Work under different license terms or to stop distributing the Work at any time; provided, however that any such election will not serve to withdraw this License (or any other license that has been, or is required to be, granted under the terms of this License), and this License will continue in full force and effect unless terminated as stated above.
+
+8. Miscellaneous
+
+ a. Each time You distribute or publicly digitally perform the Work or a Collective Work, the Licensor offers to the recipient a license to the Work on the same terms and conditions as the license granted to You under this License.
+
+ b. Each time You distribute or publicly digitally perform a Derivative Work, Licensor offers to the recipient a license to the original Work on the same terms and conditions as the license granted to You under this License.
+
+ c. If any provision of this License is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this License, and without further action by the parties to this agreement, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.
+
+ d. No term or provision of this License shall be deemed waived and no breach consented to unless such waiver or consent shall be in writing and signed by the party to be charged with such waiver or consent.
+
+ e. This License constitutes the entire agreement between the parties with respect to the Work licensed here. There are no understandings, agreements or representations with respect to the Work not specified here. Licensor shall not be bound by any additional provisions that may appear in any communication from You. This License may not be modified without the mutual written agreement of the Licensor and You.
+
+Creative Commons is not a party to this License, and makes no warranty whatsoever in connection with the Work. Creative Commons will not be liable to You or any party on any legal theory for any damages whatsoever, including without limitation any general, special, incidental or consequential damages arising in connection to this license. Notwithstanding the foregoing two (2) sentences, if Creative Commons has expressly identified itself as the Licensor hereunder, it shall have all rights and obligations of Licensor.
+
+Except for the limited purpose of indicating to the public that the Work is licensed under the CCPL, neither party will use the trademark "Creative Commons" or any related trademark or logo of Creative Commons without the prior written consent of Creative Commons. Any permitted use will be in compliance with Creative Commons' then-current trademark usage guidelines, as may be published on its website or otherwise made available upon request from time to time.
+
+Creative Commons may be contacted at http://creativecommons.org/.
diff --git a/LICENSES/CC-BY-SA-2.0.txt b/LICENSES/CC-BY-SA-2.0.txt
new file mode 100644
index 00000000..d1e03057
--- /dev/null
+++ b/LICENSES/CC-BY-SA-2.0.txt
@@ -0,0 +1,85 @@
+Creative Commons Attribution-ShareAlike 2.0
+
+ CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE LEGAL SERVICES. DISTRIBUTION OF THIS LICENSE DOES NOT CREATE AN ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES REGARDING THE INFORMATION PROVIDED, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM ITS USE.
+
+License
+
+THE WORK (AS DEFINED BELOW) IS PROVIDED UNDER THE TERMS OF THIS CREATIVE COMMONS PUBLIC LICENSE ("CCPL" OR "LICENSE"). THE WORK IS PROTECTED BY COPYRIGHT AND/OR OTHER APPLICABLE LAW. ANY USE OF THE WORK OTHER THAN AS AUTHORIZED UNDER THIS LICENSE OR COPYRIGHT LAW IS PROHIBITED.
+
+BY EXERCISING ANY RIGHTS TO THE WORK PROVIDED HERE, YOU ACCEPT AND AGREE TO BE BOUND BY THE TERMS OF THIS LICENSE. THE LICENSOR GRANTS YOU THE RIGHTS CONTAINED HERE IN CONSIDERATION OF YOUR ACCEPTANCE OF SUCH TERMS AND CONDITIONS.
+
+1. Definitions
+
+ a. "Collective Work" means a work, such as a periodical issue, anthology or encyclopedia, in which the Work in its entirety in unmodified form, along with a number of other contributions, constituting separate and independent works in themselves, are assembled into a collective whole. A work that constitutes a Collective Work will not be considered a Derivative Work (as defined below) for the purposes of this License.
+
+ b. "Derivative Work" means a work based upon the Work or upon the Work and other pre-existing works, such as a translation, musical arrangement, dramatization, fictionalization, motion picture version, sound recording, art reproduction, abridgment, condensation, or any other form in which the Work may be recast, transformed, or adapted, except that a work that constitutes a Collective Work will not be considered a Derivative Work for the purpose of this License. For the avoidance of doubt, where the Work is a musical composition or sound recording, the synchronization of the Work in timed-relation with a moving image ("synching") will be considered a Derivative Work for the purpose of this License.
+
+ c. "Licensor" means the individual or entity that offers the Work under the terms of this License.
+
+ d. "Original Author" means the individual or entity who created the Work.
+
+ e. "Work" means the copyrightable work of authorship offered under the terms of this License.
+
+ f. "You" means an individual or entity exercising rights under this License who has not previously violated the terms of this License with respect to the Work, or who has received express permission from the Licensor to exercise rights under this License despite a previous violation.
+
+ g. "License Elements" means the following high-level license attributes as selected by Licensor and indicated in the title of this License: Attribution, ShareAlike.
+
+2. Fair Use Rights. Nothing in this license is intended to reduce, limit, or restrict any rights arising from fair use, first sale or other limitations on the exclusive rights of the copyright owner under copyright law or other applicable laws.
+
+3. License Grant. Subject to the terms and conditions of this License, Licensor hereby grants You a worldwide, royalty-free, non-exclusive, perpetual (for the duration of the applicable copyright) license to exercise the rights in the Work as stated below:
+
+ a. to reproduce the Work, to incorporate the Work into one or more Collective Works, and to reproduce the Work as incorporated in the Collective Works;
+
+ b. to create and reproduce Derivative Works;
+
+ c. to distribute copies or phonorecords of, display publicly, perform publicly, and perform publicly by means of a digital audio transmission the Work including as incorporated in Collective Works;
+
+ d. to distribute copies or phonorecords of, display publicly, perform publicly, and perform publicly by means of a digital audio transmission Derivative Works.
+
+ e. For the avoidance of doubt, where the work is a musical composition:
+
+ i. Performance Royalties Under Blanket Licenses. Licensor waives the exclusive right to collect, whether individually or via a performance rights society (e.g. ASCAP, BMI, SESAC), royalties for the public performance or public digital performance (e.g. webcast) of the Work.
+
+ ii. Mechanical Rights and Statutory Royalties. Licensor waives the exclusive right to collect, whether individually or via a music rights society or designated agent (e.g. Harry Fox Agency), royalties for any phonorecord You create from the Work ("cover version") and distribute, subject to the compulsory license created by 17 USC Section 115 of the US Copyright Act (or the equivalent in other jurisdictions).
+
+ f. Webcasting Rights and Statutory Royalties. For the avoidance of doubt, where the Work is a sound recording, Licensor waives the exclusive right to collect, whether individually or via a performance-rights society (e.g. SoundExchange), royalties for the public digital performance (e.g. webcast) of the Work, subject to the compulsory license created by 17 USC Section 114 of the US Copyright Act (or the equivalent in other jurisdictions).
+
+The above rights may be exercised in all media and formats whether now known or hereafter devised. The above rights include the right to make such modifications as are technically necessary to exercise the rights in other media and formats. All rights not expressly granted by Licensor are hereby reserved.
+
+4. Restrictions. The license granted in Section 3 above is expressly made subject to and limited by the following restrictions:
+
+ a. You may distribute, publicly display, publicly perform, or publicly digitally perform the Work only under the terms of this License, and You must include a copy of, or the Uniform Resource Identifier for, this License with every copy or phonorecord of the Work You distribute, publicly display, publicly perform, or publicly digitally perform. You may not offer or impose any terms on the Work that alter or restrict the terms of this License or the recipients' exercise of the rights granted hereunder. You may not sublicense the Work. You must keep intact all notices that refer to this License and to the disclaimer of warranties. You may not distribute, publicly display, publicly perform, or publicly digitally perform the Work with any technological measures that control access or use of the Work in a manner inconsistent with the terms of this License Agreement. The above applies to the Work as incorporated in a Collective Work, but this does not require the Collective Work apart from the Work itself to be made subject to the terms of this License. If You create a Collective Work, upon notice from any Licensor You must, to the extent practicable, remove from the Collective Work any reference to such Licensor or the Original Author, as requested. If You create a Derivative Work, upon notice from any Licensor You must, to the extent practicable, remove from the Derivative Work any reference to such Licensor or the Original Author, as requested.
+
+ b. You may distribute, publicly display, publicly perform, or publicly digitally perform a Derivative Work only under the terms of this License, a later version of this License with the same License Elements as this License, or a Creative Commons iCommons license that contains the same License Elements as this License (e.g. Attribution-ShareAlike 2.0 Japan). You must include a copy of, or the Uniform Resource Identifier for, this License or other license specified in the previous sentence with every copy or phonorecord of each Derivative Work You distribute, publicly display, publicly perform, or publicly digitally perform. You may not offer or impose any terms on the Derivative Works that alter or restrict the terms of this License or the recipients' exercise of the rights granted hereunder, and You must keep intact all notices that refer to this License and to the disclaimer of warranties. You may not distribute, publicly display, publicly perform, or publicly digitally perform the Derivative Work with any technological measures that control access or use of the Work in a manner inconsistent with the terms of this License Agreement. The above applies to the Derivative Work as incorporated in a Collective Work, but this does not require the Collective Work apart from the Derivative Work itself to be made subject to the terms of this License.
+
+ c. If you distribute, publicly display, publicly perform, or publicly digitally perform the Work or any Derivative Works or Collective Works, You must keep intact all copyright notices for the Work and give the Original Author credit reasonable to the medium or means You are utilizing by conveying the name (or pseudonym if applicable) of the Original Author if supplied; the title of the Work if supplied; to the extent reasonably practicable, the Uniform Resource Identifier, if any, that Licensor specifies to be associated with the Work, unless such URI does not refer to the copyright notice or licensing information for the Work; and in the case of a Derivative Work, a credit identifying the use of the Work in the Derivative Work (e.g., "French translation of the Work by Original Author," or "Screenplay based on original Work by Original Author"). Such credit may be implemented in any reasonable manner; provided, however, that in the case of a Derivative Work or Collective Work, at a minimum such credit will appear where any other comparable authorship credit appears and in a manner at least as prominent as such other comparable authorship credit.
+
+5. Representations, Warranties and Disclaimer
+
+UNLESS OTHERWISE AGREED TO BY THE PARTIES IN WRITING, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE MATERIALS, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU.
+
+6. Limitation on Liability. EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
+
+7. Termination
+
+ a. This License and the rights granted hereunder will terminate automatically upon any breach by You of the terms of this License. Individuals or entities who have received Derivative Works or Collective Works from You under this License, however, will not have their licenses terminated provided such individuals or entities remain in full compliance with those licenses. Sections 1, 2, 5, 6, 7, and 8 will survive any termination of this License.
+
+ b. Subject to the above terms and conditions, the license granted here is perpetual (for the duration of the applicable copyright in the Work). Notwithstanding the above, Licensor reserves the right to release the Work under different license terms or to stop distributing the Work at any time; provided, however that any such election will not serve to withdraw this License (or any other license that has been, or is required to be, granted under the terms of this License), and this License will continue in full force and effect unless terminated as stated above.
+
+8. Miscellaneous
+
+ a. Each time You distribute or publicly digitally perform the Work or a Collective Work, the Licensor offers to the recipient a license to the Work on the same terms and conditions as the license granted to You under this License.
+
+ b. Each time You distribute or publicly digitally perform a Derivative Work, Licensor offers to the recipient a license to the original Work on the same terms and conditions as the license granted to You under this License.
+
+ c. If any provision of this License is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this License, and without further action by the parties to this agreement, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.
+
+ d. No term or provision of this License shall be deemed waived and no breach consented to unless such waiver or consent shall be in writing and signed by the party to be charged with such waiver or consent.
+
+ e. This License constitutes the entire agreement between the parties with respect to the Work licensed here. There are no understandings, agreements or representations with respect to the Work not specified here. Licensor shall not be bound by any additional provisions that may appear in any communication from You. This License may not be modified without the mutual written agreement of the Licensor and You.
+
+Creative Commons is not a party to this License, and makes no warranty whatsoever in connection with the Work. Creative Commons will not be liable to You or any party on any legal theory for any damages whatsoever, including without limitation any general, special, incidental or consequential damages arising in connection to this license. Notwithstanding the foregoing two (2) sentences, if Creative Commons has expressly identified itself as the Licensor hereunder, it shall have all rights and obligations of Licensor.
+
+Except for the limited purpose of indicating to the public that the Work is licensed under the CCPL, neither party will use the trademark "Creative Commons" or any related trademark or logo of Creative Commons without the prior written consent of Creative Commons. Any permitted use will be in compliance with Creative Commons' then-current trademark usage guidelines, as may be published on its website or otherwise made available upon request from time to time.
+
+Creative Commons may be contacted at http://creativecommons.org/.
diff --git a/LICENSES/CC-BY-SA-2.5.txt b/LICENSES/CC-BY-SA-2.5.txt
new file mode 100644
index 00000000..4a2ed20d
--- /dev/null
+++ b/LICENSES/CC-BY-SA-2.5.txt
@@ -0,0 +1,85 @@
+Creative Commons Attribution-ShareAlike 2.5
+
+ CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE LEGAL SERVICES. DISTRIBUTION OF THIS LICENSE DOES NOT CREATE AN ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES REGARDING THE INFORMATION PROVIDED, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM ITS USE.
+
+License
+
+THE WORK (AS DEFINED BELOW) IS PROVIDED UNDER THE TERMS OF THIS CREATIVE COMMONS PUBLIC LICENSE ("CCPL" OR "LICENSE"). THE WORK IS PROTECTED BY COPYRIGHT AND/OR OTHER APPLICABLE LAW. ANY USE OF THE WORK OTHER THAN AS AUTHORIZED UNDER THIS LICENSE OR COPYRIGHT LAW IS PROHIBITED.
+
+BY EXERCISING ANY RIGHTS TO THE WORK PROVIDED HERE, YOU ACCEPT AND AGREE TO BE BOUND BY THE TERMS OF THIS LICENSE. THE LICENSOR GRANTS YOU THE RIGHTS CONTAINED HERE IN CONSIDERATION OF YOUR ACCEPTANCE OF SUCH TERMS AND CONDITIONS.
+
+1. Definitions
+
+ a. "Collective Work" means a work, such as a periodical issue, anthology or encyclopedia, in which the Work in its entirety in unmodified form, along with a number of other contributions, constituting separate and independent works in themselves, are assembled into a collective whole. A work that constitutes a Collective Work will not be considered a Derivative Work (as defined below) for the purposes of this License.
+
+ b. "Derivative Work" means a work based upon the Work or upon the Work and other pre-existing works, such as a translation, musical arrangement, dramatization, fictionalization, motion picture version, sound recording, art reproduction, abridgment, condensation, or any other form in which the Work may be recast, transformed, or adapted, except that a work that constitutes a Collective Work will not be considered a Derivative Work for the purpose of this License. For the avoidance of doubt, where the Work is a musical composition or sound recording, the synchronization of the Work in timed-relation with a moving image ("synching") will be considered a Derivative Work for the purpose of this License.
+
+ c. "Licensor" means the individual or entity that offers the Work under the terms of this License.
+
+ d. "Original Author" means the individual or entity who created the Work.
+
+ e. "Work" means the copyrightable work of authorship offered under the terms of this License.
+
+ f. "You" means an individual or entity exercising rights under this License who has not previously violated the terms of this License with respect to the Work, or who has received express permission from the Licensor to exercise rights under this License despite a previous violation.
+
+ g. "License Elements" means the following high-level license attributes as selected by Licensor and indicated in the title of this License: Attribution, ShareAlike.
+
+2. Fair Use Rights. Nothing in this license is intended to reduce, limit, or restrict any rights arising from fair use, first sale or other limitations on the exclusive rights of the copyright owner under copyright law or other applicable laws.
+
+3. License Grant. Subject to the terms and conditions of this License, Licensor hereby grants You a worldwide, royalty-free, non-exclusive, perpetual (for the duration of the applicable copyright) license to exercise the rights in the Work as stated below:
+
+ a. to reproduce the Work, to incorporate the Work into one or more Collective Works, and to reproduce the Work as incorporated in the Collective Works;
+
+ b. to create and reproduce Derivative Works;
+
+ c. to distribute copies or phonorecords of, display publicly, perform publicly, and perform publicly by means of a digital audio transmission the Work including as incorporated in Collective Works;
+
+ d. to distribute copies or phonorecords of, display publicly, perform publicly, and perform publicly by means of a digital audio transmission Derivative Works.
+
+ e. For the avoidance of doubt, where the work is a musical composition:
+
+ i. Performance Royalties Under Blanket Licenses. Licensor waives the exclusive right to collect, whether individually or via a performance rights society (e.g. ASCAP, BMI, SESAC), royalties for the public performance or public digital performance (e.g. webcast) of the Work.
+
+ ii. Mechanical Rights and Statutory Royalties. Licensor waives the exclusive right to collect, whether individually or via a music rights society or designated agent (e.g. Harry Fox Agency), royalties for any phonorecord You create from the Work ("cover version") and distribute, subject to the compulsory license created by 17 USC Section 115 of the US Copyright Act (or the equivalent in other jurisdictions).
+
+ f. Webcasting Rights and Statutory Royalties. For the avoidance of doubt, where the Work is a sound recording, Licensor waives the exclusive right to collect, whether individually or via a performance-rights society (e.g. SoundExchange), royalties for the public digital performance (e.g. webcast) of the Work, subject to the compulsory license created by 17 USC Section 114 of the US Copyright Act (or the equivalent in other jurisdictions).
+
+The above rights may be exercised in all media and formats whether now known or hereafter devised. The above rights include the right to make such modifications as are technically necessary to exercise the rights in other media and formats. All rights not expressly granted by Licensor are hereby reserved.
+
+4. Restrictions. The license granted in Section 3 above is expressly made subject to and limited by the following restrictions:
+
+ a. You may distribute, publicly display, publicly perform, or publicly digitally perform the Work only under the terms of this License, and You must include a copy of, or the Uniform Resource Identifier for, this License with every copy or phonorecord of the Work You distribute, publicly display, publicly perform, or publicly digitally perform. You may not offer or impose any terms on the Work that alter or restrict the terms of this License or the recipients' exercise of the rights granted hereunder. You may not sublicense the Work. You must keep intact all notices that refer to this License and to the disclaimer of warranties. You may not distribute, publicly display, publicly perform, or publicly digitally perform the Work with any technological measures that control access or use of the Work in a manner inconsistent with the terms of this License Agreement. The above applies to the Work as incorporated in a Collective Work, but this does not require the Collective Work apart from the Work itself to be made subject to the terms of this License. If You create a Collective Work, upon notice from any Licensor You must, to the extent practicable, remove from the Collective Work any credit as required by clause 4(c), as requested. If You create a Derivative Work, upon notice from any Licensor You must, to the extent practicable, remove from the Derivative Work any credit as required by clause 4(c), as requested.
+
+ b. You may distribute, publicly display, publicly perform, or publicly digitally perform a Derivative Work only under the terms of this License, a later version of this License with the same License Elements as this License, or a Creative Commons iCommons license that contains the same License Elements as this License (e.g. Attribution-ShareAlike 2.5 Japan). You must include a copy of, or the Uniform Resource Identifier for, this License or other license specified in the previous sentence with every copy or phonorecord of each Derivative Work You distribute, publicly display, publicly perform, or publicly digitally perform. You may not offer or impose any terms on the Derivative Works that alter or restrict the terms of this License or the recipients' exercise of the rights granted hereunder, and You must keep intact all notices that refer to this License and to the disclaimer of warranties. You may not distribute, publicly display, publicly perform, or publicly digitally perform the Derivative Work with any technological measures that control access or use of the Work in a manner inconsistent with the terms of this License Agreement. The above applies to the Derivative Work as incorporated in a Collective Work, but this does not require the Collective Work apart from the Derivative Work itself to be made subject to the terms of this License.
+
+ c. If you distribute, publicly display, publicly perform, or publicly digitally perform the Work or any Derivative Works or Collective Works, You must keep intact all copyright notices for the Work and provide, reasonable to the medium or means You are utilizing: (i) the name of the Original Author (or pseudonym, if applicable) if supplied, and/or (ii) if the Original Author and/or Licensor designate another party or parties (e.g. a sponsor institute, publishing entity, journal) for attribution in Licensor's copyright notice, terms of service or by other reasonable means, the name of such party or parties; the title of the Work if supplied; to the extent reasonably practicable, the Uniform Resource Identifier, if any, that Licensor specifies to be associated with the Work, unless such URI does not refer to the copyright notice or licensing information for the Work; and in the case of a Derivative Work, a credit identifying the use of the Work in the Derivative Work (e.g., "French translation of the Work by Original Author," or "Screenplay based on original Work by Original Author"). Such credit may be implemented in any reasonable manner; provided, however, that in the case of a Derivative Work or Collective Work, at a minimum such credit will appear where any other comparable authorship credit appears and in a manner at least as prominent as such other comparable authorship credit.
+
+5. Representations, Warranties and Disclaimer
+
+UNLESS OTHERWISE AGREED TO BY THE PARTIES IN WRITING, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE MATERIALS, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU.
+
+6. Limitation on Liability. EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
+
+7. Termination
+
+ a. This License and the rights granted hereunder will terminate automatically upon any breach by You of the terms of this License. Individuals or entities who have received Derivative Works or Collective Works from You under this License, however, will not have their licenses terminated provided such individuals or entities remain in full compliance with those licenses. Sections 1, 2, 5, 6, 7, and 8 will survive any termination of this License.
+
+ b. Subject to the above terms and conditions, the license granted here is perpetual (for the duration of the applicable copyright in the Work). Notwithstanding the above, Licensor reserves the right to release the Work under different license terms or to stop distributing the Work at any time; provided, however that any such election will not serve to withdraw this License (or any other license that has been, or is required to be, granted under the terms of this License), and this License will continue in full force and effect unless terminated as stated above.
+
+8. Miscellaneous
+
+ a. Each time You distribute or publicly digitally perform the Work or a Collective Work, the Licensor offers to the recipient a license to the Work on the same terms and conditions as the license granted to You under this License.
+
+ b. Each time You distribute or publicly digitally perform a Derivative Work, Licensor offers to the recipient a license to the original Work on the same terms and conditions as the license granted to You under this License.
+
+ c. If any provision of this License is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this License, and without further action by the parties to this agreement, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.
+
+ d. No term or provision of this License shall be deemed waived and no breach consented to unless such waiver or consent shall be in writing and signed by the party to be charged with such waiver or consent.
+
+ e. This License constitutes the entire agreement between the parties with respect to the Work licensed here. There are no understandings, agreements or representations with respect to the Work not specified here. Licensor shall not be bound by any additional provisions that may appear in any communication from You. This License may not be modified without the mutual written agreement of the Licensor and You.
+
+Creative Commons is not a party to this License, and makes no warranty whatsoever in connection with the Work. Creative Commons will not be liable to You or any party on any legal theory for any damages whatsoever, including without limitation any general, special, incidental or consequential damages arising in connection to this license. Notwithstanding the foregoing two (2) sentences, if Creative Commons has expressly identified itself as the Licensor hereunder, it shall have all rights and obligations of Licensor.
+
+Except for the limited purpose of indicating to the public that the Work is licensed under the CCPL, neither party will use the trademark "Creative Commons" or any related trademark or logo of Creative Commons without the prior written consent of Creative Commons. Any permitted use will be in compliance with Creative Commons' then-current trademark usage guidelines, as may be published on its website or otherwise made available upon request from time to time.
+
+Creative Commons may be contacted at http://creativecommons.org/.
diff --git a/LICENSES/CC-BY-SA-3.0.txt b/LICENSES/CC-BY-SA-3.0.txt
new file mode 100644
index 00000000..39a8591c
--- /dev/null
+++ b/LICENSES/CC-BY-SA-3.0.txt
@@ -0,0 +1,99 @@
+Creative Commons Attribution-ShareAlike 3.0 Unported
+
+ CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE LEGAL SERVICES. DISTRIBUTION OF THIS LICENSE DOES NOT CREATE AN ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES REGARDING THE INFORMATION PROVIDED, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM ITS USE.
+
+License
+
+THE WORK (AS DEFINED BELOW) IS PROVIDED UNDER THE TERMS OF THIS CREATIVE COMMONS PUBLIC LICENSE ("CCPL" OR "LICENSE"). THE WORK IS PROTECTED BY COPYRIGHT AND/OR OTHER APPLICABLE LAW. ANY USE OF THE WORK OTHER THAN AS AUTHORIZED UNDER THIS LICENSE OR COPYRIGHT LAW IS PROHIBITED.
+
+BY EXERCISING ANY RIGHTS TO THE WORK PROVIDED HERE, YOU ACCEPT AND AGREE TO BE BOUND BY THE TERMS OF THIS LICENSE. TO THE EXTENT THIS LICENSE MAY BE CONSIDERED TO BE A CONTRACT, THE LICENSOR GRANTS YOU THE RIGHTS CONTAINED HERE IN CONSIDERATION OF YOUR ACCEPTANCE OF SUCH TERMS AND CONDITIONS.
+
+1. Definitions
+
+ a. "Adaptation" means a work based upon the Work, or upon the Work and other pre-existing works, such as a translation, adaptation, derivative work, arrangement of music or other alterations of a literary or artistic work, or phonogram or performance and includes cinematographic adaptations or any other form in which the Work may be recast, transformed, or adapted including in any form recognizably derived from the original, except that a work that constitutes a Collection will not be considered an Adaptation for the purpose of this License. For the avoidance of doubt, where the Work is a musical work, performance or phonogram, the synchronization of the Work in timed-relation with a moving image ("synching") will be considered an Adaptation for the purpose of this License.
+
+ b. "Collection" means a collection of literary or artistic works, such as encyclopedias and anthologies, or performances, phonograms or broadcasts, or other works or subject matter other than works listed in Section 1(f) below, which, by reason of the selection and arrangement of their contents, constitute intellectual creations, in which the Work is included in its entirety in unmodified form along with one or more other contributions, each constituting separate and independent works in themselves, which together are assembled into a collective whole. A work that constitutes a Collection will not be considered an Adaptation (as defined below) for the purposes of this License.
+
+ c. "Creative Commons Compatible License" means a license that is listed at http://creativecommons.org/compatiblelicenses that has been approved by Creative Commons as being essentially equivalent to this License, including, at a minimum, because that license: (i) contains terms that have the same purpose, meaning and effect as the License Elements of this License; and, (ii) explicitly permits the relicensing of adaptations of works made available under that license under this License or a Creative Commons jurisdiction license with the same License Elements as this License.
+
+ d. "Distribute" means to make available to the public the original and copies of the Work or Adaptation, as appropriate, through sale or other transfer of ownership.
+
+ e. "License Elements" means the following high-level license attributes as selected by Licensor and indicated in the title of this License: Attribution, ShareAlike.
+
+ f. "Licensor" means the individual, individuals, entity or entities that offer(s) the Work under the terms of this License.
+
+ g. "Original Author" means, in the case of a literary or artistic work, the individual, individuals, entity or entities who created the Work or if no individual or entity can be identified, the publisher; and in addition (i) in the case of a performance the actors, singers, musicians, dancers, and other persons who act, sing, deliver, declaim, play in, interpret or otherwise perform literary or artistic works or expressions of folklore; (ii) in the case of a phonogram the producer being the person or legal entity who first fixes the sounds of a performance or other sounds; and, (iii) in the case of broadcasts, the organization that transmits the broadcast.
+
+ h. "Work" means the literary and/or artistic work offered under the terms of this License including without limitation any production in the literary, scientific and artistic domain, whatever may be the mode or form of its expression including digital form, such as a book, pamphlet and other writing; a lecture, address, sermon or other work of the same nature; a dramatic or dramatico-musical work; a choreographic work or entertainment in dumb show; a musical composition with or without words; a cinematographic work to which are assimilated works expressed by a process analogous to cinematography; a work of drawing, painting, architecture, sculpture, engraving or lithography; a photographic work to which are assimilated works expressed by a process analogous to photography; a work of applied art; an illustration, map, plan, sketch or three-dimensional work relative to geography, topography, architecture or science; a performance; a broadcast; a phonogram; a compilation of data to the extent it is protected as a copyrightable work; or a work performed by a variety or circus performer to the extent it is not otherwise considered a literary or artistic work.
+
+ i. "You" means an individual or entity exercising rights under this License who has not previously violated the terms of this License with respect to the Work, or who has received express permission from the Licensor to exercise rights under this License despite a previous violation.
+
+ j. "Publicly Perform" means to perform public recitations of the Work and to communicate to the public those public recitations, by any means or process, including by wire or wireless means or public digital performances; to make available to the public Works in such a way that members of the public may access these Works from a place and at a place individually chosen by them; to perform the Work to the public by any means or process and the communication to the public of the performances of the Work, including by public digital performance; to broadcast and rebroadcast the Work by any means including signs, sounds or images.
+
+ k. "Reproduce" means to make copies of the Work by any means including without limitation by sound or visual recordings and the right of fixation and reproducing fixations of the Work, including storage of a protected performance or phonogram in digital form or other electronic medium.
+
+2. Fair Dealing Rights. Nothing in this License is intended to reduce, limit, or restrict any uses free from copyright or rights arising from limitations or exceptions that are provided for in connection with the copyright protection under copyright law or other applicable laws.
+
+3. License Grant. Subject to the terms and conditions of this License, Licensor hereby grants You a worldwide, royalty-free, non-exclusive, perpetual (for the duration of the applicable copyright) license to exercise the rights in the Work as stated below:
+
+ a. to Reproduce the Work, to incorporate the Work into one or more Collections, and to Reproduce the Work as incorporated in the Collections;
+
+ b. to create and Reproduce Adaptations provided that any such Adaptation, including any translation in any medium, takes reasonable steps to clearly label, demarcate or otherwise identify that changes were made to the original Work. For example, a translation could be marked "The original work was translated from English to Spanish," or a modification could indicate "The original work has been modified.";
+
+ c. to Distribute and Publicly Perform the Work including as incorporated in Collections; and,
+
+ d. to Distribute and Publicly Perform Adaptations.
+
+ e. For the avoidance of doubt:
+
+ i. Non-waivable Compulsory License Schemes. In those jurisdictions in which the right to collect royalties through any statutory or compulsory licensing scheme cannot be waived, the Licensor reserves the exclusive right to collect such royalties for any exercise by You of the rights granted under this License;
+
+ ii. Waivable Compulsory License Schemes. In those jurisdictions in which the right to collect royalties through any statutory or compulsory licensing scheme can be waived, the Licensor waives the exclusive right to collect such royalties for any exercise by You of the rights granted under this License; and,
+
+ iii. Voluntary License Schemes. The Licensor waives the right to collect royalties, whether individually or, in the event that the Licensor is a member of a collecting society that administers voluntary licensing schemes, via that society, from any exercise by You of the rights granted under this License.
+
+The above rights may be exercised in all media and formats whether now known or hereafter devised. The above rights include the right to make such modifications as are technically necessary to exercise the rights in other media and formats. Subject to Section 8(f), all rights not expressly granted by Licensor are hereby reserved.
+
+4. Restrictions. The license granted in Section 3 above is expressly made subject to and limited by the following restrictions:
+
+ a. You may Distribute or Publicly Perform the Work only under the terms of this License. You must include a copy of, or the Uniform Resource Identifier (URI) for, this License with every copy of the Work You Distribute or Publicly Perform. You may not offer or impose any terms on the Work that restrict the terms of this License or the ability of the recipient of the Work to exercise the rights granted to that recipient under the terms of the License. You may not sublicense the Work. You must keep intact all notices that refer to this License and to the disclaimer of warranties with every copy of the Work You Distribute or Publicly Perform. When You Distribute or Publicly Perform the Work, You may not impose any effective technological measures on the Work that restrict the ability of a recipient of the Work from You to exercise the rights granted to that recipient under the terms of the License. This Section 4(a) applies to the Work as incorporated in a Collection, but this does not require the Collection apart from the Work itself to be made subject to the terms of this License. If You create a Collection, upon notice from any Licensor You must, to the extent practicable, remove from the Collection any credit as required by Section 4(c), as requested. If You create an Adaptation, upon notice from any Licensor You must, to the extent practicable, remove from the Adaptation any credit as required by Section 4(c), as requested.
+
+ b. You may Distribute or Publicly Perform an Adaptation only under the terms of: (i) this License; (ii) a later version of this License with the same License Elements as this License; (iii) a Creative Commons jurisdiction license (either this or a later license version) that contains the same License Elements as this License (e.g., Attribution-ShareAlike 3.0 US)); (iv) a Creative Commons Compatible License. If you license the Adaptation under one of the licenses mentioned in (iv), you must comply with the terms of that license. If you license the Adaptation under the terms of any of the licenses mentioned in (i), (ii) or (iii) (the "Applicable License"), you must comply with the terms of the Applicable License generally and the following provisions: (I) You must include a copy of, or the URI for, the Applicable License with every copy of each Adaptation You Distribute or Publicly Perform; (II) You may not offer or impose any terms on the Adaptation that restrict the terms of the Applicable License or the ability of the recipient of the Adaptation to exercise the rights granted to that recipient under the terms of the Applicable License; (III) You must keep intact all notices that refer to the Applicable License and to the disclaimer of warranties with every copy of the Work as included in the Adaptation You Distribute or Publicly Perform; (IV) when You Distribute or Publicly Perform the Adaptation, You may not impose any effective technological measures on the Adaptation that restrict the ability of a recipient of the Adaptation from You to exercise the rights granted to that recipient under the terms of the Applicable License. This Section 4(b) applies to the Adaptation as incorporated in a Collection, but this does not require the Collection apart from the Adaptation itself to be made subject to the terms of the Applicable License.
+
+ c. If You Distribute, or Publicly Perform the Work or any Adaptations or Collections, You must, unless a request has been made pursuant to Section 4(a), keep intact all copyright notices for the Work and provide, reasonable to the medium or means You are utilizing: (i) the name of the Original Author (or pseudonym, if applicable) if supplied, and/or if the Original Author and/or Licensor designate another party or parties (e.g., a sponsor institute, publishing entity, journal) for attribution ("Attribution Parties") in Licensor's copyright notice, terms of service or by other reasonable means, the name of such party or parties; (ii) the title of the Work if supplied; (iii) to the extent reasonably practicable, the URI, if any, that Licensor specifies to be associated with the Work, unless such URI does not refer to the copyright notice or licensing information for the Work; and (iv) , consistent with Ssection 3(b), in the case of an Adaptation, a credit identifying the use of the Work in the Adaptation (e.g., "French translation of the Work by Original Author," or "Screenplay based on original Work by Original Author"). The credit required by this Section 4(c) may be implemented in any reasonable manner; provided, however, that in the case of a Adaptation or Collection, at a minimum such credit will appear, if a credit for all contributing authors of the Adaptation or Collection appears, then as part of these credits and in a manner at least as prominent as the credits for the other contributing authors. For the avoidance of doubt, You may only use the credit required by this Section for the purpose of attribution in the manner set out above and, by exercising Your rights under this License, You may not implicitly or explicitly assert or imply any connection with, sponsorship or endorsement by the Original Author, Licensor and/or Attribution Parties, as appropriate, of You or Your use of the Work, without the separate, express prior written permission of the Original Author, Licensor and/or Attribution Parties.
+
+ d. Except as otherwise agreed in writing by the Licensor or as may be otherwise permitted by applicable law, if You Reproduce, Distribute or Publicly Perform the Work either by itself or as part of any Adaptations or Collections, You must not distort, mutilate, modify or take other derogatory action in relation to the Work which would be prejudicial to the Original Author's honor or reputation. Licensor agrees that in those jurisdictions (e.g. Japan), in which any exercise of the right granted in Section 3(b) of this License (the right to make Adaptations) would be deemed to be a distortion, mutilation, modification or other derogatory action prejudicial to the Original Author's honor and reputation, the Licensor will waive or not assert, as appropriate, this Section, to the fullest extent permitted by the applicable national law, to enable You to reasonably exercise Your right under Section 3(b) of this License (right to make Adaptations) but not otherwise.
+
+5. Representations, Warranties and Disclaimer
+
+UNLESS OTHERWISE MUTUALLY AGREED TO BY THE PARTIES IN WRITING, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE WORK, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU.
+
+6. Limitation on Liability. EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
+
+7. Termination
+
+ a. This License and the rights granted hereunder will terminate automatically upon any breach by You of the terms of this License. Individuals or entities who have received Adaptations or Collections from You under this License, however, will not have their licenses terminated provided such individuals or entities remain in full compliance with those licenses. Sections 1, 2, 5, 6, 7, and 8 will survive any termination of this License.
+
+ b. Subject to the above terms and conditions, the license granted here is perpetual (for the duration of the applicable copyright in the Work). Notwithstanding the above, Licensor reserves the right to release the Work under different license terms or to stop distributing the Work at any time; provided, however that any such election will not serve to withdraw this License (or any other license that has been, or is required to be, granted under the terms of this License), and this License will continue in full force and effect unless terminated as stated above.
+
+8. Miscellaneous
+
+ a. Each time You Distribute or Publicly Perform the Work or a Collection, the Licensor offers to the recipient a license to the Work on the same terms and conditions as the license granted to You under this License.
+
+ b. Each time You Distribute or Publicly Perform an Adaptation, Licensor offers to the recipient a license to the original Work on the same terms and conditions as the license granted to You under this License.
+
+ c. If any provision of this License is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this License, and without further action by the parties to this agreement, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.
+
+ d. No term or provision of this License shall be deemed waived and no breach consented to unless such waiver or consent shall be in writing and signed by the party to be charged with such waiver or consent.
+
+ e. This License constitutes the entire agreement between the parties with respect to the Work licensed here. There are no understandings, agreements or representations with respect to the Work not specified here. Licensor shall not be bound by any additional provisions that may appear in any communication from You. This License may not be modified without the mutual written agreement of the Licensor and You.
+
+ f. The rights granted under, and the subject matter referenced, in this License were drafted utilizing the terminology of the Berne Convention for the Protection of Literary and Artistic Works (as amended on September 28, 1979), the Rome Convention of 1961, the WIPO Copyright Treaty of 1996, the WIPO Performances and Phonograms Treaty of 1996 and the Universal Copyright Convention (as revised on July 24, 1971). These rights and subject matter take effect in the relevant jurisdiction in which the License terms are sought to be enforced according to the corresponding provisions of the implementation of those treaty provisions in the applicable national law. If the standard suite of rights granted under applicable copyright law includes additional rights not granted under this License, such additional rights are deemed to be included in the License; this License is not intended to restrict the license of any rights under applicable law.
+
+Creative Commons Notice
+
+Creative Commons is not a party to this License, and makes no warranty whatsoever in connection with the Work. Creative Commons will not be liable to You or any party on any legal theory for any damages whatsoever, including without limitation any general, special, incidental or consequential damages arising in connection to this license. Notwithstanding the foregoing two (2) sentences, if Creative Commons has expressly identified itself as the Licensor hereunder, it shall have all rights and obligations of Licensor.
+
+Except for the limited purpose of indicating to the public that the Work is licensed under the CCPL, Creative Commons does not authorize the use by either party of the trademark "Creative Commons" or any related trademark or logo of Creative Commons without the prior written consent of Creative Commons. Any permitted use will be in compliance with Creative Commons' then-current trademark usage guidelines, as may be published on its website or otherwise made available upon request from time to time. For the avoidance of doubt, this trademark restriction does not form part of the License.
+
+Creative Commons may be contacted at http://creativecommons.org/.
diff --git a/LICENSES/CC-BY-SA-4.0.txt b/LICENSES/CC-BY-SA-4.0.txt
new file mode 100644
index 00000000..835a6836
--- /dev/null
+++ b/LICENSES/CC-BY-SA-4.0.txt
@@ -0,0 +1,170 @@
+Creative Commons Attribution-ShareAlike 4.0 International
+
+ Creative Commons Corporation (“Creative Commons”) is not a law firm and does not provide legal services or legal advice. Distribution of Creative Commons public licenses does not create a lawyer-client or other relationship. Creative Commons makes its licenses and related information available on an “as-is” basis. Creative Commons gives no warranties regarding its licenses, any material licensed under their terms and conditions, or any related information. Creative Commons disclaims all liability for damages resulting from their use to the fullest extent possible.
+
+Using Creative Commons Public Licenses
+
+Creative Commons public licenses provide a standard set of terms and conditions that creators and other rights holders may use to share original works of authorship and other material subject to copyright and certain other rights specified in the public license below. The following considerations are for informational purposes only, are not exhaustive, and do not form part of our licenses.
+
+Considerations for licensors: Our public licenses are intended for use by those authorized to give the public permission to use material in ways otherwise restricted by copyright and certain other rights. Our licenses are irrevocable. Licensors should read and understand the terms and conditions of the license they choose before applying it. Licensors should also secure all rights necessary before applying our licenses so that the public can reuse the material as expected. Licensors should clearly mark any material not subject to the license. This includes other CC-licensed material, or material used under an exception or limitation to copyright. More considerations for licensors.
+
+Considerations for the public: By using one of our public licenses, a licensor grants the public permission to use the licensed material under specified terms and conditions. If the licensor’s permission is not necessary for any reason–for example, because of any applicable exception or limitation to copyright–then that use is not regulated by the license. Our licenses grant only permissions under copyright and certain other rights that a licensor has authority to grant. Use of the licensed material may still be restricted for other reasons, including because others have copyright or other rights in the material. A licensor may make special requests, such as asking that all changes be marked or described.
+
+Although not required by our licenses, you are encouraged to respect those requests where reasonable. More considerations for the public.
+
+Creative Commons Attribution-ShareAlike 4.0 International Public License
+
+By exercising the Licensed Rights (defined below), You accept and agree to be bound by the terms and conditions of this Creative Commons Attribution-ShareAlike 4.0 International Public License ("Public License"). To the extent this Public License may be interpreted as a contract, You are granted the Licensed Rights in consideration of Your acceptance of these terms and conditions, and the Licensor grants You such rights in consideration of benefits the Licensor receives from making the Licensed Material available under these terms and conditions.
+
+Section 1 – Definitions.
+
+ a. Adapted Material means material subject to Copyright and Similar Rights that is derived from or based upon the Licensed Material and in which the Licensed Material is translated, altered, arranged, transformed, or otherwise modified in a manner requiring permission under the Copyright and Similar Rights held by the Licensor. For purposes of this Public License, where the Licensed Material is a musical work, performance, or sound recording, Adapted Material is always produced where the Licensed Material is synched in timed relation with a moving image.
+
+ b. Adapter's License means the license You apply to Your Copyright and Similar Rights in Your contributions to Adapted Material in accordance with the terms and conditions of this Public License.
+
+ c. BY-SA Compatible License means a license listed at creativecommons.org/compatiblelicenses, approved by Creative Commons as essentially the equivalent of this Public License.
+
+ d. Copyright and Similar Rights means copyright and/or similar rights closely related to copyright including, without limitation, performance, broadcast, sound recording, and Sui Generis Database Rights, without regard to how the rights are labeled or categorized. For purposes of this Public License, the rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights.
+
+ e. Effective Technological Measures means those measures that, in the absence of proper authority, may not be circumvented under laws fulfilling obligations under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996, and/or similar international agreements.
+
+ f. Exceptions and Limitations means fair use, fair dealing, and/or any other exception or limitation to Copyright and Similar Rights that applies to Your use of the Licensed Material.
+
+ g. License Elements means the license attributes listed in the name of a Creative Commons Public License. The License Elements of this Public License are Attribution and ShareAlike.
+
+ h. Licensed Material means the artistic or literary work, database, or other material to which the Licensor applied this Public License.
+
+ i. Licensed Rights means the rights granted to You subject to the terms and conditions of this Public License, which are limited to all Copyright and Similar Rights that apply to Your use of the Licensed Material and that the Licensor has authority to license.
+
+ j. Licensor means the individual(s) or entity(ies) granting rights under this Public License.
+
+ k. Share means to provide material to the public by any means or process that requires permission under the Licensed Rights, such as reproduction, public display, public performance, distribution, dissemination, communication, or importation, and to make material available to the public including in ways that members of the public may access the material from a place and at a time individually chosen by them.
+
+ l. Sui Generis Database Rights means rights other than copyright resulting from Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, as amended and/or succeeded, as well as other essentially equivalent rights anywhere in the world.
+
+ m. You means the individual or entity exercising the Licensed Rights under this Public License. Your has a corresponding meaning.
+
+Section 2 – Scope.
+
+ a. License grant.
+
+ 1. Subject to the terms and conditions of this Public License, the Licensor hereby grants You a worldwide, royalty-free, non-sublicensable, non-exclusive, irrevocable license to exercise the Licensed Rights in the Licensed Material to:
+
+ A. reproduce and Share the Licensed Material, in whole or in part; and
+
+ B. produce, reproduce, and Share Adapted Material.
+
+ 2. Exceptions and Limitations. For the avoidance of doubt, where Exceptions and Limitations apply to Your use, this Public License does not apply, and You do not need to comply with its terms and conditions.
+
+ 3. Term. The term of this Public License is specified in Section 6(a).
+
+ 4. Media and formats; technical modifications allowed. The Licensor authorizes You to exercise the Licensed Rights in all media and formats whether now known or hereafter created, and to make technical modifications necessary to do so. The Licensor waives and/or agrees not to assert any right or authority to forbid You from making technical modifications necessary to exercise the Licensed Rights, including technical modifications necessary to circumvent Effective Technological Measures. For purposes of this Public License, simply making modifications authorized by this Section 2(a)(4) never produces Adapted Material.
+
+ 5. Downstream recipients.
+
+ A. Offer from the Licensor – Licensed Material. Every recipient of the Licensed Material automatically receives an offer from the Licensor to exercise the Licensed Rights under the terms and conditions of this Public License.
+
+ B. Additional offer from the Licensor – Adapted Material. Every recipient of Adapted Material from You automatically receives an offer from the Licensor to exercise the Licensed Rights in the Adapted Material under the conditions of the Adapter’s License You apply.
+
+ C. No downstream restrictions. You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, the Licensed Material if doing so restricts exercise of the Licensed Rights by any recipient of the Licensed Material.
+
+ 6. No endorsement. Nothing in this Public License constitutes or may be construed as permission to assert or imply that You are, or that Your use of the Licensed Material is, connected with, or sponsored, endorsed, or granted official status by, the Licensor or others designated to receive attribution as provided in Section 3(a)(1)(A)(i).
+
+ b. Other rights.
+
+ 1. Moral rights, such as the right of integrity, are not licensed under this Public License, nor are publicity, privacy, and/or other similar personality rights; however, to the extent possible, the Licensor waives and/or agrees not to assert any such rights held by the Licensor to the limited extent necessary to allow You to exercise the Licensed Rights, but not otherwise.
+
+ 2. Patent and trademark rights are not licensed under this Public License.
+
+ 3. To the extent possible, the Licensor waives any right to collect royalties from You for the exercise of the Licensed Rights, whether directly or through a collecting society under any voluntary or waivable statutory or compulsory licensing scheme. In all other cases the Licensor expressly reserves any right to collect such royalties.
+
+Section 3 – License Conditions.
+
+Your exercise of the Licensed Rights is expressly made subject to the following conditions.
+
+ a. Attribution.
+
+ 1. If You Share the Licensed Material (including in modified form), You must:
+
+ A. retain the following if it is supplied by the Licensor with the Licensed Material:
+
+ i. identification of the creator(s) of the Licensed Material and any others designated to receive attribution, in any reasonable manner requested by the Licensor (including by pseudonym if designated);
+
+ ii. a copyright notice;
+
+ iii. a notice that refers to this Public License;
+
+ iv. a notice that refers to the disclaimer of warranties;
+
+ v. a URI or hyperlink to the Licensed Material to the extent reasonably practicable;
+
+ B. indicate if You modified the Licensed Material and retain an indication of any previous modifications; and
+
+ C. indicate the Licensed Material is licensed under this Public License, and include the text of, or the URI or hyperlink to, this Public License.
+
+ 2. You may satisfy the conditions in Section 3(a)(1) in any reasonable manner based on the medium, means, and context in which You Share the Licensed Material. For example, it may be reasonable to satisfy the conditions by providing a URI or hyperlink to a resource that includes the required information.
+
+ 3. If requested by the Licensor, You must remove any of the information required by Section 3(a)(1)(A) to the extent reasonably practicable.
+
+ b. ShareAlike.In addition to the conditions in Section 3(a), if You Share Adapted Material You produce, the following conditions also apply.
+
+ 1. The Adapter’s License You apply must be a Creative Commons license with the same License Elements, this version or later, or a BY-SA Compatible License.
+
+ 2. You must include the text of, or the URI or hyperlink to, the Adapter's License You apply. You may satisfy this condition in any reasonable manner based on the medium, means, and context in which You Share Adapted Material.
+
+ 3. You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, Adapted Material that restrict exercise of the rights granted under the Adapter's License You apply.
+
+Section 4 – Sui Generis Database Rights.
+
+Where the Licensed Rights include Sui Generis Database Rights that apply to Your use of the Licensed Material:
+
+ a. for the avoidance of doubt, Section 2(a)(1) grants You the right to extract, reuse, reproduce, and Share all or a substantial portion of the contents of the database;
+
+ b. if You include all or a substantial portion of the database contents in a database in which You have Sui Generis Database Rights, then the database in which You have Sui Generis Database Rights (but not its individual contents) is Adapted Material, including for purposes of Section 3(b); and
+
+ c. You must comply with the conditions in Section 3(a) if You Share all or a substantial portion of the contents of the database.
+For the avoidance of doubt, this Section 4 supplements and does not replace Your obligations under this Public License where the Licensed Rights include other Copyright and Similar Rights.
+
+Section 5 – Disclaimer of Warranties and Limitation of Liability.
+
+ a. Unless otherwise separately undertaken by the Licensor, to the extent possible, the Licensor offers the Licensed Material as-is and as-available, and makes no representations or warranties of any kind concerning the Licensed Material, whether express, implied, statutory, or other. This includes, without limitation, warranties of title, merchantability, fitness for a particular purpose, non-infringement, absence of latent or other defects, accuracy, or the presence or absence of errors, whether or not known or discoverable. Where disclaimers of warranties are not allowed in full or in part, this disclaimer may not apply to You.
+
+ b. To the extent possible, in no event will the Licensor be liable to You on any legal theory (including, without limitation, negligence) or otherwise for any direct, special, indirect, incidental, consequential, punitive, exemplary, or other losses, costs, expenses, or damages arising out of this Public License or use of the Licensed Material, even if the Licensor has been advised of the possibility of such losses, costs, expenses, or damages. Where a limitation of liability is not allowed in full or in part, this limitation may not apply to You.
+
+ c. The disclaimer of warranties and limitation of liability provided above shall be interpreted in a manner that, to the extent possible, most closely approximates an absolute disclaimer and waiver of all liability.
+
+Section 6 – Term and Termination.
+
+ a. This Public License applies for the term of the Copyright and Similar Rights licensed here. However, if You fail to comply with this Public License, then Your rights under this Public License terminate automatically.
+
+ b. Where Your right to use the Licensed Material has terminated under Section 6(a), it reinstates:
+
+ 1. automatically as of the date the violation is cured, provided it is cured within 30 days of Your discovery of the violation; or
+
+ 2. upon express reinstatement by the Licensor.
+
+ c. For the avoidance of doubt, this Section 6(b) does not affect any right the Licensor may have to seek remedies for Your violations of this Public License.
+
+ d. For the avoidance of doubt, the Licensor may also offer the Licensed Material under separate terms or conditions or stop distributing the Licensed Material at any time; however, doing so will not terminate this Public License.
+
+ e. Sections 1, 5, 6, 7, and 8 survive termination of this Public License.
+
+Section 7 – Other Terms and Conditions.
+
+ a. The Licensor shall not be bound by any additional or different terms or conditions communicated by You unless expressly agreed.
+
+ b. Any arrangements, understandings, or agreements regarding the Licensed Material not stated herein are separate from and independent of the terms and conditions of this Public License.
+
+Section 8 – Interpretation.
+
+ a. For the avoidance of doubt, this Public License does not, and shall not be interpreted to, reduce, limit, restrict, or impose conditions on any use of the Licensed Material that could lawfully be made without permission under this Public License.
+
+ b. To the extent possible, if any provision of this Public License is deemed unenforceable, it shall be automatically reformed to the minimum extent necessary to make it enforceable. If the provision cannot be reformed, it shall be severed from this Public License without affecting the enforceability of the remaining terms and conditions.
+
+ c. No term or condition of this Public License will be waived and no failure to comply consented to unless expressly agreed to by the Licensor.
+
+ d. Nothing in this Public License constitutes or may be interpreted as a limitation upon, or waiver of, any privileges and immunities that apply to the Licensor or You, including from the legal processes of any jurisdiction or authority.
+
+Creative Commons is not a party to its public licenses. Notwithstanding, Creative Commons may elect to apply one of its public licenses to material it publishes and in those instances will be considered the “Licensor.” Except for the limited purpose of indicating that material is shared under a Creative Commons public license or as otherwise permitted by the Creative Commons policies published at creativecommons.org/policies, Creative Commons does not authorize the use of the trademark “Creative Commons” or any other trademark or logo of Creative Commons without its prior written consent including, without limitation, in connection with any unauthorized modifications to any of its public licenses or any other arrangements, understandings, or agreements concerning use of licensed material. For the avoidance of doubt, this paragraph does not form part of the public licenses.
+
+Creative Commons may be contacted at creativecommons.org.
diff --git a/LICENSES/GFDL-1.2-or-later.txt b/LICENSES/GFDL-1.2-or-later.txt
new file mode 100644
index 00000000..83c375ab
--- /dev/null
+++ b/LICENSES/GFDL-1.2-or-later.txt
@@ -0,0 +1,130 @@
+GNU Free Documentation License
+Version 1.2, November 2002
+
+Copyright (C) 2000,2001,2002 Free Software Foundation, Inc. 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+
+Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
+
+0. PREAMBLE
+
+The purpose of this License is to make a manual, textbook, or other functional and useful document "free" in the sense of freedom: to assure everyone the effective freedom to copy and redistribute it, with or without modifying it, either commercially or noncommercially. Secondarily, this License preserves for the author and publisher a way to get credit for their work, while not being considered responsible for modifications made by others.
+
+This License is a kind of "copyleft", which means that derivative works of the document must themselves be free in the same sense. It complements the GNU General Public License, which is a copyleft license designed for free software.
+
+We have designed this License in order to use it for manuals for free software, because free software needs free documentation: a free program should come with manuals providing the same freedoms that the software does. But this License is not limited to software manuals; it can be used for any textual work, regardless of subject matter or whether it is published as a printed book. We recommend this License principally for works whose purpose is instruction or reference.
+
+1. APPLICABILITY AND DEFINITIONS
+
+This License applies to any manual or other work, in any medium, that contains a notice placed by the copyright holder saying it can be distributed under the terms of this License. Such a notice grants a world-wide, royalty-free license, unlimited in duration, to use that work under the conditions stated herein. The "Document", below, refers to any such manual or work. Any member of the public is a licensee, and is addressed as "you". You accept the license if you copy, modify or distribute the work in a way requiring permission under copyright law.
+
+A "Modified Version" of the Document means any work containing the Document or a portion of it, either copied verbatim, or with modifications and/or translated into another language.
+
+A "Secondary Section" is a named appendix or a front-matter section of the Document that deals exclusively with the relationship of the publishers or authors of the Document to the Document's overall subject (or to related matters) and contains nothing that could fall directly within that overall subject. (Thus, if the Document is in part a textbook of mathematics, a Secondary Section may not explain any mathematics.) The relationship could be a matter of historical connection with the subject or with related matters, or of legal, commercial, philosophical, ethical or political position regarding them.
+
+The "Invariant Sections" are certain Secondary Sections whose titles are designated, as being those of Invariant Sections, in the notice that says that the Document is released under this License. If a section does not fit the above definition of Secondary then it is not allowed to be designated as Invariant. The Document may contain zero Invariant Sections. If the Document does not identify any Invariant Sections then there are none.
+
+The "Cover Texts" are certain short passages of text that are listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says that the Document is released under this License. A Front-Cover Text may be at most 5 words, and a Back-Cover Text may be at most 25 words.
+
+A "Transparent" copy of the Document means a machine-readable copy, represented in a format whose specification is available to the general public, that is suitable for revising the document straightforwardly with generic text editors or (for images composed of pixels) generic paint programs or (for drawings) some widely available drawing editor, and that is suitable for input to text formatters or for automatic translation to a variety of formats suitable for input to text formatters. A copy made in an otherwise Transparent file format whose markup, or absence of markup, has been arranged to thwart or discourage subsequent modification by readers is not Transparent. An image format is not Transparent if used for any substantial amount of text. A copy that is not "Transparent" is called "Opaque".
+
+Examples of suitable formats for Transparent copies include plain ASCII without markup, Texinfo input format, LaTeX input format, SGML or XML using a publicly available DTD, and standard-conforming simple HTML, PostScript or PDF designed for human modification. Examples of transparent image formats include PNG, XCF and JPG. Opaque formats include proprietary formats that can be read and edited only by proprietary word processors, SGML or XML for which the DTD and/or processing tools are not generally available, and the machine-generated HTML, PostScript or PDF produced by some word processors for output purposes only.
+
+The "Title Page" means, for a printed book, the title page itself, plus such following pages as are needed to hold, legibly, the material this License requires to appear in the title page. For works in formats which do not have any title page as such, "Title Page" means the text near the most prominent appearance of the work's title, preceding the beginning of the body of the text.
+
+A section "Entitled XYZ" means a named subunit of the Document whose title either is precisely XYZ or contains XYZ in parentheses following text that translates XYZ in another language. (Here XYZ stands for a specific section name mentioned below, such as "Acknowledgements", "Dedications", "Endorsements", or "History".) To "Preserve the Title" of such a section when you modify the Document means that it remains a section "Entitled XYZ" according to this definition.
+
+The Document may include Warranty Disclaimers next to the notice which states that this License applies to the Document. These Warranty Disclaimers are considered to be included by reference in this License, but only as regards disclaiming warranties: any other implication that these Warranty Disclaimers may have is void and has no effect on the meaning of this License.
+
+2. VERBATIM COPYING
+
+You may copy and distribute the Document in any medium, either commercially or noncommercially, provided that this License, the copyright notices, and the license notice saying this License applies to the Document are reproduced in all copies, and that you add no other conditions whatsoever to those of this License. You may not use technical measures to obstruct or control the reading or further copying of the copies you make or distribute. However, you may accept compensation in exchange for copies. If you distribute a large enough number of copies you must also follow the conditions in section 3.
+
+You may also lend copies, under the same conditions stated above, and you may publicly display copies.
+
+3. COPYING IN QUANTITY
+
+If you publish printed copies (or copies in media that commonly have printed covers) of the Document, numbering more than 100, and the Document's license notice requires Cover Texts, you must enclose the copies in covers that carry, clearly and legibly, all these Cover Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on the back cover. Both covers must also clearly and legibly identify you as the publisher of these copies. The front cover must present the full title with all words of the title equally prominent and visible. You may add other material on the covers in addition. Copying with changes limited to the covers, as long as they preserve the title of the Document and satisfy these conditions, can be treated as verbatim copying in other respects.
+
+If the required texts for either cover are too voluminous to fit legibly, you should put the first ones listed (as many as fit reasonably) on the actual cover, and continue the rest onto adjacent pages.
+
+If you publish or distribute Opaque copies of the Document numbering more than 100, you must either include a machine-readable Transparent copy along with each Opaque copy, or state in or with each Opaque copy a computer-network location from which the general network-using public has access to download using public-standard network protocols a complete Transparent copy of the Document, free of added material. If you use the latter option, you must take reasonably prudent steps, when you begin distribution of Opaque copies in quantity, to ensure that this Transparent copy will remain thus accessible at the stated location until at least one year after the last time you distribute an Opaque copy (directly or through your agents or retailers) of that edition to the public.
+
+It is requested, but not required, that you contact the authors of the Document well before redistributing any large number of copies, to give them a chance to provide you with an updated version of the Document.
+
+4. MODIFICATIONS
+
+You may copy and distribute a Modified Version of the Document under the conditions of sections 2 and 3 above, provided that you release the Modified Version under precisely this License, with the Modified Version filling the role of the Document, thus licensing distribution and modification of the Modified Version to whoever possesses a copy of it. In addition, you must do these things in the Modified Version:
+
+ A. Use in the Title Page (and on the covers, if any) a title distinct from that of the Document, and from those of previous versions (which should, if there were any, be listed in the History section of the Document). You may use the same title as a previous version if the original publisher of that version gives permission.
+ B. List on the Title Page, as authors, one or more persons or entities responsible for authorship of the modifications in the Modified Version, together with at least five of the principal authors of the Document (all of its principal authors, if it has fewer than five), unless they release you from this requirement.
+ C. State on the Title page the name of the publisher of the Modified Version, as the publisher.
+ D. Preserve all the copyright notices of the Document.
+ E. Add an appropriate copyright notice for your modifications adjacent to the other copyright notices.
+ F. Include, immediately after the copyright notices, a license notice giving the public permission to use the Modified Version under the terms of this License, in the form shown in the Addendum below.
+ G. Preserve in that license notice the full lists of Invariant Sections and required Cover Texts given in the Document's license notice.
+ H. Include an unaltered copy of this License.
+ I. Preserve the section Entitled "History", Preserve its Title, and add to it an item stating at least the title, year, new authors, and publisher of the Modified Version as given on the Title Page. If there is no section Entitled "History" in the Document, create one stating the title, year, authors, and publisher of the Document as given on its Title Page, then add an item describing the Modified Version as stated in the previous sentence.
+ J. Preserve the network location, if any, given in the Document for public access to a Transparent copy of the Document, and likewise the network locations given in the Document for previous versions it was based on. These may be placed in the "History" section. You may omit a network location for a work that was published at least four years before the Document itself, or if the original publisher of the version it refers to gives permission.
+ K. For any section Entitled "Acknowledgements" or "Dedications", Preserve the Title of the section, and preserve in the section all the substance and tone of each of the contributor acknowledgements and/or dedications given therein.
+ L. Preserve all the Invariant Sections of the Document, unaltered in their text and in their titles. Section numbers or the equivalent are not considered part of the section titles.
+ M. Delete any section Entitled "Endorsements". Such a section may not be included in the Modified Version.
+ N. Do not retitle any existing section to be Entitled "Endorsements" or to conflict in title with any Invariant Section.
+ O. Preserve any Warranty Disclaimers.
+
+If the Modified Version includes new front-matter sections or appendices that qualify as Secondary Sections and contain no material copied from the Document, you may at your option designate some or all of these sections as invariant. To do this, add their titles to the list of Invariant Sections in the Modified Version's license notice. These titles must be distinct from any other section titles.
+
+You may add a section Entitled "Endorsements", provided it contains nothing but endorsements of your Modified Version by various parties--for example, statements of peer review or that the text has been approved by an organization as the authoritative definition of a standard.
+
+You may add a passage of up to five words as a Front-Cover Text, and a passage of up to 25 words as a Back-Cover Text, to the end of the list of Cover Texts in the Modified Version. Only one passage of Front-Cover Text and one of Back-Cover Text may be added by (or through arrangements made by) any one entity. If the Document already includes a cover text for the same cover, previously added by you or by arrangement made by the same entity you are acting on behalf of, you may not add another; but you may replace the old one, on explicit permission from the previous publisher that added the old one.
+
+The author(s) and publisher(s) of the Document do not by this License give permission to use their names for publicity for or to assert or imply endorsement of any Modified Version.
+
+5. COMBINING DOCUMENTS
+
+You may combine the Document with other documents released under this License, under the terms defined in section 4 above for modified versions, provided that you include in the combination all of the Invariant Sections of all of the original documents, unmodified, and list them all as Invariant Sections of your combined work in its license notice, and that you preserve all their Warranty Disclaimers.
+
+The combined work need only contain one copy of this License, and multiple identical Invariant Sections may be replaced with a single copy. If there are multiple Invariant Sections with the same name but different contents, make the title of each such section unique by adding at the end of it, in parentheses, the name of the original author or publisher of that section if known, or else a unique number. Make the same adjustment to the section titles in the list of Invariant Sections in the license notice of the combined work.
+
+In the combination, you must combine any sections Entitled "History" in the various original documents, forming one section Entitled "History"; likewise combine any sections Entitled "Acknowledgements", and any sections Entitled "Dedications". You must delete all sections Entitled "Endorsements".
+
+6. COLLECTIONS OF DOCUMENTS
+
+You may make a collection consisting of the Document and other documents released under this License, and replace the individual copies of this License in the various documents with a single copy that is included in the collection, provided that you follow the rules of this License for verbatim copying of each of the documents in all other respects.
+
+You may extract a single document from such a collection, and distribute it individually under this License, provided you insert a copy of this License into the extracted document, and follow this License in all other respects regarding verbatim copying of that document.
+
+7. AGGREGATION WITH INDEPENDENT WORKS
+
+A compilation of the Document or its derivatives with other separate and independent documents or works, in or on a volume of a storage or distribution medium, is called an "aggregate" if the copyright resulting from the compilation is not used to limit the legal rights of the compilation's users beyond what the individual works permit. When the Document is included in an aggregate, this License does not apply to the other works in the aggregate which are not themselves derivative works of the Document.
+
+If the Cover Text requirement of section 3 is applicable to these copies of the Document, then if the Document is less than one half of the entire aggregate, the Document's Cover Texts may be placed on covers that bracket the Document within the aggregate, or the electronic equivalent of covers if the Document is in electronic form. Otherwise they must appear on printed covers that bracket the whole aggregate.
+
+8. TRANSLATION
+
+Translation is considered a kind of modification, so you may distribute translations of the Document under the terms of section 4. Replacing Invariant Sections with translations requires special permission from their copyright holders, but you may include translations of some or all Invariant Sections in addition to the original versions of these Invariant Sections. You may include a translation of this License, and all the license notices in the Document, and any Warranty Disclaimers, provided that you also include the original English version of this License and the original versions of those notices and disclaimers. In case of a disagreement between the translation and the original version of this License or a notice or disclaimer, the original version will prevail.
+
+If a section in the Document is Entitled "Acknowledgements", "Dedications", or "History", the requirement (section 4) to Preserve its Title (section 1) will typically require changing the actual title.
+
+9. TERMINATION
+
+You may not copy, modify, sublicense, or distribute the Document except as expressly provided for under this License. Any other attempt to copy, modify, sublicense or distribute the Document 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.
+
+10. FUTURE REVISIONS OF THIS LICENSE
+
+The Free Software Foundation may publish new, revised versions of the GNU Free Documentation 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. See http://www.gnu.org/copyleft/.
+
+Each version of the License is given a distinguishing version number. If the Document specifies that a particular numbered version of this License "or any later version" applies to it, you have the option of following the terms and conditions either of that specified version or of any later version that has been published (not as a draft) by the Free Software Foundation. If the Document does not specify a version number of this License, you may choose any version ever published (not as a draft) by the Free Software Foundation.
+
+ADDENDUM: How to use this License for your documents
+
+To use this License in a document you have written, include a copy of the License in the document and put the following copyright and license notices just after the title page:
+
+ Copyright (c) YEAR YOUR NAME. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License".
+
+If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, replace the "with...Texts." line with this:
+
+ with the Invariant Sections being LIST THEIR TITLES, with the Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
+
+If you have Invariant Sections without Cover Texts, or some other combination of the three, merge those two alternatives to suit the situation.
+
+If your document contains nontrivial examples of program code, we recommend releasing these examples in parallel under your choice of free software license, such as the GNU General Public License, to permit their use in free software.
diff --git a/LICENSES/MIT.txt b/LICENSES/MIT.txt
new file mode 100644
index 00000000..2071b23b
--- /dev/null
+++ b/LICENSES/MIT.txt
@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) <year> <copyright holders>
+
+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.
diff --git a/LICENSES/MPL-2.0.txt b/LICENSES/MPL-2.0.txt
new file mode 100644
index 00000000..ee6256cd
--- /dev/null
+++ b/LICENSES/MPL-2.0.txt
@@ -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 https://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.
diff --git a/LICENSES/Zlib.txt b/LICENSES/Zlib.txt
new file mode 100644
index 00000000..e0e3605b
--- /dev/null
+++ b/LICENSES/Zlib.txt
@@ -0,0 +1,11 @@
+zlib License
+
+This software is provided 'as-is', without any express or implied warranty. In no event will the authors be held liable for any damages arising from the use of this software.
+
+Permission is granted to anyone to use this software for any purpose, including commercial applications, and to alter it and redistribute it freely, subject to the following restrictions:
+
+ 1. The origin of this software must not be misrepresented; you must not claim that you wrote the original software. If you use this software in a product, an acknowledgment in the product documentation would be appreciated but is not required.
+
+ 2. Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software.
+
+ 3. This notice may not be removed or altered from any source distribution.
diff --git a/README.md b/README.md
index b8832758..6d7a0a35 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,7 @@
<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]
+[![Build Status](https://github.com/ocrmypdf/OCRmyPDF/actions/workflows/build.yml/badge.svg)](https://github.com/ocrmypdf/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"
@@ -36,6 +34,7 @@ ocrmypdf # it's a scriptable command line program
- 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)
+- Keeps your private data private.
- Scales properly to handle files with thousands of pages
- Battle-tested on millions of PDFs
@@ -64,10 +63,12 @@ Linux, Windows, macOS and FreeBSD are supported. Docker images are also availabl
| Debian, Ubuntu | ``apt install ocrmypdf`` |
| Windows Subsystem for Linux | ``apt install ocrmypdf`` |
| Fedora | ``dnf install ocrmypdf`` |
-| macOS | ``brew install ocrmypdf`` |
+| macOS (Homebrew) | ``brew install ocrmypdf`` |
+| macOS (nix) | ``nix-env -i ocrmypdf`` |
| LinuxBrew | ``brew install ocrmypdf`` |
| FreeBSD | ``pkg install py37-ocrmypdf`` |
| Conda | ``conda install ocrmypdf`` |
+| Ubuntu Snap | ``snap install ocrmypdf`` |
For everyone else, [see our documentation](https://ocrmypdf.readthedocs.io/en/latest/installation.html) for installation steps.
@@ -106,7 +107,7 @@ 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.
+Please report issues on our [GitHub issues](https://github.com/ocrmypdf/OCRmyPDF/issues) page, and follow the issue template for quick response.
## Requirements
@@ -128,15 +129,9 @@ OCRmyPDF would not be the software that it is today without companies and users
## 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.
+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).
+Some components of OCRmyPDF have other licenses, as indicated by standard SPDX license identifiers or the DEP5 copyright and licensing information file. Generally speaking, non-core code is licensed under MIT, and the documentation and test files are licensed under Creative Commons ShareAlike 4.0 (CC-BY-SA 4.0).
## Disclaimer
diff --git a/docs/advanced.rst b/docs/advanced.rst
index 22456811..bf1a063d 100644
--- a/docs/advanced.rst
+++ b/docs/advanced.rst
@@ -1,3 +1,6 @@
+.. SPDX-FileCopyrightText: 2022 James R. Barlow
+.. SPDX-License-Identifier: CC-BY-SA-4.0
+
=================
Advanced features
=================
@@ -67,11 +70,11 @@ 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 ``--skip-text`` is issued, then no image processing or 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)
@@ -223,7 +226,9 @@ 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.
+preprocessing is specified, then the image layer is a new PDF. (You may
+need to disable PDF/A conversion nad optimization to eliminate all
+lossy transformations.)
Unlike ``sandwich`` this renderer is implemented within OCRmyPDF; anyone
looking to customize how OCR is presented should look here. A major
diff --git a/docs/api.rst b/docs/api.rst
index a6339f38..0478dd1c 100644
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -1,3 +1,7 @@
+.. SPDX-FileCopyrightText: 2022 James R. Barlow
+..
+.. SPDX-License-Identifier: CC-BY-SA-4.0
+
======================
Using the OCRmyPDF API
======================
diff --git a/docs/apiref.rst b/docs/apiref.rst
index 5a3bd488..766c9886 100644
--- a/docs/apiref.rst
+++ b/docs/apiref.rst
@@ -1,3 +1,7 @@
+.. SPDX-FileCopyrightText: 2022 James R. Barlow
+..
+.. SPDX-License-Identifier: CC-BY-SA-4.0
+
=============
API Reference
=============
diff --git a/docs/batch.rst b/docs/batch.rst
index e66388df..8adf24cf 100644
--- a/docs/batch.rst
+++ b/docs/batch.rst
@@ -1,3 +1,7 @@
+.. SPDX-FileCopyrightText: 2022 James R. Barlow
+..
+.. SPDX-License-Identifier: CC-BY-SA-4.0
+
================
Batch processing
================
@@ -36,18 +40,21 @@ 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
+place, and printing each filename in between runs:
.. code-block:: bash
- find . -printf '%p' -name '*.pdf' -exec ocrmypdf '{}' '{}' \;
+ find . -printf '%p\n' -name '*.pdf' -exec ocrmypdf '{}' '{}' \;
-Alternatively, with a docker container (mounts a volume to the container
-where the PDFs are stored):
+Alternatively, with a Docker container and streaming the file through
+standard input and output:
.. code-block:: bash
- find . -printf '%p' -name '*.pdf' -exec docker run --rm -v <host dir>:<container dir> jbarlow83/ocrmypdf '<container dir>/{}' '<container dir>/{}' \;
+ find . -name '*.pdf' -print0 | xargs -0 | while read pdf; do
+ pdfout=$(mktemp)
+ docker run --rm -i jbarlow83/ocrmypdf - - <$pdf >$pdfout && cp $pdfout $pdf
+ done
This only runs one ``ocrmypdf`` process at a time. This variation uses
``find`` to create a directory list and ``parallel`` to parallelize runs
@@ -124,7 +131,9 @@ Users may need to customize the script to meet their requirements.
"OCR_INPUT_DIRECTORY", "Set input directory to monitor (recursive)"
"OCR_OUTPUT_DIRECTORY", "Set output directory (should not be under input)"
+ "OCR_ARCHIVE_DIRECTORY", "Set archive directory for processed originals (should not be under input, requires ``OCR_ON_SUCCESS_ARCHIVE`` to be set)"
"OCR_ON_SUCCESS_DELETE", "This will delete the input file if the exit code is 0 (OK)"
+ "OCR_ON_SUCCESS_ARCHIVE", "This will move the processed orignal file to ``OCR_ARCHIVE_DIRECTORY`` if the exit code is 0 (OK). Note that ``OCR_ON_SUCCESS_DELETE`` takes precedence over this option, i.e. if both options are set, the input file will be deleted."
"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}'``."
@@ -144,16 +153,18 @@ The watcher service is included in the OCRmyPDF Docker image. To run it:
docker run \
-v <path to files to convert>:/input \
-v <path to store results>:/output \
+ -v <path to store processed originals>:/archive \
-e OCR_OUTPUT_DIRECTORY_YEAR_MONTH=1 \
- -e OCR_ON_SUCCESS_DELETE=1 \
+ -e OCR_ON_SUCCESS_ARCHIVE=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:
+This service will watch for a file that matches ``/input/\*.pdf``,
+convert it to a OCRed PDF in ``/output/``, and move the processed
+original to ``/archive``. The parameters to this image are:
.. csv-table:: watcher.py parameters for Docker
:header: "Parameter", "Description"
@@ -161,10 +172,11 @@ convert it to a OCRed PDF in ``/output/``. The parameters to this image are:
"``-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"
+ "``-v <path to store processed originals>:/archive``", "Archive processed originals here"
+ "``-e OCR_OUTPUT_DIRECTORY_YEAR_MONTH=1``", "Define environment variable ``OCR_OUTPUT_DIRECTORY_YEAR_MONTH=1`` to place files in the output in ``{output}/{year}/{month}/{filename}``"
+ "``-e OCR_ON_SUCCESS_ARCHIVE=1``", "Define environment variable ``OCR_ON_SUCCESS_ARCHIVE`` to move processed originals"
+ "``-e OCR_DESKEW=1``", "Define environment variable ``OCR_DESKEW`` to apply deskew to crooked input PDFs"
+ "``-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
diff --git a/docs/conf.py b/docs/conf.py
index b84ca036..8f42a0b2 100755
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -1,5 +1,7 @@
#!/usr/bin/env python3
-#
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: CC-BY-SA-4.0
+
# ocrmypdf documentation build configuration file, created by
# sphinx-quickstart on Sun Sep 4 14:29:43 2016.
#
@@ -42,7 +44,7 @@ extensions = [
# Extension settings
intersphinx_mapping = {'https://docs.python.org/': None}
napoleon_use_rtype = False
-issues_github_path = "jbarlow83/OCRmyPDF"
+issues_github_path = "ocrmypdf/OCRmyPDF"
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@@ -63,7 +65,7 @@ master_doc = 'index'
# General information about the project.
project = 'ocrmypdf'
copyright = (
- '2021, James R. Barlow. Licensed under Creative Commons Attribution-ShareAlike 4.0.'
+ '2022, James R. Barlow. Licensed under Creative Commons Attribution-ShareAlike 4.0.'
)
author = 'James R. Barlow'
diff --git a/docs/contributing.rst b/docs/contributing.rst
index c7e38904..92c5abb9 100644
--- a/docs/contributing.rst
+++ b/docs/contributing.rst
@@ -1,3 +1,7 @@
+.. SPDX-FileCopyrightText: 2022 James R. Barlow
+..
+.. SPDX-License-Identifier: CC-BY-SA-4.0
+
=======================
Contributing guidelines
=======================
diff --git a/docs/cookbook.rst b/docs/cookbook.rst
index cc5f3cae..1360d17e 100644
--- a/docs/cookbook.rst
+++ b/docs/cookbook.rst
@@ -1,3 +1,7 @@
+.. SPDX-FileCopyrightText: 2022 James R. Barlow
+..
+.. SPDX-License-Identifier: CC-BY-SA-4.0
+
========
Cookbook
========
@@ -200,7 +204,7 @@ might remove desirable content, especially from poor quality scans.
.. warning::
- ``--clean-final`` and ``-remove-background`` may leave undesirable
+ ``--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.
@@ -243,10 +247,11 @@ You can also optimize all images without performing any OCR:
ocrmypdf --tesseract-timeout=0 --optimize 3 --skip-text input.pdf output.pdf
-Perform OCR only certain pages
-------------------------------
+Process only certain pages
+--------------------------
-You can ask OCRmyPDF to only apply OCR to certain pages.
+You can ask OCRmyPDF to only apply `image processing <#image-processing>`__
+and OCR to certain pages.
.. code-block:: bash
@@ -260,10 +265,10 @@ 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:
+Regardless of the argument to ``--pages``, OCRmyPDF will optimize all pages/images
+in the file and convert it to PDF/A, unless you disable those options. Both of these
+steps are "whole file" operations. In this example, we want to OCR only the title
+and otherwise change the PDF as little as possible:
.. code-block:: bash
@@ -339,6 +344,9 @@ levels in the GCC compiler.
- 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.
+ (If ``--jbig2-lossy`` is issued, then lossy JBIG2 optimization is used.
+ The decision to use lossy JBIG2 is separate from standard optimization
+ settings.)
* - ``--optimize 2``
- All of the above, and enables lossy optimizations and color quantization.
* - ``--optimize 3``
@@ -359,3 +367,8 @@ fo a PDF.
ocrmypdf --optimize 3 in.pdf out.pdf # Make it small
Some users may consider enabling lossy JBIG2. See: :ref:`jbig2-lossy`.
+
+.. note::
+
+ Image processing and PDF/A conversion can also introduce lossy transformations
+ to your PDF images, even when ``--optimize 1`` is in use.
diff --git a/docs/docker.rst b/docs/docker.rst
index 5b98f3e1..e6721681 100644
--- a/docs/docker.rst
+++ b/docs/docker.rst
@@ -1,3 +1,7 @@
+.. SPDX-FileCopyrightText: 2022 James R. Barlow
+..
+.. SPDX-License-Identifier: CC-BY-SA-4.0
+
.. _docker:
=====================
diff --git a/docs/errors.rst b/docs/errors.rst
index bf0b53d0..d6017f10 100644
--- a/docs/errors.rst
+++ b/docs/errors.rst
@@ -1,3 +1,7 @@
+.. SPDX-FileCopyrightText: 2022 James R. Barlow
+..
+.. SPDX-License-Identifier: CC-BY-SA-4.0
+
=====================
Common error messages
=====================
diff --git a/docs/index.rst b/docs/index.rst
index 03b7017a..ce8869a7 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,3 +1,7 @@
+.. SPDX-FileCopyrightText: 2022 James R. Barlow
+..
+.. SPDX-License-Identifier: CC-BY-SA-4.0
+
OCRmyPDF documentation
======================
diff --git a/docs/installation.rst b/docs/installation.rst
index 00fb675e..79bfb7c4 100644
--- a/docs/installation.rst
+++ b/docs/installation.rst
@@ -1,3 +1,7 @@
+.. SPDX-FileCopyrightText: 2022 James R. Barlow
+..
+.. SPDX-License-Identifier: CC-BY-SA-4.0
+
===================
Installing OCRmyPDF
===================
@@ -12,21 +16,23 @@ 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`` |
-+-------------------------------+-------------------------------+
++-------------------------------+-----------------------------------------+
+| 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 textproc/py-ocrmypdf`` |
++-------------------------------+-----------------------------------------+
+| Conda (WSL, macOS, Linux) | ``conda install ocrmypdf`` |
++-------------------------------+-----------------------------------------+
+| Snap (snapcraft packaging) | ``snap 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.
@@ -41,11 +47,11 @@ 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-11| image:: https://repology.org/badge/version-for-repo/debian_11/ocrmypdf.svg
+ :alt: Debian 11
-.. |deb-testing| image:: https://repology.org/badge/version-for-repo/debian_testing/ocrmypdf.svg
- :alt: Debian 10 testing ("buster")
+.. |deb-12| image:: https://repology.org/badge/version-for-repo/debian_12/ocrmypdf.svg
+ :alt: Debian 12
.. |deb-unstable| image:: https://repology.org/badge/version-for-repo/debian_unstable/ocrmypdf.svg
:alt: Debian unstable
@@ -56,17 +62,17 @@ Debian and Ubuntu 18.04 or newer
.. |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
+.. |ubu-2204| image:: https://repology.org/badge/version-for-repo/ubuntu_22_04/ocrmypdf.svg
+ :alt: Ubuntu 22.04 LTS
+-----------------------------------------------+
| **OCRmyPDF versions in Debian & Ubuntu** |
+-----------------------------------------------+
| |latest| |
+-----------------------------------------------+
-| |deb-stable| |deb-testing| |deb-unstable| |
+| |deb-11| |deb-12| |deb-unstable| |
+-----------------------------------------------+
-| |ubu-1804| |ubu-2004| |ubu-2110| |
+| |ubu-1804| |ubu-2004| |ubu-2204| |
+-----------------------------------------------+
Users of Debian 9 ("stretch") or later, or Ubuntu 18.04 or later, including users
@@ -80,8 +86,7 @@ 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.
+sources <#installing-head-revision-from-sources>`__.
For full details on version availability for your platform, check the
`Debian Package Tracker <https://tracker.debian.org/pkg/ocrmypdf>`__ or
@@ -91,19 +96,19 @@ For full details on version availability for your platform, check the
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
+ If you build jbig2enc from source, ocrmypdf 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-36| image:: https://repology.org/badge/version-for-repo/fedora_36/ocrmypdf.svg
+ :alt: Fedora 36
+
.. |fedora-rawhide| image:: https://repology.org/badge/version-for-repo/fedora_rawhide/ocrmypdf.svg
:alt: Fedore Rawhide
@@ -112,7 +117,7 @@ Fedora
+-----------------------------------------------+
| |latest| |
+-----------------------------------------------+
-| |fedora-34| |fedora-35| |fedora-rawhide| |
+| |fedora-35| |fedora-36| |fedora-rawhide| |
+-----------------------------------------------+
Users of Fedora 29 or later may simply
@@ -138,9 +143,29 @@ from sources <#installing-head-revision-from-sources>`__.
.. _ubuntu-lts-latest:
-Installing the latest version on Ubuntu 20.04 LTS
+Installing the latest version on Ubuntu 22.04 LTS
-------------------------------------------------
+Ubuntu 22.04 includes ocrmypdf 13.4.0 - you can install that with
+``apt install ocrmypdf``. To install a more recent version for the current
+user, follow these steps:
+
+.. code-block:: bash
+
+ sudo apt-get update
+ sudo apt-get -y install ocrmypdf python3-pip
+
+ pip install --user --upgrade ocrmypdf
+
+If you get the message ``WARNING: The script ocrmypdf is installed in
+'/home/$USER/.local/bin' which is not on PATH.``, you may need to re-login
+or open a new shell, or manually add this to your user's PATH.
+
+To add JBIG2 encoding, see :ref:`jbig2`.
+
+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:
@@ -171,6 +196,8 @@ To install for the current user only:
export PATH=$HOME/.local/bin:$PATH
pip3 install --user ocrmypdf
+To add JBIG2 encoding, see :ref:`jbig2`.
+
Ubuntu 18.04 LTS
----------------
@@ -291,46 +318,6 @@ To install OCRmyPDF for Alpine Linux:
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
--------------------
@@ -365,19 +352,6 @@ languages you can optionally install them all:
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
----------------------------
@@ -411,19 +385,19 @@ Update the homebrew pip:
.. code-block:: bash
- pip3 install --upgrade pip
+ pip install --upgrade pip
You can then install OCRmyPDF from PyPI, for the current user:
.. code-block:: bash
- pip3 install --user ocrmypdf
+ pip install --user ocrmypdf
or system-wide:
.. code-block:: bash
- pip3 install ocrmypdf
+ pip install ocrmypdf
The command line program should now be available:
@@ -485,8 +459,8 @@ to change the PATH.
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>`.
+#. Install Ubuntu 22.04 for Windows Subsystem for Linux, if not already installed.
+#. Follow the procedure to install :ref:`OCRmyPDF on Ubuntu 22.04 <ubuntu-lts-latest>`.
#. Open the Windows command prompt and create a symlink:
.. code-block:: powershell
@@ -558,16 +532,13 @@ 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
+.. image:: https://repology.org/badge/version-for-repo/freebsd/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.
+ :target: https://repology.org/project/ocrmypdf/versions
.. code-block:: bash
- pkg install py38-ocrmypdf
+ pkg install textproc/py-ocrmypdf
To install a more recent version, you could attempt to first install the system
version with ``pkg``, then use ``pip install --user ocrmypdf``.
@@ -616,18 +587,18 @@ try:
.. code-block:: bash
- pip3 install --user ocrmypdf
+ pip 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,
+Since ``pip 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
+ pip install ocrmypdf
.. note::
@@ -643,13 +614,9 @@ 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:
+The following versions are required:
-- Python 3.9 or newer
+- Python 3.7 or newer
- Ghostscript 9.23 or newer
- Tesseract 4.0.0 or newer
- jbig2enc 0.29 or newer
@@ -696,7 +663,7 @@ environment:
.. code-block:: bash
- pip3 install git+https://github.com/jbarlow83/OCRmyPDF.git
+ pip install git+https://github.com/ocrmypdf/OCRmyPDF.git
Or, to install in `development
mode <https://pythonhosted.org/setuptools/setuptools.html#development-mode>`__,
@@ -704,18 +671,18 @@ allowing customization of OCRmyPDF, use the ``-e`` flag:
.. code-block:: bash
- pip3 install -e git+https://github.com/jbarlow83/OCRmyPDF.git
+ pip install -e git+https://github.com/ocrmypdf/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
+ git clone -b master https://github.com/ocrmypdf/OCRmyPDF.git
python3 -m venv
source venv/bin/activate
cd OCRmyPDF
- pip3 install .
+ pip install .
However, ``ocrmypdf`` will only be accessible on the system PATH when
you activate the virtual environment.
@@ -738,8 +705,8 @@ 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
+ git clone -b master https://github.com/ocrmypdf/OCRmyPDF.git
+ python -m venv
source venv/bin/activate
cd OCRmyPDF
pip install -e .[test]
diff --git a/docs/introduction.rst b/docs/introduction.rst
index 929a4242..7c11818b 100644
--- a/docs/introduction.rst
+++ b/docs/introduction.rst
@@ -1,3 +1,7 @@
+.. SPDX-FileCopyrightText: 2022 James R. Barlow
+..
+.. SPDX-License-Identifier: CC-BY-SA-4.0
+
============
Introduction
============
diff --git a/docs/jbig2.rst b/docs/jbig2.rst
index 2e7b7746..b435d794 100644
--- a/docs/jbig2.rst
+++ b/docs/jbig2.rst
@@ -1,3 +1,7 @@
+.. SPDX-FileCopyrightText: 2022 James R. Barlow
+..
+.. SPDX-License-Identifier: CC-BY-SA-4.0
+
.. _jbig2:
============================
@@ -32,7 +36,7 @@ For all other Linux, you must build a JBIG2 encoder from source:
.. _jbig2-lossy:
-Dependencies include libtoolize and libleptonica, which on Ubuntu systems
+Dependencies include libtoolize and libleptonica, which on Ubuntu systems
are packaged as libtool and libleptonica-dev.
Lossy mode JBIG2
diff --git a/docs/languages.rst b/docs/languages.rst
index 95dad96a..41db74bd 100644
--- a/docs/languages.rst
+++ b/docs/languages.rst
@@ -1,3 +1,7 @@
+.. SPDX-FileCopyrightText: 2022 James R. Barlow
+..
+.. SPDX-License-Identifier: CC-BY-SA-4.0
+
.. _lang-packs:
====================================
diff --git a/docs/maintainers.rst b/docs/maintainers.rst
index 5f483072..1c597e86 100644
--- a/docs/maintainers.rst
+++ b/docs/maintainers.rst
@@ -1,8 +1,12 @@
+.. SPDX-FileCopyrightText: 2022 James R. Barlow
+..
+.. SPDX-License-Identifier: CC-BY-SA-4.0
+
================
Maintainer notes
================
-This is for those who package OCRmyPDF for downstream use. (Thank you
+This is for those who package OCRmyPDF for downstream use. (Thank you
for your hard work.)
Known ports/packagers
@@ -25,7 +29,7 @@ Non-Python dependencies
Note that we have non-Python dependencies. In particular, OCRmyPDF requires
Ghostscript and Tesseract OCR to be installed and needs to be able to locate their
-binaries on the system PATH. On Windows, OCRmyPDF will also check the registry
+binaries on the system PATH. On Windows, OCRmyPDF will also check the registry
for their locations.
Tesseract OCR relies on SIMD for performance and only has proper support for this
@@ -38,13 +42,13 @@ OCRmyPDF uses setuptools-scm for versioning, which derives the version from
Git as a single source of truth. This may be unsuitable for some distributions, e.g.
to indicate that your distribution modifies OCRmyPDF in some way.
-You can patch the ``__version__`` variable in ``src/ocrmypdf/_version.py`` if
+You can patch the ``__version__`` variable in ``src/ocrmypdf/_version.py`` if
necessary.
OCRmyPDF uses setuptools-scm-git-archive to ensure that tarballs downloaded from
GitHub contain version information. Unfortunately, these tarballs are not always
-deterministic. See this
-`issue <https://github.com/jbarlow83/OCRmyPDF/issues/841#issuecomment-936562696>`_.
+deterministic. See this
+`issue <https://github.com/ocrmypdf/OCRmyPDF/issues/841#issuecomment-936562696>`_.
jbig2enc
--------
diff --git a/docs/optimizer.rst b/docs/optimizer.rst
index 02f0be21..4d3f8bbb 100644
--- a/docs/optimizer.rst
+++ b/docs/optimizer.rst
@@ -1,3 +1,7 @@
+.. SPDX-FileCopyrightText: 2022 James R. Barlow
+..
+.. SPDX-License-Identifier: CC-BY-SA-4.0
+
================
PDF optimization
================
diff --git a/docs/pdfsecurity.rst b/docs/pdfsecurity.rst
index a11c84c3..db2f3410 100644
--- a/docs/pdfsecurity.rst
+++ b/docs/pdfsecurity.rst
@@ -1,3 +1,7 @@
+.. SPDX-FileCopyrightText: 2022 James R. Barlow
+..
+.. SPDX-License-Identifier: CC-BY-SA-4.0
+
===================
PDF security issues
===================
diff --git a/docs/performance.rst b/docs/performance.rst
index 82625fc0..0465415a 100644
--- a/docs/performance.rst
+++ b/docs/performance.rst
@@ -1,3 +1,7 @@
+.. SPDX-FileCopyrightText: 2022 James R. Barlow
+..
+.. SPDX-License-Identifier: CC-BY-SA-4.0
+
===========
Performance
===========
diff --git a/docs/plugins.rst b/docs/plugins.rst
index 1d8f3f70..def6e444 100644
--- a/docs/plugins.rst
+++ b/docs/plugins.rst
@@ -1,3 +1,7 @@
+.. SPDX-FileCopyrightText: 2022 James R. Barlow
+..
+.. SPDX-License-Identifier: CC-BY-SA-4.0
+
=======
Plugins
=======
@@ -162,6 +166,11 @@ Examples
management system.
+Suppressing or overriding other plugins
+---------------------------------------
+
+.. autofunction:: ocrmypdf.pluginspec.initialize
+
Custom command line arguments
-----------------------------
@@ -172,7 +181,7 @@ Custom command line arguments
Execution and progress reporting
--------------------------------
-.. autoclass: ocrmypdf.pluginspec.Executor
+.. autoclass:: ocrmypdf.pluginspec.Executor
:members:
.. autofunction:: ocrmypdf.pluginspec.get_logging_console
@@ -216,3 +225,10 @@ PDF/A production
----------------
.. autofunction:: ocrmypdf.pluginspec.generate_pdfa
+
+PDF optimization
+----------------
+
+.. autofunction:: ocrmypdf.pluginspec.optimize_pdf
+
+.. autofunction:: ocrmypdf.pluginspec.is_optimization_enabled \ No newline at end of file
diff --git a/docs/release_notes.rst b/docs/release_notes.rst
index 458d5ace..51b49f79 100644
--- a/docs/release_notes.rst
+++ b/docs/release_notes.rst
@@ -1,3 +1,7 @@
+.. SPDX-FileCopyrightText: 2022 James R. Barlow
+..
+.. SPDX-License-Identifier: CC-BY-SA-4.0
+
=============
Release notes
=============
@@ -16,8 +20,81 @@ The most recent release of OCRmyPDF is |OCRmyPDF PyPI|. Any newer versions
referred to in these notes may exist the main branch but have not been
tagged yet.
+.. note::
+
+ Attention maintainers: these release notes may be updated with information
+ about a forthcoming release that has not been tagged yet. A release is only
+ official when it's tagged and posted to PyPI.
+
.. |OCRmyPDF PyPI| image:: https://img.shields.io/pypi/v/ocrmypdf.svg
+v13.7.0
+=======
+
+- Fixed an exception when attempting to run and Tesseract is not installed.
+- Changed to SPDX license tracking and information files.
+
+v13.6.2
+=======
+
+- Added a shim to prevent an "error during error handling" for Python 3.7 and 3.8.
+- Modernized some type annotations.
+- Improved annotations on our _windows module to help IDEs and mypy figure out what
+ we're doing.
+
+v13.6.1
+=======
+
+- Require setuptools-scm 7.0.5 to avoid possible issues with source distributions in
+ earlier versions of setuptools-scm.
+- Suppress a spurious warning, improve tests, improve typing and other miscellany.
+
+v13.6.0
+=======
+
+- Added a new ``initialize`` plugin hook, making it possible to suppress built-in
+ plugins more easily, among other possibilities.
+- Fixed an issue where unpaper would exit with a "wrong stream" error, probably
+ related to images with an odd integer width. :issue:`887, 665`
+
+v13.5.0
+=======
+
+- Added a new ``optimize_pdf`` plugin hook, making it possible to create plugins that
+ replace or enhance OCRmyPDF's PDF optimizer.
+- Removed all max version restrictions. Our new policy is to blacklist known-bad releases
+ and only block known-bad versions of dependencies.
+- The naming schema for object that holds all OCR text that OCRmyPDF inserts has
+ changed. This has always been an implementation detail (and remains so), but possibly,
+ someone was relying on it and would appreciate the heads-up.
+- Cleanup.
+
+v13.4.7
+=======
+
+- Fixed PermissionError when cleaning up temporary files in rare cases. :issue:`974`
+- Fixed PermissionError when calling ``os.nice`` on platforms that lack it. :issue:`973`
+- Suppressed some warnings from libxmp during tests.
+
+v13.4.6
+=======
+
+- Convert error on corrupt ICC profiles into a warning. Thanks to @oscherler.
+
+v13.4.5
+=======
+
+- Remove upper bound on pdfminer.six version.
+- Documentation.
+
+v13.4.4
+=======
+
+- Updated pdfminer.six version.
+- Docker image changed to Ubuntu 22.04 now that it is released and provides the
+ dependencies we need. This seems more consistent than our recent change to
+ Debian.
+
v13.4.3
=======
diff --git a/misc/batch.py b/misc/batch.py
index 23b9701b..d8a04dd0 100644
--- a/misc/batch.py
+++ b/misc/batch.py
@@ -1,26 +1,10 @@
#!/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.
+# SPDX-FileCopyrightText: 2016 findingorder <https://github.com/findingorder>
+# SPDX-License-Identifier: MIT
-# This script must be edited to meet your needs.
+from __future__ import annotations
+# This script must be edited to meet your needs.
import logging
import os
import sys
diff --git a/misc/completion/ocrmypdf.bash b/misc/completion/ocrmypdf.bash
index af27b698..fa857054 100644
--- a/misc/completion/ocrmypdf.bash
+++ b/misc/completion/ocrmypdf.bash
@@ -1,25 +1,6 @@
-# ocrmypdf completion -*- shell-script -*-
-
-# Copyright 2019, 2021 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.
+# SPDX-FileCopyrightText: 2021 Frank Pille
+# SPDX-FileCopyrightText: 2020 Alex Willner
+# SPDX-License-Identifier: MIT
set -o errexit
diff --git a/misc/completion/ocrmypdf.fish b/misc/completion/ocrmypdf.fish
index 646e7db8..97bf7f7b 100644
--- a/misc/completion/ocrmypdf.fish
+++ b/misc/completion/ocrmypdf.fish
@@ -1,25 +1,8 @@
-# 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
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MIT
+
+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
@@ -43,7 +26,7 @@ function __fish_ocrmypdf_languages
echo $lang
end
end
-complete -c ocrmypdf -x -s l -l language -a '(__fish_ocrmypdf_languages)' -d "language"
+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"
diff --git a/misc/example_plugin.py b/misc/example_plugin.py
index cabb4ebe..b8f44fb8 100644
--- a/misc/example_plugin.py
+++ b/misc/example_plugin.py
@@ -1,22 +1,5 @@
-# © 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.
+# SPDX-FileCopyrightText: 2022 James R Barlow: https://github.com/jbarlow83
+# SPDX-License-Identifier: MIT
"""
An example of an OCRmyPDF plugin.
@@ -37,6 +20,8 @@ To use this as an API:
)
"""
+from __future__ import annotations
+
import logging
from PIL import Image
diff --git a/misc/synology.py b/misc/synology.py
index 7e243229..d9547559 100644
--- a/misc/synology.py
+++ b/misc/synology.py
@@ -1,26 +1,10 @@
#!/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.
+# SPDX-FileCopyrightText: 2017 Enantiomerie
+# SPDX-License-Identifier: MIT
-# This script must be edited to meet your needs.
+from __future__ import annotations
+# This script must be edited to meet your needs.
import logging
import os
import shutil
diff --git a/misc/watcher.py b/misc/watcher.py
index 193b485a..a9e27fb2 100644
--- a/misc/watcher.py
+++ b/misc/watcher.py
@@ -1,28 +1,14 @@
#!/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.
+# SPDX-FileCopyrightText: 2019 Ian Alexander <https://github.com/ianalexander>
+# SPDX-FileCopyrightText: 2020 James R Barlow <https://github.com/jbarlow83>
+# SPDX-License-Identifier: MIT
+
+from __future__ import annotations
import json
import logging
import os
+import shutil
import sys
import time
from datetime import datetime
@@ -44,8 +30,10 @@ def getenv_bool(name: str, default: str = 'False'):
INPUT_DIRECTORY = os.getenv('OCR_INPUT_DIRECTORY', '/input')
OUTPUT_DIRECTORY = os.getenv('OCR_OUTPUT_DIRECTORY', '/output')
+ARCHIVE_DIRECTORY = os.getenv('OCR_ARCHIVE_DIRECTORY', '/processed')
OUTPUT_DIRECTORY_YEAR_MONTH = getenv_bool('OCR_OUTPUT_DIRECTORY_YEAR_MONTH')
ON_SUCCESS_DELETE = getenv_bool('OCR_ON_SUCCESS_DELETE')
+ON_SUCCESS_ARCHIVE = getenv_bool('OCR_ON_SUCCESS_ARCHIVE')
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'))
@@ -108,9 +96,13 @@ def execute_ocrmypdf(file_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()
+ if exit_code == 0:
+ if ON_SUCCESS_DELETE:
+ log.info(f'OCR is done. Deleting: {file_path}')
+ file_path.unlink()
+ elif ON_SUCCESS_ARCHIVE:
+ log.info(f'OCR is done. Archiving {file_path.name} to {ARCHIVE_DIRECTORY}')
+ shutil.move(file_path, f'{ARCHIVE_DIRECTORY}/{file_path.name}')
else:
log.info('OCR is done')
@@ -135,13 +127,16 @@ def main():
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}"
+ f"Output Directory Year & Month: {OUTPUT_DIRECTORY_YEAR_MONTH}\n"
+ f"Archive Directory: {ARCHIVE_DIRECTORY}"
)
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"ARCHIVE_DIRECTORY: {ARCHIVE_DIRECTORY}\n"
f"ON_SUCCESS_DELETE: {ON_SUCCESS_DELETE}\n"
+ f"ON_SUCCESS_ARCHIVE: {ON_SUCCESS_ARCHIVE}\n"
f"DESKEW: {DESKEW}\n"
f"ARGS: {OCR_JSON_SETTINGS}\n"
f"POLL_NEW_FILE_SECONDS: {POLL_NEW_FILE_SECONDS}\n"
diff --git a/misc/webservice.py b/misc/webservice.py
index 0e2079e8..f21bd15b 100644
--- a/misc/webservice.py
+++ b/misc/webservice.py
@@ -1,19 +1,6 @@
#!/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/>.
+# SPDX-FileCopyrightText: 2019 James R. Barlow
+# SPDX-License-Identifier: AGPL-3.0-or-later
"""This is a simple web service/HTTP wrapper for OCRmyPDF
@@ -24,6 +11,8 @@ to emphasize that SaaS deployments should make sure they comply with
Ghostscript's license as well as OCRmyPDF's.
"""
+from __future__ import annotations
+
import os
import shlex
from subprocess import PIPE, run
diff --git a/pyproject.toml b/pyproject.toml
index d7276956..29a84b24 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -1,14 +1,12 @@
[build-system]
requires = [
- "setuptools >= 30.3.0",
- "wheel",
- "setuptools_scm[toml] >= 3.4",
- "setuptools_scm_git_archive"
+ "setuptools >= 52",
+ "setuptools_scm[toml] >= 7.0.5",
+ "wheel"
]
build-backend = "setuptools.build_meta"
[tool.setuptools_scm]
-version_scheme = "post-release"
[tool.black]
line-length = 88
@@ -95,6 +93,12 @@ module = [
'pdfminer.*',
'reportlab.*',
'fitz',
- 'libxmp.utils'
+ 'libxmp.utils',
+ 'importlib_metadata'
]
ignore_missing_imports = true
+
+[tool.pylint.basic]
+good-names = ["i", "j", "k", "ex", "Run", "_", "e", "p", "im", "w", "h", "m", "x", "y", "a", "b", "fp", "n", "f", "s", "v", "q", "dx", "dy"]
+logging-format-style = "old"
+disable = ["raw-checker-failed", "bad-inline-option", "locally-disabled", "file-ignored", "suppressed-message", "useless-suppression", "deprecated-pragma", "use-symbolic-message-instead", "logging-fstring-interpolation", "missing-function-docstring", "too-few-public-methods"]
diff --git a/setup.cfg b/setup.cfg
index ed06abdc..3dc89171 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -3,7 +3,7 @@ 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
+url = https://github.com/ocrmypdf/OCRmyPDF
author = James R. Barlow
author_email = james@purplerock.ca
license = MPL-2.0
@@ -39,23 +39,24 @@ keywords =
scanning
project_urls =
Documentation = https://ocrmypdf.readthedocs.io/
- Source = https://github.com/jbarlow83/ocrmypdf
- Tracker = https://github.com/jbarlow83/ocrmypdf/issues
+ Source = https://github.com/ocrmypdf/OCRmyPDF
+ Tracker = https://github.com/ocrmypdf/OCRmyPDF/issues
[options]
packages = find:
install_requires =
Pillow>=8.2.0
coloredlogs>=14.0 # strictly optional
- img2pdf>=0.3.0,<0.5 # pure Python
+ img2pdf>=0.3.0 # pure Python
packaging>=20
- pdfminer.six!=20200720,>=20191110,<=20220319
+ pdfminer.six!=20200720,>=20191110
pikepdf!=5.0.0,>=4.0.0
- pluggy>=0.13.0,<2
+ pluggy>=0.13.0
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
+ typing-extensions>=4;python_version<'3.10'
python_requires = >=3.7
include_package_data = True
package_dir =
@@ -86,10 +87,12 @@ test =
pytest-cov>=2.11.1
pytest-xdist>=2.2.0
python-xmp-toolkit==2.0.1 # also requires apt-get install libexempi3
+ types-Pillow
+ types-humanfriendly
watcher =
- watchdog>=1.0.2,<3
+ watchdog>=1.0.2
webservice =
- Flask>=1,<3
+ Flask>=1
[options.package_data]
ocrmypdf =
diff --git a/setup.py b/setup.py
index 63d7c3b8..afa8ba3f 100644
--- a/setup.py
+++ b/setup.py
@@ -1,16 +1,10 @@
-# © 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/.
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
+"""setup.py to support older setuptools and pip."""
+
+from __future__ import annotations
from setuptools import setup
-# Minimal setup to support older setuptools/setuptools_scm
-setup(
- setup_requires=[ # can be removed whenever we can drop pip 9 support
- 'setuptools_scm', # so that version will work
- ],
- use_scm_version={'version_scheme': 'post-release'},
-)
+setup()
diff --git a/snapcraft.yaml b/snapcraft.yaml
new file mode 100644
index 00000000..09b1971a
--- /dev/null
+++ b/snapcraft.yaml
@@ -0,0 +1,72 @@
+name: ocrmypdf
+title: OCRmyPDF
+base: core20
+version: git
+summary: OCRmyPDF adds optical character recognition (OCR) to PDFs
+description: OCRmyPDF packaged for snap
+grade: stable
+confinement: strict
+icon: docs/images/logo-square-256.svg
+license: MPL-2.0
+
+architectures: [amd64]
+
+environment:
+ TESSDATA_PREFIX: $SNAP/usr/share/tesseract-ocr/4.00/tessdata
+ GS_LIB: $SNAP/usr/share/ghostscript/9.50/Resource/Init
+ GS_FONTPATH: $SNAP/usr/share/ghostscript/9.50/Resource/Font
+ LD_LIBRARY_PATH: $SNAP/usr/lib/x86_64-linux-gnu
+
+apps:
+ ocrmypdf:
+ command: usr/bin/snapcraft-preload python3 -m ocrmypdf
+ plugs:
+ - desktop
+ - desktop-legacy
+ - wayland
+ - x11
+ - home
+ - removable-media
+
+parts:
+ snapcraft-preload:
+ source: https://github.com/sergiusens/snapcraft-preload.git
+ plugin: cmake
+ cmake-parameters:
+ - -DCMAKE_INSTALL_PREFIX=/usr -DLIBPATH=/usr/lib
+ build-packages:
+ - on amd64:
+ - gcc-multilib
+ - g++-multilib
+ stage-packages:
+ - lib32stdc++6
+
+ ocrmypdf:
+ plugin: python
+ source: https://github.com/ocrmypdf/OCRmyPDF.git
+
+ stage-packages:
+ - ghostscript
+ - icc-profiles-free
+ - liblept5
+ - libxml2
+ - pngquant
+ - tesseract-ocr-all
+ - unpaper
+ - qpdf
+ - zlib1g
+
+ python-packages:
+ - cffi
+ - pdfminer.six
+ - pikepdf
+ - Pillow
+ - pluggy
+ - reportlab
+ - setuptools
+ - tqdm
+ - pipe
+
+ override-build: |
+ snapcraftctl build
+ ln -sf ../usr/lib/libsnapcraft-preload.so $SNAPCRAFT_PART_INSTALL/lib/libsnapcraft-preload.so
diff --git a/src/ocrmypdf/__init__.py b/src/ocrmypdf/__init__.py
index 5e566389..7f4a4cd2 100644
--- a/src/ocrmypdf/__init__.py
+++ b/src/ocrmypdf/__init__.py
@@ -1,9 +1,9 @@
-# © 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/.
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
+"""Adds OCR layer to PDFs."""
+
+from __future__ import annotations
from pluggy import HookimplMarker as _HookimplMarker
diff --git a/src/ocrmypdf/__main__.py b/src/ocrmypdf/__main__.py
index c9267bf2..24d620c8 100755
--- a/src/ocrmypdf/__main__.py
+++ b/src/ocrmypdf/__main__.py
@@ -1,15 +1,16 @@
#!/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/.
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
+"""ocrmypdf command line entrypoint."""
+
+from __future__ import annotations
import logging
import os
import signal
import sys
+from contextlib import suppress
from multiprocessing import set_start_method
from ocrmypdf import __version__
@@ -34,7 +35,7 @@ def sigbus(*args):
def run(args=None):
_parser, options, plugin_manager = get_parser_options_plugins(args=args)
- if hasattr(os, 'nice'):
+ with suppress(AttributeError, PermissionError):
os.nice(5)
verbosity = options.verbose
@@ -62,7 +63,7 @@ def run(args=None):
log.error(e)
return ExitCode.missing_dependency
- if hasattr(signal, 'SIGBUS'):
+ with suppress(AttributeError, OSError):
signal.signal(signal.SIGBUS, sigbus)
result = run_pipeline(options=options, plugin_manager=plugin_manager)
diff --git a/src/ocrmypdf/_concurrent.py b/src/ocrmypdf/_concurrent.py
index af505eb3..47f089fe 100644
--- a/src/ocrmypdf/_concurrent.py
+++ b/src/ocrmypdf/_concurrent.py
@@ -1,12 +1,13 @@
-# © 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/.
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
+
+"""OCRmyPDF concurrency abstractions."""
+
+from __future__ import annotations
import threading
from abc import ABC, abstractmethod
-from typing import Callable, Iterable, Optional
+from typing import Callable, Iterable
def _task_noop(*_args, **_kwargs):
@@ -14,6 +15,8 @@ def _task_noop(*_args, **_kwargs):
class NullProgressBar:
+ """Progress bar API that takes no actions."""
+
def __init__(self, **kwargs):
pass
@@ -28,6 +31,8 @@ class NullProgressBar:
class Executor(ABC):
+ """Abstract concurrent executor."""
+
pool_lock = threading.Lock()
pbar_class = NullProgressBar
@@ -41,10 +46,10 @@ class Executor(ABC):
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,
+ worker_initializer: Callable | None = None,
+ task: Callable | None = None,
+ task_arguments: Iterable | None = None,
+ task_finished: Callable | None = None,
) -> None:
"""
Set up parallel execution and progress reporting.
diff --git a/src/ocrmypdf/_exec/__init__.py b/src/ocrmypdf/_exec/__init__.py
index 36dc7182..15819b96 100644
--- a/src/ocrmypdf/_exec/__init__.py
+++ b/src/ocrmypdf/_exec/__init__.py
@@ -1,8 +1,6 @@
-# © 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/.
-
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
"""Manage third party executables"""
+
+from __future__ import annotations
diff --git a/src/ocrmypdf/_exec/ghostscript.py b/src/ocrmypdf/_exec/ghostscript.py
index 0ccadc45..9e21c33c 100644
--- a/src/ocrmypdf/_exec/ghostscript.py
+++ b/src/ocrmypdf/_exec/ghostscript.py
@@ -1,12 +1,10 @@
-# © 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/.
-
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
"""Interface to Ghostscript executable"""
+from __future__ import annotations
+
import logging
import os
import re
@@ -14,13 +12,11 @@ import sys
from io import BytesIO
from os import fspath
from pathlib import Path
-from shutil import which
from subprocess import PIPE, CalledProcessError
-from typing import Optional
from PIL import Image, UnidentifiedImageError
-from ocrmypdf.exceptions import MissingDependencyError, SubprocessOutputError
+from ocrmypdf.exceptions import SubprocessOutputError
from ocrmypdf.helpers import Resolution
from ocrmypdf.subprocess import get_version, run, run_polling_stderr
@@ -33,29 +29,18 @@ except AttributeError:
log = logging.getLogger(__name__)
-missing_gs_error = """
----------------------------------------------------------------------
-This error normally occurs when ocrmypdf find can't Ghostscript.
-Please ensure Ghostscript is installed and its location is added to
-the system PATH environment variable.
-
-For details see:
- https://ocrmypdf.readthedocs.io/en/latest/installation.html
----------------------------------------------------------------------
-"""
-
# Most reliable what to get the bitness of Python interpreter, according to Python docs
-_is_64bit = sys.maxsize > 2 ** 32
+_IS_64BIT = sys.maxsize > 2**32
-_gswin = None
+_GSWIN = None
if os.name == 'nt':
- if _is_64bit:
- _gswin = 'gswin64c'
+ if _IS_64BIT:
+ _GSWIN = 'gswin64c'
else:
- _gswin = 'gswin32c'
+ _GSWIN = 'gswin32c'
-GS = _gswin if _gswin else 'gs'
-del _gswin
+GS = _GSWIN if _GSWIN else 'gs'
+del _GSWIN
def version():
@@ -89,8 +74,8 @@ def rasterize_pdf(
raster_device: str,
raster_dpi: Resolution,
pageno: int = 1,
- page_dpi: Optional[Resolution] = None,
- rotation: Optional[int] = None,
+ page_dpi: Resolution | None = None,
+ rotation: int | None = None,
filter_vector: bool = False,
):
"""Rasterize one page of a PDF at resolution raster_dpi in canvas units."""
@@ -115,7 +100,7 @@ def rasterize_pdf(
+ [
'-o',
'-',
- '-sstdout=%stderr',
+ '-sstdout=%stderr', # Literal %s, not string interpolation
'-dAutoRotatePages=/None', # Probably has no effect on raster
'-f',
fspath(input_file),
@@ -126,7 +111,7 @@ def rasterize_pdf(
p = run(args_gs, stdout=PIPE, stderr=PIPE, check=True)
except CalledProcessError as e:
log.error(e.stderr.decode(errors='replace'))
- raise SubprocessOutputError('Ghostscript rasterizing failed')
+ raise SubprocessOutputError('Ghostscript rasterizing failed') from e
else:
stderr = p.stderr.decode(errors='replace')
if _gs_error_reported(stderr):
@@ -156,6 +141,8 @@ def rasterize_pdf(
class GhostscriptFollower:
+ """Parses the output of Ghostscript and uses it to update the progress bar."""
+
re_process = re.compile(r"Processing pages \d+ through (\d+).")
re_page = re.compile(r"Page (\d+)")
@@ -251,7 +238,7 @@ def generate_pdfa(
"-dPDFACompatibilityPolicy=1",
"-o",
"-",
- "-sstdout=%stderr",
+ "-sstdout=%stderr", # Literal %s, not string interpolation
]
)
args_gs.extend(fspath(s) for s in pdf_pages) # Stringify Path objs
diff --git a/src/ocrmypdf/_exec/jbig2enc.py b/src/ocrmypdf/_exec/jbig2enc.py
index 2e8a058b..0f8f7392 100644
--- a/src/ocrmypdf/_exec/jbig2enc.py
+++ b/src/ocrmypdf/_exec/jbig2enc.py
@@ -1,12 +1,10 @@
-# © 2018 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/.
-
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
"""Interface to jbig2 executable"""
+from __future__ import annotations
+
from subprocess import PIPE
from ocrmypdf.exceptions import MissingDependencyError
diff --git a/src/ocrmypdf/_exec/pngquant.py b/src/ocrmypdf/_exec/pngquant.py
index ca8a4542..64e91139 100644
--- a/src/ocrmypdf/_exec/pngquant.py
+++ b/src/ocrmypdf/_exec/pngquant.py
@@ -1,12 +1,10 @@
-# © 2018 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/.
-
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
"""Interface to pngquant executable"""
+from __future__ import annotations
+
from contextlib import contextmanager
from io import BytesIO
from pathlib import Path
diff --git a/src/ocrmypdf/_exec/tesseract.py b/src/ocrmypdf/_exec/tesseract.py
index 04c556e4..ad98836a 100644
--- a/src/ocrmypdf/_exec/tesseract.py
+++ b/src/ocrmypdf/_exec/tesseract.py
@@ -1,19 +1,16 @@
-# © 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/.
-
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
"""Interface to Tesseract executable"""
+from __future__ import annotations
+
import logging
import re
from math import pi
from os import fspath
from pathlib import Path
from subprocess import PIPE, STDOUT, CalledProcessError, TimeoutExpired
-from typing import Dict, Iterator, List, Optional
from packaging.version import Version
from PIL import Image
@@ -46,7 +43,7 @@ HOCR_TEMPLATE = """<?xml version="1.0" encoding="UTF-8"?>
</html>
"""
-TESSERACT_THRESHOLDING_METHODS: Dict[str, int] = {
+TESSERACT_THRESHOLDING_METHODS: dict[str, int] = {
'auto': 0,
'otsu': 0,
'adaptive-otsu': 1,
@@ -55,9 +52,11 @@ TESSERACT_THRESHOLDING_METHODS: Dict[str, int] = {
class TesseractLoggerAdapter(logging.LoggerAdapter):
+ "Prepend [tesseract] to messages emitted from tesseract"
+
def process(self, msg, kwargs):
kwargs['extra'] = self.extra
- return '[tesseract] %s' % (msg), kwargs
+ return f'[tesseract] {msg}', kwargs
TESSERACT_VERSION_PATTERN = r"""
@@ -105,6 +104,7 @@ TESSERACT_VERSION_PATTERN = r"""
class TesseractVersion(Version):
+ "Modify standard packaging.Version regex to support Tesseract idiosyncracies."
_regex = re.compile(
r"^\s*" + TESSERACT_VERSION_PATTERN + r"\s*$", re.VERBOSE | re.IGNORECASE
)
@@ -114,7 +114,7 @@ def version() -> str:
return get_version('tesseract', regex=r'tesseract\s(.+)')
-def has_user_words():
+def has_user_words() -> bool:
"""Does Tesseract have --user-words capability?
Not available in 4.0, but available in 4.1. Also available in 3.x, but
@@ -123,12 +123,12 @@ def has_user_words():
return version() >= '4.1'
-def has_thresholding():
+def has_thresholding() -> bool:
"""Does Tesseract have -c thresholding method capability?"""
return version() >= '5.0'
-def get_languages():
+def get_languages() -> set[str]:
def lang_error(output):
msg = (
"Tesseract failed to report available languages.\n"
@@ -159,7 +159,7 @@ def get_languages():
return {lang.strip() for lang in rest}
-def tess_base_args(langs: List[str], engine_mode: Optional[int]) -> List[str]:
+def tess_base_args(langs: list[str], engine_mode: int | None) -> list[str]:
args = ['tesseract']
if langs:
args.extend(['-l', '+'.join(langs)])
@@ -168,19 +168,19 @@ def tess_base_args(langs: List[str], engine_mode: Optional[int]) -> List[str]:
return args
-def _parse_tesseract_output(binary_output: bytes) -> Dict[str, str]:
- def g():
+def _parse_tesseract_output(binary_output: bytes) -> dict[str, str]:
+ def gen():
for line in binary_output.decode().splitlines():
line = line.strip()
parts = line.split(':', maxsplit=2)
if len(parts) == 2:
yield parts[0].strip(), parts[1].strip()
- return {k: v for k, v in g()}
+ return dict(gen())
def get_orientation(
- input_file: Path, engine_mode: Optional[int], timeout: float
+ input_file: Path, engine_mode: int | None, timeout: float
) -> OrientationConfidence:
args_tesseract = tess_base_args(['osd'], engine_mode) + [
'--psm',
@@ -205,14 +205,14 @@ def get_orientation(
osd = _parse_tesseract_output(p.stdout)
angle = int(osd.get('Orientation in degrees', 0))
- oc = OrientationConfidence(
+ orient_conf = OrientationConfidence(
angle=angle, confidence=float(osd.get('Orientation confidence', 0))
)
- return oc
+ return orient_conf
def get_deskew(
- input_file: Path, languages: List[str], engine_mode: Optional[int], timeout: float
+ input_file: Path, languages: list[str], engine_mode: int | None, timeout: float
) -> float:
"""Gets angle to deskew this page, in degrees."""
args_tesseract = tess_base_args(languages, engine_mode) + [
@@ -242,7 +242,7 @@ def get_deskew(
return deskew_degrees
-def tesseract_log_output(stream):
+def tesseract_log_output(stream: bytes) -> None:
tlog = TesseractLoggerAdapter(
log, extra=log.extra if hasattr(log, 'extra') else None
)
@@ -282,13 +282,13 @@ def tesseract_log_output(stream):
tlog.info(line.strip())
-def page_timedout(timeout):
+def page_timedout(timeout: float) -> None:
if timeout == 0:
return
log.warning("[tesseract] took too long to OCR - skipping")
-def _generate_null_hocr(output_hocr, output_text, image):
+def _generate_null_hocr(output_hocr: Path, output_text: Path, image: Path) -> None:
"""Produce a .hocr file that reports no text detected on a page that is
the same size as the input image."""
with Image.open(image) as im:
@@ -303,15 +303,15 @@ def generate_hocr(
input_file: Path,
output_hocr: Path,
output_text: Path,
- languages: List[str],
+ languages: list[str],
engine_mode: int,
- tessconfig: List[str],
+ tessconfig: list[str],
timeout: float,
pagesegmode: int,
thresholding: int,
user_words,
user_patterns,
-):
+) -> None:
"""Generate a hOCR file, which must be converted to PDF."""
prefix = output_hocr.with_suffix('')
@@ -357,7 +357,7 @@ def generate_hocr(
prefix.with_suffix('.txt').replace(output_text)
-def use_skip_page(output_pdf, output_text):
+def use_skip_page(output_pdf: Path, output_text: Path) -> None:
output_text.write_text('[skipped page]', encoding='utf-8')
# A 0 byte file to the output to indicate a skip
@@ -369,15 +369,15 @@ def generate_pdf(
input_file: Path,
output_pdf: Path,
output_text: Path,
- languages: List[str],
+ languages: list[str],
engine_mode: int,
- tessconfig: List[str],
+ tessconfig: list[str],
timeout: float,
pagesegmode: int,
thresholding: int,
user_words,
user_patterns,
-):
+) -> None:
"""Generate a PDF using Tesseract's internal PDF generator.
We specifically a text-only PDF which is more suitable for combining with
diff --git a/src/ocrmypdf/_exec/unpaper.py b/src/ocrmypdf/_exec/unpaper.py
index 69eb58ee..d7f24265 100644
--- a/src/ocrmypdf/_exec/unpaper.py
+++ b/src/ocrmypdf/_exec/unpaper.py
@@ -1,30 +1,48 @@
-# © 2015 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/.
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
+from __future__ import annotations
# unpaper documentation:
# https://github.com/Flameeyes/unpaper/blob/master/doc/basic-concepts.md
-
"""Interface to unpaper executable"""
import logging
import os
import shlex
+import sys
from contextlib import contextmanager
from decimal import Decimal
from pathlib import Path
from subprocess import PIPE, STDOUT
-from tempfile import TemporaryDirectory
-from typing import Iterator, List, Optional, Tuple, Union
+from typing import Iterator, Union
from PIL import Image
from ocrmypdf.exceptions import MissingDependencyError, SubprocessOutputError
from ocrmypdf.subprocess import get_version, run
+if sys.version_info >= (3, 10):
+ from tempfile import TemporaryDirectory
+else:
+ from tempfile import TemporaryDirectory as _TemporaryDirectory
+
+ class TemporaryDirectory(_TemporaryDirectory):
+ """Shim to consume ignore_cleanup_errors kwarg on Python 3.9 and older.
+
+ The argument is consumed without action. If users are getting errors related
+ to temporary file cleanup, they should upgrade to Python 3.10 which properly
+ cleans up temporary directories on Windows.
+
+ See: https://github.com/python/cpython/pull/24793
+ """
+
+ def __init__(self, ignore_cleanup_errors=False, **kwargs):
+ super().__init__(**kwargs)
+
+ del _TemporaryDirectory
+
+
UNPAPER_IMAGE_PIXEL_LIMIT = 256 * 1024 * 1024
DecFloat = Union[Decimal, float]
@@ -33,6 +51,8 @@ log = logging.getLogger(__name__)
class UnpaperImageTooLargeError(Exception):
+ """To capture details when an image is too large for unpaper."""
+
def __init__(
self,
w,
@@ -49,11 +69,13 @@ def version() -> str:
return get_version('unpaper')
-def _convert_image(im: Image.Image) -> Tuple[Image.Image, bool, str]:
- SUFFIXES = {'1': '.pbm', 'L': '.pgm', 'RGB': '.ppm'}
+SUPPORTED_MODES = {'1', 'L', 'RGB'}
+
+
+def _convert_image(im: Image.Image) -> tuple[Image.Image, bool]:
im_modified = False
- if im.mode not in SUFFIXES:
+ if im.mode not in SUPPORTED_MODES:
log.info("Converting image to other colorspace")
try:
if im.mode == 'P' and len(im.getcolors()) == 2:
@@ -66,41 +88,41 @@ def _convert_image(im: Image.Image) -> Tuple[Image.Image, bool, str]:
) from e
else:
im_modified = True
- try:
- suffix = SUFFIXES[im.mode]
- except KeyError:
- raise MissingDependencyError(
- "Failed to convert image to a supported format."
- ) from None
- return im, im_modified, suffix
+ if im.mode not in SUPPORTED_MODES:
+ raise MissingDependencyError(
+ "Failed to convert image to a supported format."
+ ) from None
+ return im, im_modified
@contextmanager
-def _setup_unpaper_io(input_file: Path) -> Iterator[Tuple[Path, Path, Path]]:
+def _setup_unpaper_io(input_file: Path) -> Iterator[tuple[Path, Path, Path]]:
with Image.open(input_file) as im:
if im.width * im.height >= UNPAPER_IMAGE_PIXEL_LIMIT:
raise UnpaperImageTooLargeError(w=im.width, h=im.height)
- im, im_modified, suffix = _convert_image(im)
+ im, im_modified = _convert_image(im)
- with TemporaryDirectory() as tmpdir:
+ with TemporaryDirectory(ignore_cleanup_errors=True) as tmpdir:
tmppath = Path(tmpdir)
- if im_modified or input_file.suffix != '.pnm':
- input_pnm = tmppath / 'input.pnm'
- im.save(input_pnm, format='PPM')
+ if im_modified or input_file.suffix != '.png':
+ input_png = tmppath / 'input.png'
+ im.save(input_png, format='PNG')
else:
# No changes, PNG input, just use the file we already have
- input_pnm = input_file
+ input_png = input_file
- output_pnm = tmppath / f'output{suffix}'
- yield input_pnm, output_pnm, tmppath
+ # unpaper can write .png too, but it seems to write them slowly
+ # adds a few seconds to test suite - so just use pnm
+ output_pnm = tmppath / 'output.pnm'
+ yield input_png, output_pnm, tmppath
def run_unpaper(
- input_file: Path, output_file: Path, *, dpi: DecFloat, mode_args: List[str]
+ input_file: Path, output_file: Path, *, dpi: DecFloat, mode_args: list[str]
) -> None:
args_unpaper = ['unpaper', '-v', '--dpi', str(round(dpi, 6))] + mode_args
- with _setup_unpaper_io(input_file) as (input_pnm, output_pnm, tmpdir):
+ with _setup_unpaper_io(input_file) as (input_png, output_pnm, tmpdir):
# To prevent any shenanigans from accepting arbitrary parameters in
# --unpaper-args, we:
# 1) run with cwd set to a tmpdir with only unpaper's files
@@ -108,7 +130,7 @@ def run_unpaper(
# 3) append absolute paths for the input and output file
# This should ensure that a user cannot clobber some other file with
# their unpaper arguments (whether intentionally or otherwise)
- args_unpaper.extend([os.fspath(input_pnm), os.fspath(output_pnm)])
+ args_unpaper.extend([os.fspath(input_png), os.fspath(output_pnm)])
run(
args_unpaper,
close_fds=True,
@@ -129,7 +151,7 @@ def run_unpaper(
) from e
-def validate_custom_args(args: str) -> List[str]:
+def validate_custom_args(args: str) -> list[str]:
unpaper_args = shlex.split(args)
if any(('/' in arg or arg == '.' or arg == '..') for arg in unpaper_args):
raise ValueError('No filenames allowed in --unpaper-args')
@@ -141,7 +163,7 @@ def clean(
output_file: Path,
*,
dpi: DecFloat,
- unpaper_args: Optional[List[str]] = None,
+ unpaper_args: list[str] | None = None,
) -> Path:
default_args = [
'--layout',
diff --git a/src/ocrmypdf/_graft.py b/src/ocrmypdf/_graft.py
index 29369280..ebefcac4 100644
--- a/src/ocrmypdf/_graft.py
+++ b/src/ocrmypdf/_graft.py
@@ -1,22 +1,19 @@
-# © 2018 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/.
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
+"""For grafting text-only PDF pages onto freeform PDF pages."""
+
+from __future__ import annotations
import logging
-import uuid
from contextlib import suppress
from pathlib import Path
-from typing import Optional
from pikepdf import (
Dictionary,
Name,
Object,
Operator,
- Page,
Pdf,
PdfError,
PdfMatrix,
@@ -81,6 +78,8 @@ def strip_invisible_text(pdf, page):
class OcrGrafter:
+ """Manages grafting text-only PDFs onto regular PDFs."""
+
def __init__(self, context):
self.context = context
self.path_base = context.origin
@@ -102,8 +101,8 @@ class OcrGrafter:
self,
*,
pageno: int,
- image: Optional[Path],
- textpdf: Optional[Path],
+ image: Path | None,
+ textpdf: Path | None,
autorotate_correction: int,
):
if textpdf and not self.font:
@@ -236,6 +235,8 @@ class OcrGrafter:
):
"""Insert the text layer from text page 0 on to pdf_base at page_num"""
+ # pylint: disable=invalid-name
+
log.debug("Grafting")
if Path(textpdf).stat().st_size == 0:
return
@@ -282,7 +283,7 @@ class OcrGrafter:
base_resources = _ensure_dictionary(base_page, Name.Resources)
base_xobjs = _ensure_dictionary(base_resources, Name.XObject)
- text_xobj_name = Name('/' + str(uuid.uuid4()))
+ text_xobj_name = Name.random(prefix="OCR-")
xobj = self.pdf_base.make_stream(pdf_text_contents)
base_xobjs[text_xobj_name] = xobj
xobj.Type = Name.XObject
diff --git a/src/ocrmypdf/_jobcontext.py b/src/ocrmypdf/_jobcontext.py
index 2363ccbb..bc9fe2b2 100644
--- a/src/ocrmypdf/_jobcontext.py
+++ b/src/ocrmypdf/_jobcontext.py
@@ -1,9 +1,9 @@
-# © 2018 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/.
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
+"""Defines context objects that are passed to child processes/threads."""
+
+from __future__ import annotations
import os
import shutil
@@ -49,7 +49,7 @@ class PdfContext:
"""
return self.work_folder / name
- def get_page_contexts(self) -> Iterator['PageContext']:
+ def get_page_contexts(self) -> Iterator[PageContext]:
"""Get all ``PageContext`` for this PDF."""
npages = len(self.pdfinfo)
for n in range(npages):
@@ -83,7 +83,7 @@ class PageContext:
The path will be based in a common temporary folder and have a prefix based
on the page number.
"""
- return self.work_folder / ("%06d_%s" % (self.pageno + 1, name))
+ return self.work_folder / f"{(self.pageno + 1):06d}_{name}"
def __getstate__(self):
state = self.__dict__.copy()
diff --git a/src/ocrmypdf/_logging.py b/src/ocrmypdf/_logging.py
index 1aac857f..533132bf 100644
--- a/src/ocrmypdf/_logging.py
+++ b/src/ocrmypdf/_logging.py
@@ -1,18 +1,19 @@
-# © 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/.
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
+"""Logging support classes."""
+
+from __future__ import annotations
import logging
-import sys
from contextlib import suppress
from tqdm import tqdm
class PageNumberFilter(logging.Filter):
+ """Insert PDF page number that emitted log message to log record."""
+
def filter(self, record):
pageno = getattr(record, 'pageno', None)
if isinstance(pageno, int):
diff --git a/src/ocrmypdf/_pipeline.py b/src/ocrmypdf/_pipeline.py
index f0c690ca..0cefc19c 100644
--- a/src/ocrmypdf/_pipeline.py
+++ b/src/ocrmypdf/_pipeline.py
@@ -1,9 +1,9 @@
-# © 2016 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/.
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
+"""OCRmyPDF page processing pipeline functions."""
+
+from __future__ import annotations
import logging
import os
@@ -13,7 +13,7 @@ from contextlib import suppress
from datetime import datetime, timezone
from pathlib import Path
from shutil import copyfileobj
-from typing import Dict, Iterable, Optional
+from typing import Iterable
import img2pdf
import pikepdf
@@ -34,14 +34,13 @@ from ocrmypdf.exceptions import (
)
from ocrmypdf.helpers import IMG2PDF_KWARGS, Resolution, safe_symlink
from ocrmypdf.hocrtransform import HocrTransform
-from ocrmypdf.optimize import optimize
from ocrmypdf.pdfa import generate_pdfa_ps
from ocrmypdf.pdfinfo import Colorspace, Encoding, PdfInfo
# Remove this workaround when we require Pillow >= 10
try:
BICUBIC = Image.Resampling.BICUBIC # type: ignore
-except AttributeError:
+except AttributeError: # pragma: no cover
# Pillow 9 shim
BICUBIC = Image.BICUBIC # type: ignore
@@ -332,7 +331,8 @@ def is_ocr_required(page_context: PageContext):
ocr_required = False
log.warning(
"page too big, skipping OCR "
- f"({(pixel_count / 1_000_000):.1f} MPixels > {options.skip_big:.1f} MPixels --skip-big)"
+ f"({(pixel_count / 1_000_000):.1f} MPixels > "
+ f"{options.skip_big:.1f} MPixels --skip-big)"
)
return ocr_required
@@ -430,8 +430,8 @@ def rasterize(
output_file = page_context.get_path(f'rasterize{output_tag}.png')
pageinfo = page_context.pageinfo
- def at_least(cs):
- return max(device_idx, colorspaces.index(cs))
+ def at_least(colorspace):
+ return max(device_idx, colorspaces.index(colorspace))
for image in pageinfo.images:
if image.type_ != 'image':
@@ -471,10 +471,10 @@ def rasterize(
def preprocess_remove_background(input_file: Path, page_context: PageContext):
if any(image.bpc > 1 for image in page_context.pageinfo.images):
- output_file = page_context.get_path('pp_rm_bg.png')
- # leptonica.remove_background(input_file, output_file)
raise NotImplementedError("--remove-background is temporarily not implemented")
- return output_file
+ # output_file = page_context.get_path('pp_rm_bg.png')
+ # leptonica.remove_background(input_file, output_file)
+ # return output_file
else:
log.info("background removal skipped on mono page")
return input_file
@@ -493,7 +493,7 @@ def preprocess_deskew(input_file: Path, page_context: PageContext):
deskewed = im.rotate(
deskew_angle_degrees,
resample=BICUBIC,
- fillcolor=ImageColor.getcolor('white', mode=im.mode),
+ fillcolor=ImageColor.getcolor('white', mode=im.mode), # type: ignore
)
deskewed.save(output_file, dpi=dpi)
@@ -664,7 +664,7 @@ def ocr_engine_textonly_pdf(input_image: Path, page_context: PageContext):
return (output_pdf, output_text)
-def get_docinfo(base_pdf: pikepdf.Pdf, context: PdfContext) -> Dict[str, str]:
+def get_docinfo(base_pdf: pikepdf.Pdf, context: PdfContext) -> dict[str, str]:
options = context.options
def from_document_info(key):
@@ -678,15 +678,14 @@ def get_docinfo(base_pdf: pikepdf.Pdf, context: PdfContext) -> Dict[str, str]:
k: from_document_info(k)
for k in ('/Title', '/Author', '/Keywords', '/Subject', '/CreationDate')
}
- if options is not None:
- 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
+ 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
creator_tag = context.plugin_manager.hook.get_ocr_engine().creator_tag(options)
@@ -816,13 +815,14 @@ def metadata_fixup(working_file: Path, context: PdfContext):
missing = set(meta_original.keys()) - set(meta.keys())
report_on_metadata(missing)
+ optimizing = context.plugin_manager.hook.is_optimization_enabled(
+ context=context
+ )
pdf.save(
output_file,
**get_pdf_save_settings(options.output_type),
linearize=( # Don't linearize if optimize() will be linearizing too
- should_linearize(working_file, context)
- if options.optimize == 0
- else False
+ not optimizing and should_linearize(working_file, context)
),
)
@@ -831,12 +831,22 @@ def metadata_fixup(working_file: Path, context: PdfContext):
def optimize_pdf(input_file: Path, context: PdfContext, executor: Executor):
output_file = context.get_path('optimize.pdf')
- save_settings = dict(
+ output_pdf, messages = context.plugin_manager.hook.optimize_pdf(
+ input_pdf=input_file,
+ output_pdf=output_file,
+ context=context,
+ executor=executor,
linearize=should_linearize(input_file, context),
- **get_pdf_save_settings(context.options.output_type),
)
- optimize(input_file, output_file, context, save_settings, executor)
- return output_file
+
+ input_size = input_file.stat().st_size
+ output_size = output_file.stat().st_size
+ if output_size > 0:
+ ratio = input_size / output_size
+ savings = 1 - output_size / input_size
+ log.info(f"Optimize ratio: {ratio:.2f} savings: {(savings):.1%}")
+
+ return output_pdf, messages
def enumerate_compress_ranges(iterable):
@@ -855,11 +865,11 @@ def enumerate_compress_ranges(iterable):
yield (skipped_from, index), None
-def merge_sidecars(txt_files: Iterable[Optional[Path]], context: PdfContext):
+def merge_sidecars(txt_files: Iterable[Path | None], context: PdfContext):
output_file = context.get_path('sidecar.txt')
with open(output_file, 'w', encoding="utf-8") as stream:
- for (frm, to), txt_file in enumerate_compress_ranges(txt_files):
- if frm != 1:
+ for (from_, to_), txt_file in enumerate_compress_ranges(txt_files):
+ if from_ != 1:
stream.write('\f') # Form feed between pages
if txt_file:
with open(txt_file, encoding="utf-8") as in_:
@@ -872,10 +882,10 @@ def merge_sidecars(txt_files: Iterable[Optional[Path]], context: PdfContext):
else:
stream.write(txt)
else:
- if frm != to:
- pages = f'{frm}-{to}'
+ if from_ != to_:
+ pages = f'{from_}-{to_}'
else:
- pages = f'{frm}'
+ pages = f'{from_}'
stream.write(f'[OCR skipped on page(s) {pages}]')
return output_file
diff --git a/src/ocrmypdf/_plugin_manager.py b/src/ocrmypdf/_plugin_manager.py
index 3e28048d..50521512 100644
--- a/src/ocrmypdf/_plugin_manager.py
+++ b/src/ocrmypdf/_plugin_manager.py
@@ -1,9 +1,9 @@
-# © 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/.
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
+"""Plugin manager using pluggy."""
+
+from __future__ import annotations
import argparse
import importlib
@@ -11,7 +11,7 @@ import importlib.util
import pkgutil
import sys
from pathlib import Path
-from typing import List, Sequence, Tuple, Union
+from typing import Sequence
import pluggy
@@ -33,7 +33,7 @@ class OcrmypdfPluginManager(pluggy.PluginManager):
def __init__(
self,
*args,
- plugins: List[Union[str, Path]],
+ plugins: list[str | Path],
builtins: bool = True,
**kwargs,
):
@@ -100,23 +100,28 @@ class OcrmypdfPluginManager(pluggy.PluginManager):
self.register(module)
-def get_plugin_manager(plugins: List[Union[str, Path]], builtins=True):
- pm = OcrmypdfPluginManager(
+def get_plugin_manager(plugins: list[str | Path], builtins=True):
+ return OcrmypdfPluginManager(
project_name='ocrmypdf',
plugins=plugins,
builtins=builtins,
)
- return pm
def get_parser_options_plugins(
args: Sequence[str],
-) -> Tuple[argparse.ArgumentParser, argparse.Namespace, pluggy.PluginManager]:
+) -> tuple[argparse.ArgumentParser, argparse.Namespace, pluggy.PluginManager]:
pre_options, _unused = plugins_only_parser.parse_known_args(args=args)
plugin_manager = get_plugin_manager(pre_options.plugins)
parser = get_parser()
+ plugin_manager.hook.initialize( # pylint: disable=no-member
+ plugin_manager=plugin_manager
+ )
plugin_manager.hook.add_options(parser=parser) # pylint: disable=no-member
options = parser.parse_args(args=args)
return parser, options, plugin_manager
+
+
+__all__ = ['OcrmypdfPluginManager', 'get_plugin_manager', 'get_parser_options_plugins']
diff --git a/src/ocrmypdf/_sync.py b/src/ocrmypdf/_sync.py
index 7958674c..6a9a85a8 100644
--- a/src/ocrmypdf/_sync.py
+++ b/src/ocrmypdf/_sync.py
@@ -1,9 +1,10 @@
-# © 2016 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/.
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
+"""Implements the concurrent and page synchronous parts of the pipeline."""
+
+
+from __future__ import annotations
import argparse
import logging
@@ -16,7 +17,7 @@ from concurrent.futures.thread import BrokenThreadPool
from functools import partial
from pathlib import Path
from tempfile import mkdtemp
-from typing import List, NamedTuple, Optional, Tuple, cast
+from typing import NamedTuple, Sequence, cast
import PIL
@@ -68,11 +69,13 @@ from ocrmypdf.pdfa import file_claims_pdfa
log = logging.getLogger(__name__)
-class PageResult(NamedTuple): # pylint: disable=inherit-non-class
+class PageResult(NamedTuple):
+ """Result when a page is finished processing."""
+
pageno: int
- pdf_page_from_image: Optional[Path]
- ocr: Optional[Path]
- text: Optional[Path]
+ pdf_page_from_image: Path | None
+ ocr: Path | None
+ text: Path | None
orientation_correction: int
@@ -111,7 +114,7 @@ def preprocess(
def make_intermediate_images(
page_context: PageContext, orientation_correction: int
-) -> Tuple[Path, Optional[Path]]:
+) -> tuple[Path, Path | None]:
options = page_context.options
ocr_image = preprocess_out = None
@@ -226,7 +229,9 @@ def exec_page_sync(page_context: PageContext) -> PageResult:
)
-def post_process(pdf_file: Path, context: PdfContext, executor: Executor) -> Path:
+def post_process(
+ pdf_file: Path, context: PdfContext, executor: Executor
+) -> tuple[Path, Sequence[str]]:
pdf_out = pdf_file
if context.options.output_type.startswith('pdfa'):
ps_stub_out = generate_postscript_stub(context)
@@ -244,7 +249,7 @@ def worker_init(max_pixels: int) -> None:
pikepdf_enable_mmap()
-def exec_concurrent(context: PdfContext, executor: Executor) -> None:
+def exec_concurrent(context: PdfContext, executor: Executor) -> Sequence[str]:
"""Execute the pipeline concurrently"""
# Run exec_page_sync on every page context
@@ -253,7 +258,7 @@ def exec_concurrent(context: PdfContext, executor: Executor) -> None:
if max_workers > 1:
log.info("Start processing %d pages concurrently", max_workers)
- sidecars: List[Optional[Path]] = [None] * len(context.pdfinfo)
+ sidecars: list[Path | None] = [None] * len(context.pdfinfo)
ocrgraft = OcrGrafter(context)
def update_page(result: PageResult, pbar):
@@ -296,13 +301,15 @@ def exec_concurrent(context: PdfContext, executor: Executor) -> None:
# Merge layers to one single pdf
pdf = ocrgraft.finalize()
+ messages: Sequence[str] = []
if options.output_type != 'none':
# PDF/A and metadata
log.info("Postprocessing...")
- pdf = post_process(pdf, context, executor)
+ pdf, messages = post_process(pdf, context, executor)
# Copy PDF file to destination
copy_final(pdf, options.output_file, context)
+ return messages
def configure_debug_logging(
@@ -329,7 +336,7 @@ def configure_debug_logging(
def run_pipeline(
options: argparse.Namespace,
*,
- plugin_manager: Optional[OcrmypdfPluginManager],
+ plugin_manager: OcrmypdfPluginManager | None,
api: bool = False,
) -> ExitCode:
# Any changes to options will not take effect for options that are already
@@ -382,7 +389,7 @@ def run_pipeline(
validate_pdfinfo_options(context)
# Execute the pipeline
- exec_concurrent(context, executor)
+ optimize_messages = exec_concurrent(context, executor)
if options.output_file == '-':
log.info("Output sent to stdout")
@@ -408,7 +415,9 @@ def run_pipeline(
if not check_pdf(options.output_file):
log.warning('Output file: The generated PDF is INVALID')
return ExitCode.invalid_output_pdf
- report_output_file_size(options, start_input_file, options.output_file)
+ report_output_file_size(
+ options, start_input_file, options.output_file, optimize_messages
+ )
except (KeyboardInterrupt if not api else NeverRaise):
if options.verbose >= 1:
@@ -425,7 +434,7 @@ def run_pipeline(
else:
log.error(type(e).__name__)
return e.exit_code
- except (PIL.Image.DecompressionBombError if not api else NeverRaise) as e:
+ except (PIL.Image.DecompressionBombError if not api else NeverRaise):
log.exception(
"A decompression bomb error was encountered while executing the "
"pipeline. Use the argument --max-image-mpixels to raise the maximum "
@@ -435,7 +444,7 @@ def run_pipeline(
except (
BrokenProcessPool if not api else NeverRaise,
BrokenThreadPool if not api else NeverRaise,
- ) as e:
+ ):
log.exception(
"A worker process was terminated unexpectedly. This is known to occur if "
"processing your file takes all available swap space and RAM. It may "
diff --git a/src/ocrmypdf/_validation.py b/src/ocrmypdf/_validation.py
index 613e1c9f..0533b928 100644
--- a/src/ocrmypdf/_validation.py
+++ b/src/ocrmypdf/_validation.py
@@ -1,31 +1,33 @@
#!/usr/bin/env python3
-# © 2015-17 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/.
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
+"""Validate a work order from API or command line."""
+
+from __future__ import annotations
import locale
import logging
import os
import sys
import unicodedata
+from argparse import Namespace
from pathlib import Path
from shutil import copyfileobj
-from typing import List, Set, Tuple
+from typing import Sequence
import pikepdf
import PIL
+from pluggy import PluginManager
-from ocrmypdf._exec import jbig2enc, pngquant, unpaper
+from ocrmypdf._exec import unpaper
from ocrmypdf.exceptions import (
BadArgsError,
InputFileError,
MissingDependencyError,
OutputFileAccessError,
)
-from ocrmypdf.helpers import is_file_writable, monotonic, safe_symlink, samefile
+from ocrmypdf.helpers import is_file_writable, monotonic, safe_symlink
from ocrmypdf.hocrtransform import HOCR_OK_LANGS
from ocrmypdf.subprocess import check_external_program
@@ -40,7 +42,7 @@ log = logging.getLogger(__name__)
# --------
-def check_platform():
+def check_platform() -> None:
if os.name == 'nt' and sys.maxsize <= 2**32: # pragma: no cover
# 32-bit interpreter on Windows
log.error(
@@ -49,7 +51,7 @@ def check_platform():
)
-def check_options_languages(options, ocr_engine_languages):
+def check_options_languages(options: Namespace, ocr_engine_languages: set[str]) -> None:
if not options.languages:
options.languages = {DEFAULT_LANGUAGE}
system_lang = locale.getlocale()[0]
@@ -68,7 +70,7 @@ def check_options_languages(options, ocr_engine_languages):
raise MissingDependencyError(msg)
-def check_options_output(options):
+def check_options_output(options: Namespace) -> None:
is_latin = options.languages.issubset(HOCR_OK_LANGS)
if options.pdf_renderer.startswith('hocr') and not is_latin:
@@ -104,7 +106,7 @@ def check_options_output(options):
)
-def check_options_sidecar(options):
+def check_options_sidecar(options: Namespace) -> None:
if options.sidecar == '\0':
if options.output_file == '-':
raise BadArgsError(
@@ -121,7 +123,7 @@ def check_options_sidecar(options):
)
-def check_options_preprocessing(options):
+def check_options_preprocessing(options: Namespace) -> None:
if options.clean_final:
options.clean = True
if options.unpaper_args and not options.clean:
@@ -143,16 +145,16 @@ def check_options_preprocessing(options):
raise BadArgsError("--unpaper-args: " + str(e)) from e
-def _pages_from_ranges(ranges: str) -> Set[int]:
- pages: List[int] = []
+def _pages_from_ranges(ranges: str) -> set[int]:
+ pages: list[int] = []
page_groups = ranges.replace(' ', '').split(',')
- for g in page_groups:
- if not g:
+ for group in page_groups:
+ if not group:
continue
try:
- start, end = g.split('-')
+ start, end = group.split('-')
except ValueError:
- pages.append(int(g) - 1)
+ pages.append(int(group) - 1)
else:
try:
new_pages = list(range(int(start) - 1, int(end)))
@@ -162,7 +164,7 @@ def _pages_from_ranges(ranges: str) -> Set[int]:
) from None
pages.extend(new_pages)
except ValueError:
- raise BadArgsError(f"invalid page subrange '{g}'") from None
+ raise BadArgsError(f"invalid page subrange '{group}'") from None
if not pages:
raise BadArgsError(
@@ -182,7 +184,7 @@ def _pages_from_ranges(ranges: str) -> Set[int]:
return set(pages)
-def check_options_ocr_behavior(options):
+def check_options_ocr_behavior(options: Namespace) -> None:
exclusive_options = sum(
(1 if opt else 0)
for opt in (options.force_ocr, options.skip_text, options.redo_ocr)
@@ -193,38 +195,7 @@ def check_options_ocr_behavior(options):
options.pages = _pages_from_ranges(options.pages)
-def check_options_optimizing(options):
- if options.optimize >= 2:
- check_external_program(
- program='pngquant',
- package='pngquant',
- version_checker=pngquant.version,
- need_version='2.0.1',
- required_for='--optimize {2,3}',
- )
-
- if options.optimize >= 2:
- # Although we use JBIG2 for optimize=1, don't nag about it unless the
- # user is asking for more optimization
- check_external_program(
- program='jbig2',
- package='jbig2enc',
- version_checker=jbig2enc.version,
- need_version='0.28',
- required_for='--optimize {2,3} | --jbig2-lossy',
- recommended=True if not options.jbig2_lossy else False,
- )
-
- if options.optimize == 0 and any(
- [options.jbig2_lossy, options.png_quality, options.jpeg_quality]
- ):
- log.warning(
- "The arguments --jbig2-lossy, --png-quality, and --jpeg-quality "
- "will be ignored because --optimize=0."
- )
-
-
-def check_options_advanced(options):
+def check_options_advanced(options: Namespace) -> None:
if options.pdfa_image_compression != 'auto' and not options.output_type.startswith(
'pdfa'
):
@@ -234,45 +205,48 @@ def check_options_advanced(options):
)
-def check_options_metadata(options):
+def check_options_metadata(options: Namespace) -> None:
docinfo = [options.title, options.author, options.keywords, options.subject]
for s in (m for m in docinfo if m):
- for c in s:
- if unicodedata.category(c) == 'Co' or ord(c) >= 0x10000:
+ for char in s:
+ if unicodedata.category(char) == 'Co' or ord(char) >= 0x10000:
+ hexchar = hex(ord(char))[2:].upper()
raise ValueError(
"One of the metadata strings contains "
- "an unsupported Unicode character: '{}' (U+{})".format(
- c, hex(ord(c))[2:].upper()
- )
+ "an unsupported Unicode character: "
+ f"{char} (U+{hexchar})"
)
-def check_options_pillow(options):
+def check_options_pillow(options: Namespace) -> None:
PIL.Image.MAX_IMAGE_PIXELS = int(options.max_image_mpixels * 1_000_000)
if PIL.Image.MAX_IMAGE_PIXELS == 0:
PIL.Image.MAX_IMAGE_PIXELS = None
-def _check_options(options, plugin_manager, ocr_engine_languages):
+def _check_plugin_invariant_options(options: Namespace) -> None:
check_platform()
- check_options_languages(options, ocr_engine_languages)
check_options_metadata(options)
check_options_output(options)
check_options_sidecar(options)
check_options_preprocessing(options)
check_options_ocr_behavior(options)
- check_options_optimizing(options)
check_options_advanced(options)
check_options_pillow(options)
- plugin_manager.hook.check_options(options=options)
-def check_options(options, plugin_manager):
+def _check_plugin_options(options: Namespace, plugin_manager: PluginManager) -> None:
+ plugin_manager.hook.check_options(options=options)
ocr_engine_languages = plugin_manager.hook.get_ocr_engine().languages(options)
- _check_options(options, plugin_manager, ocr_engine_languages)
+ check_options_languages(options, ocr_engine_languages)
-def create_input_file(options, work_folder: Path) -> Tuple[Path, str]:
+def check_options(options: Namespace, plugin_manager: PluginManager) -> None:
+ _check_plugin_invariant_options(options)
+ _check_plugin_options(options, plugin_manager)
+
+
+def create_input_file(options: Namespace, work_folder: Path) -> tuple[Path, str]:
if options.input_file == '-':
# stdin
log.info('reading file from standard input')
@@ -293,7 +267,7 @@ def create_input_file(options, work_folder: Path) -> Tuple[Path, str]:
target = work_folder / 'origin'
safe_symlink(options.input_file, target)
return target, os.fspath(options.input_file)
- except FileNotFoundError:
+ except FileNotFoundError as e:
msg = f"File not found - {options.input_file}"
if Path('/.dockerenv').exists(): # pragma: no cover
msg += (
@@ -304,10 +278,10 @@ def create_input_file(options, work_folder: Path) -> Tuple[Path, str]:
"\n"
"\tdocker run -i --rm jbarlow83/ocrmypdf - - <input.pdf >output.pdf\n"
)
- raise InputFileError(msg)
+ raise InputFileError(msg) from e
-def check_requested_output_file(options):
+def check_requested_output_file(options: Namespace) -> None:
if options.output_file == '-':
if sys.stdout.isatty():
raise BadArgsError(
@@ -324,7 +298,16 @@ def check_requested_output_file(options):
)
-def report_output_file_size(options, input_file, output_file):
+def report_output_file_size(
+ options: Namespace,
+ input_file: Path,
+ output_file: Path,
+ optimize_messages: Sequence[str] | None = None,
+ file_overhead: int = 4000,
+ page_overhead: int = 3000,
+) -> None:
+ if optimize_messages is None:
+ optimize_messages = []
try:
output_size = Path(output_file).stat().st_size
input_size = Path(input_file).stat().st_size
@@ -333,9 +316,7 @@ def report_output_file_size(options, input_file, output_file):
with pikepdf.open(output_file) as p:
# Overhead constants obtained by estimating amount of data added by OCR
# PDF/A conversion, and possible XMP metadata addition, with compression
- FILE_OVERHEAD = 4000
- OCR_PER_PAGE_OVERHEAD = 3000
- reasonable_overhead = FILE_OVERHEAD + OCR_PER_PAGE_OVERHEAD * len(p.pages)
+ reasonable_overhead = file_overhead + page_overhead * len(p.pages)
ratio = output_size / input_size
reasonable_ratio = output_size / (input_size + reasonable_overhead)
if reasonable_ratio < 1.35 or input_size < 25000:
@@ -355,19 +336,8 @@ def report_output_file_size(options, input_file, output_file):
f"The argument --{arg.replace('_', '-')} was issued, causing transcoding."
)
- if options.optimize == 0:
- reasons.append("Optimization was disabled.")
- else:
- image_optimizers = {
- 'jbig2': jbig2enc.available(),
- 'pngquant': pngquant.available(),
- }
- for name, available in image_optimizers.items():
- if not available:
- reasons.append(
- f"The optional dependency '{name}' was not found, so some image "
- f"optimizations could not be attempted."
- )
+ reasons.extend(optimize_messages)
+
if options.output_type.startswith('pdfa'):
reasons.append("PDF/A conversion was enabled. (Try `--output-type pdf`.)")
if options.plugins:
diff --git a/src/ocrmypdf/_version.py b/src/ocrmypdf/_version.py
index 3cf5ff8b..11f8ed3f 100644
--- a/src/ocrmypdf/_version.py
+++ b/src/ocrmypdf/_version.py
@@ -1,14 +1,17 @@
-# © 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/.
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
+"""Get version by introspecting package information.
+
+OCRmyPDF uses setuptools_scm to derive version from git tags.
+"""
+
+from __future__ import annotations
try:
- from importlib_metadata import version as _package_version
-except ImportError:
from importlib.metadata import version as _package_version
+except ImportError:
+ from importlib_metadata import version as _package_version # type: ignore
PROGRAM_NAME = 'ocrmypdf'
diff --git a/src/ocrmypdf/api.py b/src/ocrmypdf/api.py
index 5c23151c..8d92eb71 100644
--- a/src/ocrmypdf/api.py
+++ b/src/ocrmypdf/api.py
@@ -1,9 +1,9 @@
-# © 2019 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/.
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
+"""Functions for using ocrmypdf as an API."""
+
+from __future__ import annotations
import logging
import os
@@ -12,7 +12,7 @@ import threading
from enum import IntEnum
from io import IOBase
from pathlib import Path
-from typing import AnyStr, BinaryIO, Iterable, Optional, Union
+from typing import AnyStr, BinaryIO, Iterable, Union
from warnings import warn
from ocrmypdf._logging import PageNumberFilter, TqdmConsole
@@ -25,7 +25,10 @@ from ocrmypdf.helpers import is_iterable_notstr
try:
import coloredlogs
except ModuleNotFoundError:
- coloredlogs = None
+ coloredlogs = None # pylint: disable=invalid-name
+
+if coloredlogs:
+ from humanfriendly.terminal import enable_ansi_support
StrPath = Union[Path, AnyStr]
@@ -37,6 +40,7 @@ _api_lock = threading.Lock()
class Verbosity(IntEnum):
"""Verbosity level for configure_logging."""
+ # pylint: disable=invalid-name
quiet = -1 #: Suppress most messages
default = 0 #: Default level of logging
debug = 1 #: Output ocrmypdf debug messages
@@ -116,16 +120,15 @@ def configure_logging(
fmt = '%(pageno)s%(message)s'
use_colors = progress_bar_friendly
- if not coloredlogs:
- use_colors = False
- if use_colors:
- if os.name == 'nt':
- use_colors = coloredlogs.enable_ansi_support()
+ formatter = None
+ if coloredlogs and use_colors:
+ use_colors = enable_ansi_support()
if use_colors:
use_colors = coloredlogs.terminal_supports_colors()
- if use_colors:
- formatter = coloredlogs.ColoredFormatter(fmt=fmt)
- else:
+ if use_colors:
+ formatter = coloredlogs.ColoredFormatter(fmt=fmt)
+
+ if not formatter:
formatter = logging.Formatter(fmt=fmt)
console.setFormatter(formatter)
@@ -193,7 +196,7 @@ def create_options(
else:
cmdline.append(os.fspath(output_file))
- parser._api_mode = True
+ parser.enable_api_mode()
options = parser.parse_args(cmdline)
for keyword, val in deferred:
setattr(options, keyword, val)
@@ -213,7 +216,7 @@ def ocr( # pylint: disable=unused-argument
language: Iterable[str] = None,
image_dpi: int = None,
output_type=None,
- sidecar: Optional[StrPath] = None,
+ sidecar: StrPath | None = None,
jobs: int = None,
use_threads: bool = None,
title: str = None,
@@ -295,7 +298,7 @@ def ocr( # pylint: disable=unused-argument
text already, and settings did not tell us to proceed.
ocrmypdf.InputFileError: Any other problem with the input file.
ocrmypdf.SubprocessOutputError: Any error related to executing a subprocess.
- ocrmypdf.EncryptedPdfERror: If the input PDF is encrypted (password protected).
+ ocrmypdf.EncryptedPdfError: If the input PDF is encrypted (password protected).
OCRmyPDF does not remove passwords.
ocrmypdf.TesseractConfigError: If Tesseract reported its configuration was not
valid.
diff --git a/src/ocrmypdf/builtin_plugins/__init__.py b/src/ocrmypdf/builtin_plugins/__init__.py
index 05d8c70e..0d361aad 100644
--- a/src/ocrmypdf/builtin_plugins/__init__.py
+++ b/src/ocrmypdf/builtin_plugins/__init__.py
@@ -1,8 +1,7 @@
-# © 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/.
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
+
+from __future__ import annotations
# This file exists only mark builtin_plugins as a package.
# The plugin manager will not load it, so anything defined here may not be
diff --git a/src/ocrmypdf/builtin_plugins/concurrency.py b/src/ocrmypdf/builtin_plugins/concurrency.py
index f5d92bcf..dabdd6dc 100644
--- a/src/ocrmypdf/builtin_plugins/concurrency.py
+++ b/src/ocrmypdf/builtin_plugins/concurrency.py
@@ -1,15 +1,8 @@
-# © 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/.
-
-# © 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/.
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
+from __future__ import annotations
+"""OCRmyPDF's multiprocessing/multithreading abstraction layer."""
import logging
import logging.handlers
@@ -21,7 +14,6 @@ import sys
import threading
from concurrent.futures import ProcessPoolExecutor, ThreadPoolExecutor, as_completed
from contextlib import suppress
-from multiprocessing.pool import Pool, ThreadPool
from typing import Callable, Iterable, Type, Union
from tqdm import tqdm
@@ -44,7 +36,8 @@ def log_listener(q: Queue):
should actually write to sys.stderr or whatever we're using, so if this is
made into a process the main application needs to be directed to it.
- See https://docs.python.org/3/howto/logging-cookbook.html#logging-to-a-single-file-from-multiple-processes
+ See:
+ https://docs.python.org/3/howto/logging-cookbook.html#logging-to-a-single-file-from-multiple-processes
"""
while True:
@@ -89,6 +82,8 @@ def process_init(q: Queue, user_init: UserInit, loglevel) -> None:
def thread_init(q: Queue, user_init: UserInit, loglevel) -> None:
+ del q # unused but required argument
+ del loglevel # unused but required argument
# As a thread, block SIGBUS so the main thread deals with it...
with suppress(AttributeError):
signal.pthread_sigmask(signal.SIG_BLOCK, {signal.SIGBUS})
@@ -98,6 +93,17 @@ def thread_init(q: Queue, user_init: UserInit, loglevel) -> None:
class StandardExecutor(Executor):
+ """Standard OCRmyPDF concurrent task executor."""
+
+ def _cancel_futures_kwargs(self):
+ """Shim older Pythons that do not have Executor.shutdown(...cancel_futures=).
+
+ Remove this code when support for Python 3.8 is dropped.
+ """
+ if sys.version_info[:2] < (3, 9):
+ return {}
+ return dict(cancel_futures=True)
+
def _execute(
self,
*,
@@ -136,7 +142,7 @@ class StandardExecutor(Executor):
task_finished(result, pbar)
except KeyboardInterrupt:
# Terminate pool so we exit instantly
- executor.shutdown(wait=False, cancel_futures=True)
+ executor.shutdown(wait=False, **self._cancel_futures_kwargs())
raise
except Exception:
if not os.environ.get("PYTEST_CURRENT_TEST", ""):
@@ -145,7 +151,7 @@ class StandardExecutor(Executor):
# results will be discard. But if the condition above is True,
# then we are running in pytest, and we want everything to exit
# as cleanly as possible so that we get good error messages.
- executor.shutdown(wait=False, cancel_futures=True)
+ executor.shutdown(wait=False, **self._cancel_futures_kwargs())
raise
finally:
# Terminate log listener
diff --git a/src/ocrmypdf/builtin_plugins/default_filters.py b/src/ocrmypdf/builtin_plugins/default_filters.py
index da3f3aae..8b1c3772 100644
--- a/src/ocrmypdf/builtin_plugins/default_filters.py
+++ b/src/ocrmypdf/builtin_plugins/default_filters.py
@@ -1,8 +1,8 @@
-# © 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/.
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
+"""OCRmyPDF automatically installs these filters as plugins."""
+
+from __future__ import annotations
from ocrmypdf import hookimpl
diff --git a/src/ocrmypdf/builtin_plugins/ghostscript.py b/src/ocrmypdf/builtin_plugins/ghostscript.py
index c16e5714..64375ad8 100644
--- a/src/ocrmypdf/builtin_plugins/ghostscript.py
+++ b/src/ocrmypdf/builtin_plugins/ghostscript.py
@@ -1,9 +1,8 @@
-# © 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/.
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
+"""Built-in plugin to implement PDF page rasterization and PDF/A production."""
+from __future__ import annotations
import logging
diff --git a/src/ocrmypdf/builtin_plugins/optimize.py b/src/ocrmypdf/builtin_plugins/optimize.py
new file mode 100644
index 00000000..639cc156
--- /dev/null
+++ b/src/ocrmypdf/builtin_plugins/optimize.py
@@ -0,0 +1,155 @@
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
+"""Built-in plugin to implement PDF page optimization."""
+
+from __future__ import annotations
+
+import argparse
+import logging
+from pathlib import Path
+from typing import Sequence
+
+from ocrmypdf import Executor, PdfContext, hookimpl
+from ocrmypdf._exec import jbig2enc, pngquant
+from ocrmypdf._pipeline import get_pdf_save_settings
+from ocrmypdf.cli import numeric
+from ocrmypdf.optimize import optimize
+from ocrmypdf.subprocess import check_external_program
+
+log = logging.getLogger(__name__)
+
+
+@hookimpl
+def add_options(parser):
+ optimizing = parser.add_argument_group(
+ "Optimization options", "Control how the PDF is optimized after OCR"
+ )
+ optimizing.add_argument(
+ '-O',
+ '--optimize',
+ type=int,
+ choices=range(0, 4),
+ default=1,
+ help=(
+ "Control how PDF is optimized after processing:"
+ "0 - do not optimize; "
+ "1 - do safe, lossless optimizations (default); "
+ "2 - do lossy JPEG and JPEG2000 optimizations; "
+ "3 - do more aggressive lossy JPEG and JPEG2000 optimizations. "
+ "To enable lossy JBIG2, see --jbig2-lossy."
+ ),
+ )
+ optimizing.add_argument(
+ '--jpeg-quality',
+ type=numeric(int, 0, 100),
+ default=0,
+ metavar='Q',
+ help=(
+ "Adjust JPEG quality level for JPEG optimization. "
+ "100 is best quality and largest output size; "
+ "1 is lowest quality and smallest output; "
+ "0 uses the default."
+ ),
+ )
+ optimizing.add_argument(
+ '--jpg-quality',
+ type=numeric(int, 0, 100),
+ default=0,
+ metavar='Q',
+ dest='jpeg_quality',
+ help=argparse.SUPPRESS, # Alias for --jpeg-quality
+ )
+ optimizing.add_argument(
+ '--png-quality',
+ type=numeric(int, 0, 100),
+ default=0,
+ metavar='Q',
+ help=(
+ "Adjust PNG quality level to use when quantizing PNGs. "
+ "Values have same meaning as with --jpeg-quality"
+ ),
+ )
+ optimizing.add_argument(
+ '--jbig2-lossy',
+ action='store_true',
+ help=(
+ "Enable JBIG2 lossy mode (better compression, not suitable for some "
+ "use cases - see documentation). Only takes effect if --optimize 1 or "
+ "higher is also enabled."
+ ),
+ )
+ optimizing.add_argument(
+ '--jbig2-page-group-size',
+ type=numeric(int, 1, 10000),
+ default=0,
+ metavar='N',
+ # Adjust number of pages to consider at once for JBIG2 compression
+ help=argparse.SUPPRESS,
+ )
+
+
+@hookimpl
+def check_options(options):
+ if options.optimize >= 2:
+ check_external_program(
+ program='pngquant',
+ package='pngquant',
+ version_checker=pngquant.version,
+ need_version='2.0.1',
+ required_for='--optimize {2,3}',
+ )
+
+ if options.optimize >= 2:
+ # Although we use JBIG2 for optimize=1, don't nag about it unless the
+ # user is asking for more optimization
+ check_external_program(
+ program='jbig2',
+ package='jbig2enc',
+ version_checker=jbig2enc.version,
+ need_version='0.28',
+ required_for='--optimize {2,3} | --jbig2-lossy',
+ recommended=True if not options.jbig2_lossy else False,
+ )
+
+ if options.optimize == 0 and any(
+ [options.jbig2_lossy, options.png_quality, options.jpeg_quality]
+ ):
+ log.warning(
+ "The arguments --jbig2-lossy, --png-quality, and --jpeg-quality "
+ "will be ignored because --optimize=0."
+ )
+
+
+@hookimpl
+def optimize_pdf(
+ input_pdf: Path,
+ output_pdf: Path,
+ context: PdfContext,
+ executor: Executor,
+ linearize: bool,
+) -> tuple[Path, Sequence[str]]:
+ save_settings = dict(
+ linearize=linearize,
+ **get_pdf_save_settings(context.options.output_type),
+ )
+ result_path = optimize(input_pdf, output_pdf, context, save_settings, executor)
+ messages = []
+ if context.options.optimize == 0:
+ messages.append("Optimization was disabled.")
+ else:
+ image_optimizers = {
+ 'jbig2': jbig2enc.available(),
+ 'pngquant': pngquant.available(),
+ }
+ for name, available in image_optimizers.items():
+ if not available:
+ messages.append(
+ f"The optional dependency '{name}' was not found, so some image "
+ f"optimizations could not be attempted."
+ )
+ return result_path, messages
+
+
+@hookimpl
+def is_optimization_enabled(context: PdfContext) -> bool:
+ return context.options.optimize != 0
diff --git a/src/ocrmypdf/builtin_plugins/tesseract_ocr.py b/src/ocrmypdf/builtin_plugins/tesseract_ocr.py
index a0de9841..d9e24e4e 100644
--- a/src/ocrmypdf/builtin_plugins/tesseract_ocr.py
+++ b/src/ocrmypdf/builtin_plugins/tesseract_ocr.py
@@ -1,10 +1,10 @@
-# © 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/.
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
+"""Built-in plugin to implement OCR using Tesseract."""
+from __future__ import annotations
+
import logging
import os
@@ -138,6 +138,8 @@ def validate(pdfinfo, options):
class TesseractOcrEngine(OcrEngine):
+ """Implements OCR with Tesseract."""
+
@staticmethod
def version():
return tesseract.version()
diff --git a/src/ocrmypdf/cli.py b/src/ocrmypdf/cli.py
index 322f1239..5c3d8020 100644
--- a/src/ocrmypdf/cli.py
+++ b/src/ocrmypdf/cli.py
@@ -1,12 +1,12 @@
-# © 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/.
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
+"""Command line interface customization and validation."""
+
+from __future__ import annotations
import argparse
-from typing import Any, Callable, Mapping, Optional, TypeVar
+from typing import Any, Callable, Mapping, TypeVar
from ocrmypdf._version import PROGRAM_NAME as _PROGRAM_NAME
from ocrmypdf._version import __version__ as _VERSION
@@ -14,9 +14,7 @@ from ocrmypdf._version import __version__ as _VERSION
T = TypeVar('T', int, float)
-def numeric(
- basetype: Callable[[Any], T], min_: Optional[T] = None, max_: Optional[T] = None
-):
+def numeric(basetype: Callable[[Any], T], min_: T | None = None, max_: T | None = None):
"""Validator for numeric params"""
min_ = basetype(min_) if min_ is not None else None
max_ = basetype(max_) if max_ is not None else None
@@ -42,7 +40,7 @@ def str_to_int(mapping: Mapping[str, int]):
except KeyError:
raise argparse.ArgumentTypeError(
f"{s!r} must be one of: {', '.join(mapping.keys())}"
- )
+ ) from None
return _str_to_int
@@ -51,12 +49,20 @@ class ArgumentParser(argparse.ArgumentParser):
"""Override parser's default behavior of calling sys.exit()
https://stackoverflow.com/questions/5943249/python-argparse-and-controlling-overriding-the-exit-status-code
+
+ OCRmyPDF began as a CLI but eventually acquired an API. The API works inside out,
+ by synthesizing a command line argument. So we subclass the standard parser with
+ one that doesn't call sys.exit(). Obviously this is not the ideal way to do things
+ but it works for us.
"""
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self._api_mode = False
+ def enable_api_mode(self):
+ self._api_mode = True
+
def error(self, message):
if not self._api_mode:
super().error(message)
@@ -65,6 +71,8 @@ class ArgumentParser(argparse.ArgumentParser):
class LanguageSetAction(argparse.Action):
+ """Manages a list of languages."""
+
def __init__(self, option_strings, dest, default=None, **kwargs):
if default is None:
default = set()
@@ -342,72 +350,6 @@ after installing the ocrmypdf-doc package.
"but include skipped pages in final output",
)
- optimizing = parser.add_argument_group(
- "Optimization options", "Control how the PDF is optimized after OCR"
- )
- optimizing.add_argument(
- '-O',
- '--optimize',
- type=int,
- choices=range(0, 4),
- default=1,
- help=(
- "Control how PDF is optimized after processing:"
- "0 - do not optimize; "
- "1 - do safe, lossless optimizations (default); "
- "2 - do lossy JPEG and JPEG2000 optimizations; "
- "3 - do more aggressive lossy JPEG and JPEG2000 optimizations. "
- "To enable lossy JBIG2, see --jbig2-lossy."
- ),
- )
- optimizing.add_argument(
- '--jpeg-quality',
- type=numeric(int, 0, 100),
- default=0,
- metavar='Q',
- help=(
- "Adjust JPEG quality level for JPEG optimization. "
- "100 is best quality and largest output size; "
- "1 is lowest quality and smallest output; "
- "0 uses the default."
- ),
- )
- optimizing.add_argument(
- '--jpg-quality',
- type=numeric(int, 0, 100),
- default=0,
- metavar='Q',
- dest='jpeg_quality',
- help=argparse.SUPPRESS, # Alias for --jpeg-quality
- )
- optimizing.add_argument(
- '--png-quality',
- type=numeric(int, 0, 100),
- default=0,
- metavar='Q',
- help=(
- "Adjust PNG quality level to use when quantizing PNGs. "
- "Values have same meaning as with --jpeg-quality"
- ),
- )
- optimizing.add_argument(
- '--jbig2-lossy',
- action='store_true',
- help=(
- "Enable JBIG2 lossy mode (better compression, not suitable for some "
- "use cases - see documentation). Only takes effect if --optimize 1 or "
- "higher is also enabled."
- ),
- )
- optimizing.add_argument(
- '--jbig2-page-group-size',
- type=numeric(int, 1, 10000),
- default=0,
- metavar='N',
- # Adjust number of pages to consider at once for JBIG2 compression
- help=argparse.SUPPRESS,
- )
-
advanced = parser.add_argument_group(
"Advanced", "Advanced options to control OCRmyPDF"
)
diff --git a/src/ocrmypdf/data/__init__.py b/src/ocrmypdf/data/__init__.py
index ad56a522..e747a84e 100644
--- a/src/ocrmypdf/data/__init__.py
+++ b/src/ocrmypdf/data/__init__.py
@@ -1,8 +1,5 @@
-# © 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/.
-
-
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
"""Data files used to generate certain PDFs."""
+
+from __future__ import annotations
diff --git a/src/ocrmypdf/exceptions.py b/src/ocrmypdf/exceptions.py
index 5228b241..d5a9ae8e 100644
--- a/src/ocrmypdf/exceptions.py
+++ b/src/ocrmypdf/exceptions.py
@@ -1,15 +1,18 @@
-# © 2016 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/.
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
+"""OCRmyPDF's exceptions."""
+
+from __future__ import annotations
from enum import IntEnum
from textwrap import dedent
class ExitCode(IntEnum):
+ """OCRmyPDF's exit codes."""
+
+ # pylint: disable=invalid-name
ok = 0
bad_args = 1
input_file = 2
@@ -26,6 +29,8 @@ class ExitCode(IntEnum):
class ExitCodeException(Exception):
+ """An exception which should return an exit code with sys.exit()."""
+
exit_code = ExitCode.other_error
message = ""
@@ -37,17 +42,24 @@ class ExitCodeException(Exception):
class BadArgsError(ExitCodeException):
+ """Invalid arguments on the command line or API."""
+
exit_code = ExitCode.bad_args
-class PdfMergeFailedError(ExitCodeException):
+class PdfMergeFailedError(ExitCodeException): # deprecated
+ """An intermediate PDF can't be merged.
+
+ No longer in use.
+ """
+
exit_code = ExitCode.input_file
message = dedent(
'''\
Failed to merge PDF image layer with OCR layer
Usually this happens because the input PDF file is malformed and
- ocrmypdf cannot automatically correct the problem on its own.
+ ocrmypdf cannot correct the problem on its own.
Try using
ocrmypdf --pdf-renderer sandwich [..other args..]
@@ -56,34 +68,50 @@ class PdfMergeFailedError(ExitCodeException):
class MissingDependencyError(ExitCodeException):
+ """A third-party dependency is missing."""
+
exit_code = ExitCode.missing_dependency
class UnsupportedImageFormatError(ExitCodeException):
+ """The image format is not supported."""
+
exit_code = ExitCode.input_file
class DpiError(ExitCodeException):
+ """Missing information about input image DPI."""
+
exit_code = ExitCode.input_file
class OutputFileAccessError(ExitCodeException):
+ """Cannot access the intended output file path."""
+
exit_code = ExitCode.file_access_error
class PriorOcrFoundError(ExitCodeException):
+ """This file already has OCR."""
+
exit_code = ExitCode.already_done_ocr
class InputFileError(ExitCodeException):
+ """Something is wrong with the input file."""
+
exit_code = ExitCode.input_file
class SubprocessOutputError(ExitCodeException):
+ """A subprocess returned an unexpected error."""
+
exit_code = ExitCode.child_process_error
class EncryptedPdfError(ExitCodeException):
+ """Input PDF is encrypted."""
+
exit_code = ExitCode.encrypted_pdf
message = dedent(
'''\
@@ -100,5 +128,7 @@ class EncryptedPdfError(ExitCodeException):
class TesseractConfigError(ExitCodeException):
+ """Tesseract config can't be parsed."""
+
exit_code = ExitCode.invalid_config
message = "Error occurred while parsing a Tesseract configuration file"
diff --git a/src/ocrmypdf/extra_plugins/__init__.py b/src/ocrmypdf/extra_plugins/__init__.py
index e69de29b..079cf307 100644
--- a/src/ocrmypdf/extra_plugins/__init__.py
+++ b/src/ocrmypdf/extra_plugins/__init__.py
@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+#
+# SPDX-License-Identifier: MPL-2.0
diff --git a/src/ocrmypdf/extra_plugins/semfree.py b/src/ocrmypdf/extra_plugins/semfree.py
index 186206d9..43e81654 100644
--- a/src/ocrmypdf/extra_plugins/semfree.py
+++ b/src/ocrmypdf/extra_plugins/semfree.py
@@ -1,10 +1,5 @@
-# © 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/.
-
-
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
"""Semaphore-free alternate executor.
There are two popular environments that do not fully support the standard Python
@@ -20,6 +15,8 @@ be guaranteed, some workers may end up with too much work while others are idle.
It is less efficient than the standard implementation, so not th edefault.
"""
+from __future__ import annotations
+
import logging
import logging.handlers
import signal
@@ -28,7 +25,7 @@ from enum import Enum, auto
from itertools import islice, repeat, takewhile, zip_longest
from multiprocessing import Pipe, Process
from multiprocessing.connection import Connection, wait
-from typing import Callable, Iterable, Iterator, List
+from typing import Callable, Iterable, Iterator
from ocrmypdf import Executor, hookimpl
from ocrmypdf._concurrent import NullProgressBar
@@ -37,9 +34,11 @@ from ocrmypdf.helpers import remove_all_log_handlers
class MessageType(Enum):
- exception = auto()
- result = auto()
- complete = auto()
+ """Implement basic IPC messaging."""
+
+ exception = auto() # pylint: disable=invalid-name
+ result = auto() # pylint: disable=invalid-name
+ complete = auto() # pylint: disable=invalid-name
def split_every(n: int, iterable: Iterable) -> Iterator:
@@ -59,6 +58,8 @@ def process_sigbus(*args):
class ConnectionLogHandler(logging.handlers.QueueHandler):
+ """Handler used by child processes to forward log messages to parent."""
+
def __init__(self, conn: Connection) -> None:
# sets the parent's queue to None - parent only touches queue
# in enqueue() which we override
@@ -91,7 +92,7 @@ def process_loop(
for args in task_args:
try:
result = task(args)
- except Exception as e:
+ except Exception as e: # pylint: disable=broad-except
conn.send((MessageType.exception, e))
break
else:
@@ -103,6 +104,8 @@ def process_loop(
class LambdaExecutor(Executor):
+ """Executor for AWS Lambda or similar environments that lack semaphores."""
+
def _execute(
self,
*,
@@ -128,8 +131,8 @@ class LambdaExecutor(Executor):
if not grouped_args:
return
- processes: List[Process] = []
- connections: List[Connection] = []
+ processes: list[Process] = []
+ connections: list[Connection] = []
for chunk in grouped_args:
parent_conn, child_conn = Pipe()
@@ -153,13 +156,13 @@ class LambdaExecutor(Executor):
with self.pbar_class(**tqdm_kwargs) as pbar:
while connections:
- for r in wait(connections):
- if not isinstance(r, Connection):
+ for result in wait(connections):
+ if not isinstance(result, Connection):
raise NotImplementedError("We only support Connection()")
try:
- msg_type, msg = r.recv()
+ msg_type, msg = result.recv()
except EOFError:
- connections.remove(r)
+ connections.remove(result)
continue
if msg_type == MessageType.result:
@@ -170,7 +173,7 @@ class LambdaExecutor(Executor):
logger = logging.getLogger(record.name)
logger.handle(record)
elif msg_type == MessageType.complete:
- connections.remove(r)
+ connections.remove(result)
elif msg_type == MessageType.exception:
for process in processes:
process.terminate()
diff --git a/src/ocrmypdf/helpers.py b/src/ocrmypdf/helpers.py
index 2169e64a..481b2f1b 100644
--- a/src/ocrmypdf/helpers.py
+++ b/src/ocrmypdf/helpers.py
@@ -1,9 +1,9 @@
-# © 2016 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/.
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
+"""Support functions."""
+
+from __future__ import annotations
import logging
import multiprocessing
@@ -137,11 +137,11 @@ def safe_symlink(input_file: os.PathLike, soft_link_name: os.PathLike):
os.symlink(os.path.abspath(input_file), soft_link_name)
-def samefile(f1: os.PathLike, f2: os.PathLike):
+def samefile(file1: os.PathLike, file2: os.PathLike):
if os.name == 'nt':
- return f1 == f2
+ return file1 == file2
else:
- return os.path.samefile(f1, f2)
+ return os.path.samefile(file1, file2)
def is_iterable_notstr(thing: Any) -> bool:
@@ -149,9 +149,9 @@ def is_iterable_notstr(thing: Any) -> bool:
return isinstance(thing, Iterable) and not isinstance(thing, str)
-def monotonic(L: Sequence) -> bool:
+def monotonic(seq: Sequence) -> bool:
"""Does this sequence increase monotonically?"""
- return all(b > a for a, b in zip(L, L[1:]))
+ return all(b > a for a, b in zip(seq, seq[1:]))
def page_number(input_file: os.PathLike) -> int:
@@ -166,7 +166,7 @@ def available_cpu_count() -> int:
except NotImplementedError:
pass
warnings.warn(
- "Could not get CPU count. Assuming one (1) CPU." "Use -j N to set manually."
+ "Could not get CPU count. Assuming one (1) CPU. Use -j N to set manually."
)
return 1
@@ -190,16 +190,16 @@ def is_file_writable(test_file: os.PathLike) -> bool:
os.W_OK,
effective_ids=(os.access in os.supports_effective_ids),
)
+
+ try:
+ fp = p.open('wb')
+ except OSError:
+ return False
else:
- try:
- fp = p.open('wb')
- except OSError:
- return False
- else:
- fp.close()
- with suppress(OSError):
- p.unlink()
- return True
+ fp.close()
+ with suppress(OSError):
+ p.unlink()
+ return True
except (OSError, RuntimeError) as e:
log.debug(e)
log.error(str(e))
diff --git a/src/ocrmypdf/hocrtransform.py b/src/ocrmypdf/hocrtransform.py
index 90895b4b..409aa689 100755
--- a/src/ocrmypdf/hocrtransform.py
+++ b/src/ocrmypdf/hocrtransform.py
@@ -1,44 +1,29 @@
#!/usr/bin/env python3
-#
-# Copyright (c) 2010, Jonathan Brinley
-# Original version from: https://github.com/jbrinley/HocrConverter
-#
-# Copyright (c) 2013-14, Julien Pfefferkorn
-# Modifications
-#
-# Copyright (c) 2015-16, James R. Barlow
-# Set text to transparent
-#
-# 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.
+# SPDX-FileCopyrightText: 2010 Jonathan Brinley
+# SPDX-FileCopyrightText: 2013-2014 Julien Pfefferkorn
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MIT
+
+"""Transform .hocr and page image to text PDF."""
+
+from __future__ import annotations
import argparse
import os
import re
+import warnings
from math import atan, cos, sin
from pathlib import Path
from typing import Any, NamedTuple, Optional, Tuple, Union
from xml.etree import ElementTree
-from reportlab.lib.colors import black, cyan, magenta, red
-from reportlab.lib.units import inch
-from reportlab.pdfgen.canvas import Canvas
+with warnings.catch_warnings():
+ warnings.filterwarnings(
+ 'ignore', category=DeprecationWarning, message=r".*load_module.*"
+ )
+ from reportlab.lib.colors import black, cyan, magenta, red
+ from reportlab.lib.units import inch
+ from reportlab.pdfgen.canvas import Canvas
# According to Wikipedia these languages are supported in the ISO-8859-1 character
# set, meaning reportlab can generate them and they are compatible with hocr,
@@ -99,7 +84,7 @@ HOCR_OK_LANGS = frozenset(
Element = ElementTree.Element
-class Rect(NamedTuple): # pylint: disable=inherit-non-class
+class Rect(NamedTuple):
"""A rectangle for managing PDF coordinates."""
x1: Any
@@ -109,7 +94,7 @@ class Rect(NamedTuple): # pylint: disable=inherit-non-class
class HocrTransformError(Exception):
- pass
+ """Error while applying hOCR transform."""
class HocrTransform:
@@ -132,7 +117,7 @@ class HocrTransform:
{'ff': 'ff', 'ffi': 'f‌f‌i', 'ffl': 'f‌f‌l', 'fi': 'fi', 'fl': 'fl'}
)
- def __init__(self, *, hocr_filename: Union[str, Path], dpi: float):
+ def __init__(self, *, hocr_filename: str | Path, dpi: float):
self.dpi = dpi
self.hocr = ElementTree.parse(os.fspath(hocr_filename))
@@ -196,7 +181,7 @@ class HocrTransform:
return out
@classmethod
- def baseline(cls, element: Element) -> Tuple[float, float]:
+ def baseline(cls, element: Element) -> tuple[float, float]:
"""
Returns a tuple containing the baseline slope and intercept.
"""
@@ -212,7 +197,7 @@ class HocrTransform:
"""
return Rect._make((c / self.dpi * inch) for c in pxl)
- def _child_xpath(self, html_tag: str, html_class: Optional[str] = None) -> str:
+ def _child_xpath(self, html_tag: str, html_class: str | None = None) -> str:
xpath = f".//{self.xmlns}{html_tag}"
if html_class:
xpath += f"[@class='{html_class}']"
@@ -239,7 +224,7 @@ class HocrTransform:
self,
*,
out_filename: Path,
- image_filename: Optional[Path] = None,
+ image_filename: Path | None = None,
show_bounding_boxes: bool = False,
fontname: str = "Helvetica",
invisible_text: bool = False,
@@ -287,7 +272,7 @@ class HocrTransform:
continue
pxl_coords = self.element_coordinates(elem)
- pt = self.pt_from_pixel(pxl_coords)
+ pt = self.pt_from_pixel(pxl_coords) # pylint: disable=invalid-name
# draw the bbox border
if show_bounding_boxes: # pragma: no cover
@@ -342,7 +327,7 @@ class HocrTransform:
def _do_line(
self,
pdf: Canvas,
- line: Optional[Element],
+ line: Element | None,
elemclass: str,
fontname: str,
invisible_text: bool,
diff --git a/src/ocrmypdf/optimize.py b/src/ocrmypdf/optimize.py
index ec9f8423..3f94bd62 100644
--- a/src/ocrmypdf/optimize.py
+++ b/src/ocrmypdf/optimize.py
@@ -1,9 +1,10 @@
-# © 2018 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/.
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
+"""Post-processing image optimization of OCR PDFs."""
+
+
+from __future__ import annotations
import logging
import sys
@@ -12,18 +13,7 @@ import threading
from collections import defaultdict
from os import fspath
from pathlib import Path
-from typing import (
- Callable,
- Dict,
- Iterator,
- List,
- MutableSet,
- NamedTuple,
- NewType,
- Optional,
- Sequence,
- Tuple,
-)
+from typing import Callable, Iterator, MutableSet, NamedTuple, NewType, Sequence
from zlib import compress
import img2pdf
@@ -55,7 +45,9 @@ DEFAULT_PNG_QUALITY = 70
Xref = NewType('Xref', int)
-class XrefExt(NamedTuple): # pylint: disable=inherit-non-class
+class XrefExt(NamedTuple):
+ """A PDF xref and image extension pair."""
+
xref: Xref
ext: str
@@ -74,7 +66,7 @@ def jpg_name(root: Path, xref: Xref) -> Path:
def extract_image_filter(
pike: Pdf, root: Path, image: Stream, xref: Xref
-) -> Optional[Tuple[PdfImage, Tuple[Name, Object]]]:
+) -> tuple[PdfImage, tuple[Name, Object]] | None:
del pike # unused args
del root
@@ -131,7 +123,7 @@ def extract_image_filter(
def extract_image_jbig2(
*, pike: Pdf, root: Path, image: Stream, xref: Xref, options
-) -> Optional[XrefExt]:
+) -> XrefExt | None:
del options # unused arg
result = extract_image_filter(pike, root, image, xref)
@@ -172,7 +164,7 @@ def extract_image_jbig2(
def extract_image_generic(
*, pike: Pdf, root: Path, image: Stream, xref: Xref, options
-) -> Optional[XrefExt]:
+) -> XrefExt | None:
result = extract_image_filter(pike, root, image, xref)
if result is None:
return None
@@ -236,8 +228,8 @@ def extract_images(
pike: Pdf,
root: Path,
options,
- extract_fn: Callable[..., Optional[XrefExt]],
-) -> Iterator[Tuple[int, XrefExt]]:
+ extract_fn: Callable[..., XrefExt | None],
+) -> Iterator[tuple[int, XrefExt]]:
"""Extract image using extract_fn
Enumerate images on each page, lookup their xref/ID number in the PDF.
@@ -266,7 +258,7 @@ def extract_images(
if image.objgen[1] != 0:
continue # Ignore images in an incremental PDF
xref = Xref(image.objgen[0])
- if hasattr(image, 'SMask'):
+ if Name.SMask in image:
# Ignore soft masks
smask_xref = Xref(image.SMask.objgen[0])
exclude_xrefs.add(smask_xref)
@@ -296,7 +288,7 @@ def extract_images(
def extract_images_generic(
pike: Pdf, root: Path, options
-) -> Tuple[List[Xref], List[Xref]]:
+) -> tuple[list[Xref], list[Xref]]:
"""Extract any >=2bpp image we think we can improve"""
jpegs = []
@@ -311,7 +303,7 @@ def extract_images_generic(
return jpegs, pngs
-def extract_images_jbig2(pike: Pdf, root: Path, options) -> Dict[int, List[XrefExt]]:
+def extract_images_jbig2(pike: Pdf, root: Path, options) -> dict[int, list[XrefExt]]:
"""Extract any bitonal image that we think we can improve as JBIG2"""
jbig2_groups = defaultdict(list)
@@ -324,11 +316,11 @@ def extract_images_jbig2(pike: Pdf, root: Path, options) -> Dict[int, List[XrefE
def _produce_jbig2_images(
- jbig2_groups: Dict[int, List[XrefExt]], root: Path, options, executor: Executor
+ jbig2_groups: dict[int, list[XrefExt]], root: Path, options, executor: Executor
) -> None:
"""Produce JBIG2 images from their groups"""
- def jbig2_group_args(root: Path, groups: Dict[int, List[XrefExt]]):
+ def jbig2_group_args(root: Path, groups: dict[int, list[XrefExt]]):
for group, xref_exts in groups.items():
prefix = f'group{group:08d}'
yield (
@@ -337,7 +329,7 @@ def _produce_jbig2_images(
prefix, # =out_prefix
)
- def jbig2_single_args(root, groups: Dict[int, List[XrefExt]]):
+ def jbig2_single_args(root, groups: dict[int, list[XrefExt]]):
for group, xref_exts in groups.items():
prefix = f'group{group:08d}'
# Second loop is to ensure multiple images per page are unpacked
@@ -372,7 +364,7 @@ def _produce_jbig2_images(
def convert_to_jbig2(
pike: Pdf,
- jbig2_groups: Dict[int, List[XrefExt]],
+ jbig2_groups: dict[int, list[XrefExt]],
root: Path,
options,
executor: Executor,
@@ -389,7 +381,7 @@ def convert_to_jbig2(
When the JBIG2 symbolic coder is not used, each JBIG2 stands on its own
and needs no dictionary. Currently this must be lossless JBIG2.
"""
- jbig2_globals_dict: Optional[Dictionary]
+ jbig2_globals_dict: Dictionary | None
_produce_jbig2_images(jbig2_groups, root, options, executor)
@@ -415,7 +407,7 @@ def convert_to_jbig2(
)
-def _optimize_jpeg(args: Tuple[Xref, Path, Path, int]) -> Tuple[Xref, Optional[Path]]:
+def _optimize_jpeg(args: tuple[Xref, Path, Path, int]) -> tuple[Xref, Path | None]:
xref, in_jpg, opt_jpg, jpeg_quality = args
with Image.open(in_jpg) as im:
@@ -431,13 +423,13 @@ def _optimize_jpeg(args: Tuple[Xref, Path, Path, int]) -> Tuple[Xref, Optional[P
def transcode_jpegs(
pike: Pdf, jpegs: Sequence[Xref], root: Path, options, executor: Executor
) -> None:
- def jpeg_args() -> Iterator[Tuple[Xref, Path, Path, int]]:
+ def jpeg_args() -> Iterator[tuple[Xref, Path, Path, int]]:
for xref in jpegs:
in_jpg = jpg_name(root, xref)
opt_jpg = in_jpg.with_suffix('.opt.jpg')
yield xref, in_jpg, opt_jpg, options.jpeg_quality
- def finish_jpeg(result: Tuple[Xref, Optional[Path]], pbar):
+ def finish_jpeg(result: tuple[Xref, Path | None], pbar):
xref, opt_jpg = result
if opt_jpg:
compdata = opt_jpg.read_bytes() # JPEG can inserted into PDF as is
@@ -462,11 +454,11 @@ def transcode_jpegs(
def _find_deflatable_jpeg(
*, pike: Pdf, root: Path, image: Stream, xref: Xref, options
-) -> Optional[XrefExt]:
+) -> XrefExt | None:
result = extract_image_filter(pike, root, image, xref)
if result is None:
return None
- pim, filtdp = result
+ _pim, filtdp = result
if filtdp[0] == Name.DCTDecode and not filtdp[1] and options.optimize >= 1:
return XrefExt(xref, '.memory')
@@ -474,7 +466,7 @@ def _find_deflatable_jpeg(
return None
-def _deflate_jpeg(args: Tuple[Pdf, threading.Lock, Xref, int]) -> Tuple[Xref, bytes]:
+def _deflate_jpeg(args: tuple[Pdf, threading.Lock, Xref, int]) -> tuple[Xref, bytes]:
pike, lock, xref, complevel = args
with lock:
xobj = pike.get_object(xref, 0)
@@ -621,11 +613,11 @@ def optimize(
context,
save_settings,
executor: Executor = DEFAULT_EXECUTOR,
-) -> None:
+) -> Path:
options = context.options
if options.optimize == 0:
safe_symlink(input_file, output_file)
- return
+ return output_file
if options.jpeg_quality == 0:
options.jpeg_quality = DEFAULT_JPEG_QUALITY if options.optimize < 3 else 40
@@ -660,9 +652,7 @@ def optimize(
f"Output file not created after optimizing. We probably ran "
f"out of disk space in the temporary folder: {tempfile.gettempdir()}."
)
- ratio = input_size / output_size
savings = 1 - output_size / input_size
- log.info(f"Optimize ratio: {ratio:.2f} savings: {(savings):.1%}")
if savings < 0:
log.info(
@@ -676,6 +666,8 @@ def optimize(
else:
safe_symlink(target_file, output_file)
+ return output_file
+
def main(infile, outfile, level, jobs=1):
from shutil import copy # pylint: disable=import-outside-toplevel
@@ -707,9 +699,9 @@ def main(infile, outfile, level, jobs=1):
jb2lossy=False,
)
- with TemporaryDirectory() as td:
- context = PdfContext(options, td, infile, None, None)
- tmpout = Path(td) / 'out.pdf'
+ with TemporaryDirectory() as tmpdir:
+ context = PdfContext(options, tmpdir, infile, None, None)
+ tmpout = Path(tmpdir) / 'out.pdf'
optimize(
infile,
tmpout,
diff --git a/src/ocrmypdf/pdfa.py b/src/ocrmypdf/pdfa.py
index 68b6f39a..8f84cfeb 100644
--- a/src/ocrmypdf/pdfa.py
+++ b/src/ocrmypdf/pdfa.py
@@ -1,22 +1,20 @@
-# © 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/.
-
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
"""
Utilities for PDF/A production and confirmation with Ghostspcript.
"""
+from __future__ import annotations
+
import base64
from pathlib import Path
-from typing import Dict, Iterator, Union
+from typing import Iterator
try:
- from importlib_resources import files as package_files
-except ImportError:
from importlib.resources import files as package_files
+except ImportError:
+ from importlib_resources import files as package_files # type: ignore
import pikepdf
@@ -25,7 +23,7 @@ SRGB_ICC_PROFILE_NAME = 'sRGB.icc'
def _postscript_objdef(
alias: str,
- dictionary: Dict[str, str],
+ dictionary: dict[str, str],
*,
stream_name: str = None,
stream_data: bytes = None,
@@ -97,7 +95,8 @@ def generate_pdfa_ps(target_filename: Path, icc: str = 'sRGB'):
target_filename: filename to save
icc: ICC identifier such as 'sRGB'
References:
- Adobe PDFMARK Reference: https://www.adobe.com/content/dam/acom/en/devnet/acrobat/pdfs/pdfmark_reference.pdf
+ Adobe PDFMARK Reference:
+ https://www.adobe.com/content/dam/acom/en/devnet/acrobat/pdfs/pdfmark_reference.pdf
"""
if icc != 'sRGB':
raise NotImplementedError("Only supporting sRGB")
@@ -105,11 +104,11 @@ def generate_pdfa_ps(target_filename: Path, icc: str = 'sRGB'):
bytes_icc_profile = (
package_files('ocrmypdf.data') / SRGB_ICC_PROFILE_NAME
).read_bytes()
- ps = '\n'.join(_make_postscript(icc, bytes_icc_profile, 3))
+ postscript = '\n'.join(_make_postscript(icc, bytes_icc_profile, 3))
# We should have encoded everything to pure ASCII by this point, and
# to be safe, only allow ASCII in PostScript
- Path(target_filename).write_text(ps, encoding='ascii')
+ Path(target_filename).write_text(postscript, encoding='ascii')
return target_filename
@@ -130,7 +129,7 @@ def file_claims_pdfa(filename: Path):
}
valid_part_conforms = {'1A', '1B', '2A', '2B', '2U', '3A', '3B', '3U'}
conformance = f'PDF/A-{pdfmeta.pdfa_status}'
- pdfa_dict: Dict[str, Union[str, bool]] = {}
+ pdfa_dict: dict[str, str | bool] = {}
if pdfmeta.pdfa_status in valid_part_conforms:
pdfa_dict['pass'] = True
pdfa_dict['output'] = 'pdfa'
diff --git a/src/ocrmypdf/pdfinfo/__init__.py b/src/ocrmypdf/pdfinfo/__init__.py
index 2c9a1be9..6b06ad35 100644
--- a/src/ocrmypdf/pdfinfo/__init__.py
+++ b/src/ocrmypdf/pdfinfo/__init__.py
@@ -1,9 +1,9 @@
#!/usr/bin/env python3
-# © 2015 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/.
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
+"""For extracting information about PDFs prior to OCR."""
+
+from __future__ import annotations
from ocrmypdf.pdfinfo.info import Colorspace, Encoding, PdfInfo
diff --git a/src/ocrmypdf/pdfinfo/info.py b/src/ocrmypdf/pdfinfo/info.py
index c63bfa03..1430af12 100644
--- a/src/ocrmypdf/pdfinfo/info.py
+++ b/src/ocrmypdf/pdfinfo/info.py
@@ -1,10 +1,10 @@
#!/usr/bin/env python3
-# © 2015 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/.
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
+"""Extract information about the content of a PDF."""
+
+from __future__ import annotations
import atexit
import logging
@@ -12,22 +12,20 @@ import re
from collections import defaultdict
from contextlib import ExitStack
from decimal import Decimal
-from enum import Enum
+from enum import Enum, auto
from functools import partial
from math import hypot, inf, isclose
from os import PathLike
from pathlib import Path
from typing import (
Container,
- Dict,
+ Iterable,
Iterator,
- List,
Mapping,
NamedTuple,
Optional,
Sequence,
Tuple,
- Union,
)
from warnings import warn
@@ -37,6 +35,7 @@ from pikepdf import (
PdfImage,
PdfInlineImage,
PdfMatrix,
+ UnsupportedImageTypeError,
parse_content_stream,
)
@@ -47,13 +46,41 @@ from ocrmypdf.pdfinfo.layout import get_page_analysis, get_text_boxes
logger = logging.getLogger()
-Colorspace = Enum('Colorspace', 'gray rgb cmyk lab icc index sep devn pattern jpeg2000')
-Encoding = Enum(
- 'Encoding', 'ccitt jpeg jpeg2000 jbig2 asciihex ascii85 lzw flate runlength'
-)
+class Colorspace(Enum):
+ """Description of common image colorspaces in a PDF."""
+
+ # pylint: disable=invalid-name
+ gray = auto()
+ rgb = auto()
+ cmyk = auto()
+ lab = auto()
+ icc = auto()
+ index = auto()
+ sep = auto()
+ devn = auto()
+ pattern = auto()
+ jpeg2000 = auto()
+
+
+class Encoding(Enum):
+ """Description of common image encodings in a PDF."""
-FRIENDLY_COLORSPACE: Dict[str, Colorspace] = {
+ # pylint: disable=invalid-name
+ ccitt = auto()
+ jpeg = auto()
+ jpeg2000 = auto()
+ jbig2 = auto()
+ asciihex = auto()
+ ascii85 = auto()
+ lzw = auto()
+ flate = auto()
+ runlength = auto()
+
+
+FloatRect = Tuple[float, float, float, float]
+
+FRIENDLY_COLORSPACE: dict[str, Colorspace] = {
'/DeviceGray': Colorspace.gray,
'/CalGray': Colorspace.gray,
'/DeviceRGB': Colorspace.rgb,
@@ -71,7 +98,7 @@ FRIENDLY_COLORSPACE: Dict[str, Colorspace] = {
'/I': Colorspace.index,
}
-FRIENDLY_ENCODING: Dict[str, Encoding] = {
+FRIENDLY_ENCODING: dict[str, Encoding] = {
'/CCITTFaxDecode': Encoding.ccitt,
'/DCTDecode': Encoding.jpeg,
'/JPXDecode': Encoding.jpeg2000,
@@ -85,7 +112,7 @@ FRIENDLY_ENCODING: Dict[str, Encoding] = {
'/RL': Encoding.runlength,
}
-FRIENDLY_COMP: Dict[Colorspace, int] = {
+FRIENDLY_COMP: dict[Colorspace, int] = {
Colorspace.gray: 1,
Colorspace.rgb: 3,
Colorspace.cmyk: 4,
@@ -104,37 +131,45 @@ def _is_unit_square(shorthand):
class XobjectSettings(NamedTuple):
+ """Info about an XObject found in a PDF."""
+
name: str
- shorthand: Tuple[float, float, float, float, float, float]
+ shorthand: tuple[float, float, float, float, float, float]
stack_depth: int
class InlineSettings(NamedTuple):
+ """Info about an inline image found in a PDF."""
+
iimage: PdfInlineImage
- shorthand: Tuple[float, float, float, float, float, float]
+ shorthand: tuple[float, float, float, float, float, float]
stack_depth: int
class ContentsInfo(NamedTuple):
- xobject_settings: List[XobjectSettings]
- inline_images: List[InlineSettings]
+ """Info about various objects found in a PDF."""
+
+ xobject_settings: list[XobjectSettings]
+ inline_images: list[InlineSettings]
found_vector: bool
found_text: bool
- name_index: Mapping[str, List[XobjectSettings]]
+ name_index: Mapping[str, list[XobjectSettings]]
class TextboxInfo(NamedTuple):
- bbox: Tuple[float, float, float, float]
+ """Info about a text box found in a PDF."""
+
+ bbox: tuple[float, float, float, float]
is_visible: bool
is_corrupt: bool
class VectorMarker:
- pass
+ """Sentinel indicating vector drawing operations were found on a page."""
class TextMarker:
- pass
+ """Sentinel indicating text drawing operations were found on a page."""
def _normalize_stack(graphobjs):
@@ -177,8 +212,8 @@ def _interpret_contents(contentstream: Object, initial_shorthand=UNIT_SQUARE):
stack = []
ctm = PdfMatrix(initial_shorthand)
- xobject_settings: List[XobjectSettings] = []
- inline_images: List[InlineSettings] = []
+ xobject_settings: list[XobjectSettings] = []
+ inline_images: list[InlineSettings] = []
name_index = defaultdict(lambda: [])
found_vector = False
found_text = False
@@ -196,7 +231,7 @@ def _interpret_contents(contentstream: Object, initial_shorthand=UNIT_SQUARE):
if len(stack) > 32: # See docstring
if len(stack) > 128:
raise RuntimeError(
- "PDF graphics stack overflowed hard limit, operator %i" % n
+ f"PDF graphics stack overflowed hard limit at operator {n}"
)
warn("PDF graphics stack overflowed spec limit")
elif operator == 'Q':
@@ -282,7 +317,7 @@ def _get_dpi(ctm_shorthand, image_size) -> Resolution:
"""
- a, b, c, d, _, _ = ctm_shorthand
+ a, b, c, d, _, _ = ctm_shorthand # pylint: disable=invalid-name
# Calculate the width and height of the image in PDF units
image_drawn = hypot(a, b), hypot(c, d)
@@ -298,23 +333,25 @@ def _get_dpi(ctm_shorthand, image_size) -> Resolution:
class ImageInfo:
+ """Information about an image found in a PDF."""
+
DPI_PREC = Decimal('1.000')
- _comp: Optional[int]
+ _comp: int | None
_name: str
def __init__(
self,
*,
name='',
- pdfimage: Optional[Object] = None,
- inline: Optional[PdfInlineImage] = None,
+ pdfimage: Object | None = None,
+ inline: PdfInlineImage | None = None,
shorthand=None,
):
self._name = str(name)
self._shorthand = shorthand
- pim: Union[PdfInlineImage, PdfImage]
+ pim: PdfInlineImage | PdfImage
if inline is not None:
self._origin = 'inline'
@@ -350,13 +387,20 @@ class ImageInfo:
if self._color == Colorspace.icc:
# Check the ICC profile to determine actual colorspace
- pim_icc = pim.icc
- if pim_icc.profile.xcolor_space == 'GRAY':
- self._comp = 1
- elif pim_icc.profile.xcolor_space == 'CMYK':
- self._comp = 4
- else:
- self._comp = 3
+ try:
+ pim_icc = pim.icc
+ if pim_icc.profile.xcolor_space == 'GRAY':
+ self._comp = 1
+ elif pim_icc.profile.xcolor_space == 'CMYK':
+ self._comp = 4
+ else:
+ self._comp = 3
+ except (AttributeError, UnsupportedImageTypeError) as ex:
+ self._comp = None
+ logger.warning(
+ f"An image with a corrupt or unreadable ICC profile was found. "
+ f"The output PDF may not match the input PDF visually: {ex}. {self}"
+ )
else:
if isinstance(self._color, Colorspace):
self._comp = FRIENDLY_COMP.get(self._color)
@@ -409,15 +453,10 @@ class ImageInfo:
return _get_dpi(self._shorthand, (self._width, self._height))
def __repr__(self):
- class_locals = {
- attr: getattr(self, attr, None)
- for attr in dir(self)
- if not attr.startswith('_')
- }
return (
- "<ImageInfo '{name}' {type_} {width}x{height} {color} "
- "{comp} {bpc} {enc} {dpi}>"
- ).format(**class_locals)
+ f"<ImageInfo '{self.name}' {self.type_} {self.width}x{self.height} "
+ f"{self.color} {self.comp} {self.bpc} {self.enc} {self.dpi}>"
+ )
def _find_inline_images(contentsinfo: ContentsInfo) -> Iterator[ImageInfo]:
@@ -425,11 +464,11 @@ def _find_inline_images(contentsinfo: ContentsInfo) -> Iterator[ImageInfo]:
for n, inline in enumerate(contentsinfo.inline_images):
yield ImageInfo(
- name='inline-%02d' % n, shorthand=inline.shorthand, inline=inline.iimage
+ name=f'inline-{n:02d}', shorthand=inline.shorthand, inline=inline.iimage
)
-def _image_xobjects(container) -> Iterator[Tuple[Object, str]]:
+def _image_xobjects(container) -> Iterator[tuple[Object, str]]:
"""Search for all XObject-based images in the container
Usually the container is a page, but it could also be a Form XObject
@@ -517,7 +556,7 @@ def _find_form_xobject_images(pdf: Pdf, container: Object, contentsinfo: Content
def _process_content_streams(
*, pdf: Pdf, container: Object, shorthand=None
-) -> Iterator[Union[VectorMarker, TextMarker, ImageInfo]]:
+) -> Iterator[VectorMarker | TextMarker | ImageInfo]:
"""Find all individual instances of images drawn in the container
Usually the container is a page, but it may also be a Form XObject.
@@ -566,10 +605,10 @@ def _process_content_streams(
yield from _find_form_xobject_images(pdf, container, contentsinfo)
-def _page_has_text(text_blocks, page_width, page_height) -> bool:
+def _page_has_text(text_blocks: Iterable[FloatRect], page_width, page_height) -> bool:
"""Smarter text detection that ignores text in margins"""
- pw, ph = float(page_width), float(page_height)
+ pw, ph = float(page_width), float(page_height) # pylint: disable=invalid-name
margin_ratio = 0.125
interior_bbox = (
@@ -579,7 +618,7 @@ def _page_has_text(text_blocks, page_width, page_height) -> bool:
margin_ratio * ph, # bottom (first quadrant: bottom < top)
)
- def rects_intersect(a, b) -> bool:
+ def rects_intersect(a: FloatRect, b: FloatRect) -> bool:
"""
Where (a,b) are 4-tuple rects (left-0, top-1, right-2, bottom-3)
https://stackoverflow.com/questions/306316/determine-if-two-rectangles-overlap-each-other
@@ -601,19 +640,19 @@ def simplify_textboxes(miner, textbox_getter) -> Iterator[TextboxInfo]:
We do this to save memory and ensure that our objects are pickleable.
"""
for box in textbox_getter(miner):
- first_line = box._objs[0]
- first_char = first_line._objs[0]
+ first_line = box._objs[0] # pylint: disable=protected-access
+ first_char = first_line._objs[0] # pylint: disable=protected-access
visible = first_char.rendermode != 3
corrupt = first_char.get_text() == '\ufffd'
yield TextboxInfo(box.bbox, visible, corrupt)
-worker_pdf = None
+worker_pdf = None # pylint: disable=invalid-name
def _pdf_pageinfo_sync_init(pdf: Pdf, infile: Path, pdfminer_loglevel):
- global worker_pdf # pylint: disable=global-statement
+ global worker_pdf # pylint: disable=global-statement,invalid-name
pikepdf_enable_mmap()
logging.getLogger('pdfminer').setLevel(pdfminer_loglevel)
@@ -647,8 +686,8 @@ def _pdf_pageinfo_concurrent(
max_workers,
check_pages,
detailed_analysis=False,
-) -> Sequence[Optional['PageInfo']]:
- pages: Sequence[Optional['PageInfo']] = [None] * len(pdf.pages)
+) -> Sequence[PageInfo | None]:
+ pages: Sequence[PageInfo | None] = [None] * len(pdf.pages)
def update_pageinfo(result, pbar):
page = result
@@ -698,9 +737,11 @@ def _pdf_pageinfo_concurrent(
class PageInfo:
- _has_text: Optional[bool]
- _has_vector: Optional[bool]
- _images: List[ImageInfo]
+ """Information about type of contents on each page in a PDF."""
+
+ _has_text: bool | None
+ _has_vector: bool | None
+ _images: list[ImageInfo]
def __init__(
self,
@@ -759,15 +800,15 @@ class PageInfo:
self._has_vector = False
self._has_text = False
self._images = []
- for ci in _process_content_streams(
+ for info in _process_content_streams(
pdf=pdf, container=page, shorthand=userunit_shorthand
):
- if isinstance(ci, VectorMarker):
+ if isinstance(info, VectorMarker):
self._has_vector = True
- elif isinstance(ci, TextMarker):
+ elif isinstance(info, TextMarker):
self._has_text = True
- elif isinstance(ci, ImageInfo):
- self._images.append(ci)
+ elif isinstance(info, ImageInfo):
+ self._images.append(info)
else:
raise NotImplementedError()
else:
@@ -833,9 +874,7 @@ class PageInfo:
def images(self):
return self._images
- def get_textareas(
- self, visible: Optional[bool] = None, corrupt: Optional[bool] = None
- ):
+ def get_textareas(self, visible: bool | None = None, corrupt: bool | None = None):
def predicate(obj, want_visible, want_corrupt):
result = True
if want_visible is not None:
@@ -919,7 +958,7 @@ class PdfInfo:
self._has_acroform = True
@property
- def pages(self) -> Sequence[Optional[PageInfo]]:
+ def pages(self) -> Sequence[PageInfo | None]:
return self._pages
@property
@@ -936,7 +975,7 @@ class PdfInfo:
return self._has_acroform
@property
- def filename(self) -> Union[str, Path]:
+ def filename(self) -> str | Path:
if not isinstance(self._infile, (str, Path)):
raise NotImplementedError("can't get filename from stream")
return self._infile
diff --git a/src/ocrmypdf/pdfinfo/layout.py b/src/ocrmypdf/pdfinfo/layout.py
index bf8d7c30..3b94c8f9 100644
--- a/src/ocrmypdf/pdfinfo/layout.py
+++ b/src/ocrmypdf/pdfinfo/layout.py
@@ -1,9 +1,6 @@
-# © 2018 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/.
-
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
+from __future__ import annotations
import re
from math import copysign
diff --git a/src/ocrmypdf/pluginspec.py b/src/ocrmypdf/pluginspec.py
index 9db079e2..c3298e4c 100644
--- a/src/ocrmypdf/pluginspec.py
+++ b/src/ocrmypdf/pluginspec.py
@@ -1,19 +1,19 @@
-# © 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/.
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
+"""OCRmyPDF pluggy plugin specification."""
+
+from __future__ import annotations
from abc import ABC, abstractmethod
from argparse import ArgumentParser, Namespace
from logging import Handler
from pathlib import Path
-from typing import TYPE_CHECKING, AbstractSet, List, NamedTuple, Optional
+from typing import TYPE_CHECKING, AbstractSet, NamedTuple, Sequence
import pluggy
-from ocrmypdf._concurrent import Executor
+from ocrmypdf import Executor, PdfContext
from ocrmypdf.helpers import Resolution
if TYPE_CHECKING:
@@ -43,6 +43,33 @@ def get_logging_console() -> Handler:
@hookspec
+def initialize(plugin_manager: pluggy.PluginManager):
+ """Called when this plugin is first loaded into OCRmyPDF.
+
+ The primary intended use of this is for plugins to check compatibility with other
+ plugins and possibly block other blocks, a plugin that wishes to block ocrmypdf's
+ built-in optimize plugin could do:
+
+ .. code-block::
+
+ plugin_manager.set_blocked('ocrmypdf.builtin_plugins.optimize')
+
+ It would also be reasonable for an plugin implementation to check if it is unable
+ to proceed, for example, because a required dependency is missing. (If the plugin's
+ ability to proceed depends on options and arguments, use ``validate`` instead.)
+
+ Raises:
+ ocrmypdf.exceptions.ExitCodeException: If options are not acceptable
+ and the application should terminate gracefully with an informative
+ message and error code.
+
+ Note:
+ This hook will be called from the main process, and may modify global state
+ before child worker processes are forked.
+ """
+
+
+@hookspec
def add_options(parser: ArgumentParser) -> None:
"""Allows the plugin to add its own command line and API arguments.
@@ -141,7 +168,7 @@ def get_progressbar_class():
@hookspec
-def validate(pdfinfo: 'PdfInfo', options: Namespace) -> None:
+def validate(pdfinfo: PdfInfo, options: Namespace) -> None:
"""Called to give a plugin an opportunity to review *options* and *pdfinfo*.
*options* contains the "work order" to process a particular file. *pdfinfo*
@@ -167,8 +194,8 @@ def rasterize_pdf_page(
raster_device: str,
raster_dpi: Resolution,
pageno: int,
- page_dpi: Optional[Resolution],
- rotation: Optional[int],
+ page_dpi: Resolution | None,
+ rotation: int | None,
filter_vector: bool,
) -> Path:
"""Rasterize one page of a PDF at resolution raster_dpi in canvas units.
@@ -197,7 +224,7 @@ def rasterize_pdf_page(
@hookspec(firstresult=True)
-def filter_ocr_image(page: 'PageContext', image: 'Image.Image') -> 'Image.Image':
+def filter_ocr_image(page: PageContext, image: Image.Image) -> Image.Image:
"""Called to filter the image before it is sent to OCR.
This is the image that OCR sees, not what the user sees when they view the
@@ -224,7 +251,7 @@ def filter_ocr_image(page: 'PageContext', image: 'Image.Image') -> 'Image.Image'
@hookspec(firstresult=True)
-def filter_page_image(page: 'PageContext', image_filename: Path) -> Path:
+def filter_page_image(page: PageContext, image_filename: Path) -> Path:
"""Called to filter the whole page before it is inserted into the PDF.
A whole page image is only produced when preprocessing command line arguments
@@ -264,9 +291,7 @@ def filter_page_image(page: 'PageContext', image_filename: Path) -> Path:
@hookspec(firstresult=True)
-def filter_pdf_page(
- page: 'PageContext', image_filename: Path, output_pdf: Path
-) -> Path:
+def filter_pdf_page(page: PageContext, image_filename: Path, output_pdf: Path) -> Path:
"""Called to convert a filtered whole page image into a PDF.
A whole page image is only produced when preprocessing command line arguments
@@ -409,7 +434,7 @@ def get_ocr_engine() -> OcrEngine:
@hookspec(firstresult=True)
def generate_pdfa(
- pdf_pages: List[Path],
+ pdf_pages: list[Path],
pdfmark: Path,
output_file: Path,
compression: str,
@@ -456,3 +481,63 @@ def generate_pdfa(
See also:
https://github.com/tqdm/tqdm
"""
+
+
+@hookspec(firstresult=True)
+def optimize_pdf(
+ input_pdf: Path,
+ output_pdf: Path,
+ context: PdfContext,
+ executor: Executor,
+ linearize: bool,
+) -> tuple[Path, Sequence[str]]:
+ """Optimize a PDF after image, OCR and metadata processing.
+
+ If the input_pdf is a PDF/A, the plugin should modify input_pdf in a way
+ that preserves the PDF/A status, or report to the user when this is not possible.
+
+ If the implementation fails to produce a smaller file than the input file, it
+ should return input_pdf instead.
+
+ A plugin that implements a new optimizer may need to suppress the built-in
+ optimizer by implementing an ``initialize`` hook.
+
+ Arguments:
+ input_pdf: The input PDF, which has OCR added.
+ output_pdf: The requested filename of the output PDF which should be created
+ by this optimization hook.
+ context: The current context.
+ executor: An initialized executor which may be used during optimization,
+ to distribute optimization tasks.
+ linearize: If True, OCRmyPDF requires ``optimize_pdf`` to return a linearized,
+ also known as fast web view PDF.
+
+ Returns:
+ Path: If optimization is successful, the hook should return ``output_file``.
+ If optimization does not produce a smaller file, the hook should return
+ ``input_file``.
+ Sequence[str]: Any comments that the plugin wishes to report to the user,
+ especially reasons it was not able to further optimize the file. For
+ example, the plugin could report that a required third party was not
+ installed, so a specific optimization was not attempted.
+
+ Note:
+ This is a :ref:`firstresult hook<firstresult>`.
+ """
+
+
+@hookspec(firstresult=True)
+def is_optimization_enabled(context: PdfContext) -> bool:
+ """For a given PdfContext, OCRmyPDF asks the plugin if optimization is enabled.
+
+ An optimization plugin might be installed and active but could be disabled by
+ user settings.
+
+ If this returns False, OCRmyPDF will take certain actions to finalize the PDF.
+
+ Returns:
+ True if the plugin's optimization is enabled.
+
+ Note:
+ This is a :ref:`firstresult hook<firstresult>`.
+ """
diff --git a/src/ocrmypdf/py.typed b/src/ocrmypdf/py.typed
index 0a417894..039efdca 100644
--- a/src/ocrmypdf/py.typed
+++ b/src/ocrmypdf/py.typed
@@ -1 +1,3 @@
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
# ocrmypdf is typed
diff --git a/src/ocrmypdf/quality.py b/src/ocrmypdf/quality.py
index dab816b0..8cc48249 100644
--- a/src/ocrmypdf/quality.py
+++ b/src/ocrmypdf/quality.py
@@ -1,13 +1,11 @@
-# © 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/.
-
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
"""Utilities to measure OCR quality"""
+from __future__ import annotations
+
import re
from typing import Iterable
diff --git a/src/ocrmypdf/subprocess/__init__.py b/src/ocrmypdf/subprocess/__init__.py
index 4ba85c14..b33597e2 100644
--- a/src/ocrmypdf/subprocess/__init__.py
+++ b/src/ocrmypdf/subprocess/__init__.py
@@ -1,22 +1,19 @@
-# © 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/.
-
-
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
"""Wrappers to manage subprocess calls"""
+from __future__ import annotations
+
import logging
import os
import re
import sys
-from collections.abc import Mapping
from contextlib import suppress
from functools import lru_cache
+from pathlib import Path
from subprocess import PIPE, STDOUT, CalledProcessError, CompletedProcess, Popen
from subprocess import run as subprocess_run
-from typing import Callable, Optional, Type, Union
+from typing import Callable, Mapping, Sequence, Union
from packaging.version import Version
@@ -26,9 +23,17 @@ from ocrmypdf.exceptions import MissingDependencyError
log = logging.getLogger(__name__)
+Args = Sequence[Union[Path, str]]
+OsEnviron = os._Environ # pylint: disable=protected-access
+
def run(
- args, *, env=None, logs_errors_to_stdout: bool = False, **kwargs
+ args: Args,
+ *,
+ env: OsEnviron | None = None,
+ logs_errors_to_stdout: bool = False,
+ check: bool = False,
+ **kwargs,
) -> CompletedProcess:
"""Wrapper around :py:func:`subprocess.run`
@@ -50,7 +55,7 @@ def run(
stderr = None
stderr_name = 'stderr' if not logs_errors_to_stdout else 'stdout'
try:
- proc = subprocess_run(args, env=env, **kwargs)
+ proc = subprocess_run(args, env=env, check=check, **kwargs)
except CalledProcessError as e:
stderr = getattr(e, stderr_name, None)
raise
@@ -68,7 +73,12 @@ def run(
def run_polling_stderr(
- args, *, callback: Callable[[str], None], check: bool = False, env=None, **kwargs
+ args: Args,
+ *,
+ callback: Callable[[str], None],
+ check: bool = False,
+ env: OsEnviron | None = None,
+ **kwargs,
) -> CompletedProcess:
"""Run a process like ``ocrmypdf.subprocess.run``, and poll stderr.
@@ -101,7 +111,9 @@ def run_polling_stderr(
return CompletedProcess(args, proc.returncode, None, stderr=stderr)
-def _fix_process_args(args, env, kwargs):
+def _fix_process_args(
+ args: Args, env: OsEnviron | None, kwargs
+) -> tuple[Args, OsEnviron, logging.Logger, bool]:
assert 'universal_newlines' not in kwargs, "Use text= instead of universal_newlines"
if not env:
@@ -110,21 +122,26 @@ def _fix_process_args(args, env, kwargs):
# Search in spoof path if necessary
program = str(args[0])
- if os.name == 'nt':
+ if sys.platform == 'win32':
+ # pylint: disable=import-outside-toplevel
from ocrmypdf.subprocess._windows import fix_windows_args
args = fix_windows_args(program, args, env)
log.debug("Running: %s", args)
process_log = log.getChild(os.path.basename(program))
- text = kwargs.get('text', False)
+ text = bool(kwargs.get('text', False))
return args, env, process_log, text
@lru_cache(maxsize=None)
def get_version(
- program: str, *, version_arg: str = '--version', regex=r'(\d+(\.\d+)*)', env=None
+ program: str,
+ *,
+ version_arg: str = '--version',
+ regex=r'(\d+(\.\d+)*)',
+ env: OsEnviron | None = None,
) -> str:
"""Get the version of the specified program
@@ -171,59 +188,59 @@ def get_version(
return version
-missing_program = '''
+MISSING_PROGRAM = '''
The program '{program}' could not be executed or was not found on your
system PATH.
'''
-missing_optional_program = '''
+MISSING_OPTIONAL_PROGRAM = '''
The program '{program}' could not be executed or was not found on your
system PATH. This program is required when you use the
{required_for} arguments. You could try omitting these arguments, or install
the package.
'''
-missing_recommend_program = '''
+MISSING_RECOMMEND_PROGRAM = '''
The program '{program}' could not be executed or was not found on your
system PATH. This program is recommended when using the {required_for} arguments,
but not required, so we will proceed. For best results, install the program.
'''
-old_version = '''
+OLD_VERSION = '''
OCRmyPDF requires '{program}' {need_version} or higher. Your system appears
to have {found_version}. Please update this program.
'''
-old_version_required_for = '''
+OLD_VERSION_REQUIRED_FOR = '''
OCRmyPDF requires '{program}' {need_version} or higher when run with the
{required_for} arguments. If you omit these arguments, OCRmyPDF may be able to
proceed. For best results, install the program.
'''
-osx_install_advice = '''
+OSX_INSTALL_ADVICE = '''
If you have homebrew installed, try these command to install the missing
package:
brew install {package}
'''
-linux_install_advice = '''
+LINUX_INSTALL_ADVICE = '''
On systems with the aptitude package manager (Debian, Ubuntu), try these
commands:
- sudo apt-get update
- sudo apt-get install {package}
+ sudo apt update
+ sudo apt install {package}
-On RPM-based systems (Red Hat, Fedora), search for instructions on
-installing the RPM for {program}.
+On RPM-based systems (Red Hat, Fedora), try this command:
+ sudo dnf install {package}
'''
-windows_install_advice = '''
+WINDOWS_INSTALL_ADVICE = '''
If not already installed, install the Chocolatey package manager. Then use
a command prompt to install the missing package:
choco install {package}
'''
-def _get_platform():
+def _get_platform() -> str:
if sys.platform.startswith('freebsd'):
return 'freebsd'
elif sys.platform.startswith('linux'):
@@ -233,46 +250,66 @@ def _get_platform():
return sys.platform
-def _error_trailer(program, package, **kwargs):
+def _error_trailer(program: str, package: str | Mapping[str, str], **kwargs) -> None:
+ del kwargs
if isinstance(package, Mapping):
package = package.get(_get_platform(), program)
if _get_platform() == 'darwin':
- log.info(osx_install_advice.format(**locals()))
+ log.info(OSX_INSTALL_ADVICE.format(**locals()))
elif _get_platform() == 'linux':
- log.info(linux_install_advice.format(**locals()))
+ log.info(LINUX_INSTALL_ADVICE.format(**locals()))
elif _get_platform() == 'windows':
- log.info(windows_install_advice.format(**locals()))
+ log.info(WINDOWS_INSTALL_ADVICE.format(**locals()))
-def _error_missing_program(program, package, required_for, recommended):
+def _error_missing_program(
+ program: str, package: str, required_for: str | None, recommended: bool
+) -> None:
+ # pylint: disable=unused-argument
if recommended:
- log.warning(missing_recommend_program.format(**locals()))
+ log.warning(MISSING_RECOMMEND_PROGRAM.format(**locals()))
elif required_for:
- log.error(missing_optional_program.format(**locals()))
+ log.error(MISSING_OPTIONAL_PROGRAM.format(**locals()))
else:
- log.error(missing_program.format(**locals()))
+ log.error(MISSING_PROGRAM.format(**locals()))
_error_trailer(**locals())
-def _error_old_version(program, package, need_version, found_version, required_for):
+def _error_old_version(
+ program: str,
+ package: str,
+ need_version: str,
+ found_version: str,
+ required_for: str | None,
+) -> None:
+ # pylint: disable=unused-argument
if required_for:
- log.error(old_version_required_for.format(**locals()))
+ log.error(OLD_VERSION_REQUIRED_FOR.format(**locals()))
else:
- log.error(old_version.format(**locals()))
+ log.error(OLD_VERSION.format(**locals()))
_error_trailer(**locals())
+def _remove_leading_v(s: str) -> str:
+ if sys.version_info >= (3, 9):
+ return s.removeprefix('v')
+
+ if s.startswith('v'):
+ return s[1:]
+ return s
+
+
def check_external_program(
*,
program: str,
package: str,
- version_checker: Callable,
+ version_checker: Callable[[], str],
need_version: str,
- required_for: Optional[str] = None,
- recommended=False,
- version_parser: Type[Version] = Version,
-):
+ required_for: str | None = None,
+ recommended: bool = False,
+ version_parser: type[Version] = Version,
+) -> None:
"""Check for required version of external program and raise exception if not.
Args:
@@ -294,19 +331,19 @@ def check_external_program(
found_version = version_checker()
else: # deprecated
found_version = version_checker
- except (CalledProcessError, FileNotFoundError, MissingDependencyError):
+ except (CalledProcessError, FileNotFoundError) as e:
_error_missing_program(program, package, required_for, recommended)
if not recommended:
- raise MissingDependencyError(program)
+ raise MissingDependencyError(program) from e
+ return
+ except MissingDependencyError:
+ _error_missing_program(program, package, required_for, recommended)
+ if not recommended:
+ raise
return
- def remove_leading_v(s):
- if s.startswith('v'):
- return s[1:]
- return s
-
- found_version = remove_leading_v(found_version)
- need_version = remove_leading_v(need_version)
+ found_version = _remove_leading_v(found_version)
+ need_version = _remove_leading_v(need_version)
if found_version and version_parser(found_version) < version_parser(need_version):
_error_old_version(program, package, need_version, found_version, required_for)
diff --git a/src/ocrmypdf/subprocess/_windows.py b/src/ocrmypdf/subprocess/_windows.py
index d6a9d63b..1fc98971 100644
--- a/src/ocrmypdf/subprocess/_windows.py
+++ b/src/ocrmypdf/subprocess/_windows.py
@@ -1,11 +1,8 @@
-# © 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/.
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
+"""Find Tesseract and Ghostscript binaries on Windows using the registry."""
-# type: ignore
-# Non-Windows mypy now breaks when trying to typecheck winreg
+from __future__ import annotations
import logging
import os
@@ -13,12 +10,26 @@ import shutil
import sys
from itertools import chain
from pathlib import Path
-from typing import Any, Callable, Iterable, Iterator, Set, Tuple, TypeVar
+from typing import Any, Callable, Iterable, Iterator, TypeVar
-try:
- import winreg
-except ModuleNotFoundError as e:
- raise ModuleNotFoundError("This module is for Windows only") from e
+if sys.version_info >= (3, 10):
+ from typing import TypeAlias
+else:
+ from typing_extensions import TypeAlias # pragma: no cover
+
+if sys.platform == 'win32':
+ # mypy understands 'if sys.platform' better than try/except ModuleNotFoundError
+ import winreg # pylint: disable=import-error
+
+ HKEYType: TypeAlias = winreg.HKEYType
+else:
+ from unittest.mock import Mock
+
+ winreg = Mock(
+ spec=['HKEYType', 'EnumKey', 'EnumValue', 'HKEY_LOCAL_MACHINE', 'OpenKey']
+ )
+ # mypy does not understand winreg.HKeyType where winreg is a Mock (fair enough!)
+ HKEYType: TypeAlias = Any
log = logging.getLogger(__name__)
@@ -26,7 +37,7 @@ log = logging.getLogger(__name__)
T = TypeVar('T')
-def ghostscript_version_key(s: str) -> Tuple[int, int, int]:
+def ghostscript_version_key(s: str) -> tuple[int, int, int]:
"""Compare Ghostscript version numbers."""
try:
release = [int(elem) for elem in s.split('.', maxsplit=3)]
@@ -37,30 +48,29 @@ def ghostscript_version_key(s: str) -> Tuple[int, int, int]:
return (0, 0, 0)
-def registry_enum(
- key: winreg.HKEYType, enum_fn: Callable[[winreg.HKEYType, int], T]
-) -> Iterator[T]:
- LIMIT = 999
+def registry_enum(key: HKEYType, enum_fn: Callable[[HKEYType, int], T]) -> Iterator[T]:
+ limit = 999
n = 0
- while n < LIMIT:
+ while n < limit:
try:
yield enum_fn(key, n)
n += 1
except OSError:
break
- if n == LIMIT:
+ if n == limit:
raise ValueError(f"Too many registry keys under {key}")
-def registry_subkeys(key: winreg.HKEYType) -> Iterator[str]:
+def registry_subkeys(key: HKEYType) -> Iterator[str]:
return registry_enum(key, winreg.EnumKey)
-def registry_values(key: winreg.HKEYType) -> Iterator[Tuple[str, Any, int]]:
+def registry_values(key: HKEYType) -> Iterator[tuple[str, Any, int]]:
return registry_enum(key, winreg.EnumValue)
def registry_path_ghostscript(env=None) -> Iterator[Path]:
+ del env # unused (but needed for protocol)
try:
with winreg.OpenKey(
winreg.HKEY_LOCAL_MACHINE, r"SOFTWARE\Artifex\GPL Ghostscript"
@@ -71,13 +81,14 @@ def registry_path_ghostscript(env=None) -> Iterator[Path]:
with winreg.OpenKey(
winreg.HKEY_LOCAL_MACHINE, fr"SOFTWARE\Artifex\GPL Ghostscript\{latest_gs}"
) as k:
- _, gs_path, _ = next(registry_values(k))
- yield Path(gs_path) / 'bin'
+ for _, gs_path, _ in registry_values(k):
+ yield Path(gs_path) / 'bin'
except OSError as e:
log.warning(e)
def registry_path_tesseract(env=None) -> Iterator[Path]:
+ del env # unused (but needed for protocol)
try:
with winreg.OpenKey(winreg.HKEY_LOCAL_MACHINE, r"SOFTWARE\Tesseract-OCR") as k:
for subkey, val, _valtype in registry_values(k):
@@ -157,7 +168,7 @@ def unique_everseen(iterable: Iterable[T], key: Callable[[T], T]) -> Iterator[T]
"List unique elements, preserving order."
# unique_everseen('AAAABBBCCDAABBB') --> A B C D
# unique_everseen('ABBCcAD', str.lower) --> A B C D
- seen: Set[T] = set()
+ seen: set[T] = set()
seen_add = seen.add
for element in iterable:
k = key(element)
diff --git a/tests/__init__.py b/tests/__init__.py
index f714d74d..7b419d3f 100644
--- a/tests/__init__.py
+++ b/tests/__init__.py
@@ -1,7 +1,4 @@
-# © 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/.
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
-# Empty __init__.py file
+from __future__ import annotations
diff --git a/tests/cache/francais/__-l__deu__000001_ocr.png__000001_ocr_tess__pdf__txt/pdf.bin b/tests/cache/francais/__-l__deu__000001_ocr.png__000001_ocr_tess__pdf__txt/pdf.bin
new file mode 100644
index 00000000..937ee885
--- /dev/null
+++ b/tests/cache/francais/__-l__deu__000001_ocr.png__000001_ocr_tess__pdf__txt/pdf.bin
Binary files differ
diff --git a/tests/cache/francais/__-l__deu__000001_ocr.png__000001_ocr_tess__pdf__txt/stderr.bin b/tests/cache/francais/__-l__deu__000001_ocr.png__000001_ocr_tess__pdf__txt/stderr.bin
new file mode 100644
index 00000000..16b617e5
--- /dev/null
+++ b/tests/cache/francais/__-l__deu__000001_ocr.png__000001_ocr_tess__pdf__txt/stderr.bin
@@ -0,0 +1 @@
+Tesseract Open Source OCR Engine v4.1.1 with Leptonica
diff --git a/tests/cache/francais/__-l__deu__000001_ocr.png__000001_ocr_tess__pdf__txt/stdout.bin b/tests/cache/francais/__-l__deu__000001_ocr.png__000001_ocr_tess__pdf__txt/stdout.bin
new file mode 100644
index 00000000..e69de29b
--- /dev/null
+++ b/tests/cache/francais/__-l__deu__000001_ocr.png__000001_ocr_tess__pdf__txt/stdout.bin
diff --git a/tests/cache/francais/__-l__deu__000001_ocr.png__000001_ocr_tess__pdf__txt/txt.bin b/tests/cache/francais/__-l__deu__000001_ocr.png__000001_ocr_tess__pdf__txt/txt.bin
new file mode 100644
index 00000000..25fdded2
--- /dev/null
+++ b/tests/cache/francais/__-l__deu__000001_ocr.png__000001_ocr_tess__pdf__txt/txt.bin
@@ -0,0 +1,13 @@
+Portez ce vieux whisky au juge
+blond qui fume sur son Ile
+interieure, a cöte de l'alcöve
+ovoide, oU les büches se
+consument dans l'ätre, ce qui
+lui permet de penser & la
+caenogenese de |'etre dont il
+est question dans la cause
+ambigu& entendue a MoY, dans
+un capharnaüm qui, pense-t-il,
+diminue ca et la la qualite de son
+ceuvre.
+ \ No newline at end of file
diff --git a/tests/cache/manifest.jsonl b/tests/cache/manifest.jsonl
index fdd1affe..995ec062 100644
--- a/tests/cache/manifest.jsonl
+++ b/tests/cache/manifest.jsonl
@@ -82,3 +82,4 @@
{"tesseract_version": "4.1.1", "system": "Linux", "python": "3.9.5", "argv_slug": "__-l__eng__--oem__1__000001_ocr.png__000001_ocr_tess__pdf__txt", "sourcefile": "resources/trivial.pdf", "args": ["-l", "eng", "--oem", "1", "-c", "textonly_pdf=1", "$TMPDIR/000001_ocr.png", "$TMPDIR/000001_ocr_tess", "pdf", "txt"]}
{"tesseract_version": "5.0.0", "system": "Linux", "python": "3.9.5", "argv_slug": "__-l__eng__thresholding_method=1__000001_ocr.png__000001_ocr_tess__pdf__txt", "sourcefile": "resources/trivial.pdf", "args": ["-l", "eng", "-c", "textonly_pdf=1", "-c", "thresholding_method=1", "$TMPDIR/000001_ocr.png", "$TMPDIR/000001_ocr_tess", "pdf", "txt"]}
{"tesseract_version": "5.0.0", "system": "Linux", "python": "3.9.5", "argv_slug": "__-l__eng__thresholding_method=2__000001_ocr.png__000001_ocr_tess__pdf__txt", "sourcefile": "resources/trivial.pdf", "args": ["-l", "eng", "-c", "textonly_pdf=1", "-c", "thresholding_method=2", "$TMPDIR/000001_ocr.png", "$TMPDIR/000001_ocr_tess", "pdf", "txt"]}
+{"tesseract_version": "4.1.1", "system": "Linux", "python": "3.10.4", "argv_slug": "__-l__deu__000001_ocr.png__000001_ocr_tess__pdf__txt", "sourcefile": "resources/francais.pdf", "args": ["-l", "deu", "-c", "textonly_pdf=1", "$TMPDIR/000001_ocr.png", "$TMPDIR/000001_ocr_tess", "pdf", "txt"]}
diff --git a/tests/conftest.py b/tests/conftest.py
index 62adaae2..d9dfebea 100644
--- a/tests/conftest.py
+++ b/tests/conftest.py
@@ -1,9 +1,7 @@
-# © 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/.
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
+from __future__ import annotations
import os
import platform
@@ -52,7 +50,7 @@ def resources() -> Path:
@pytest.fixture
-def ocrmypdf_exec() -> List[str]:
+def ocrmypdf_exec() -> list[str]:
return [sys.executable, '-m', 'ocrmypdf']
diff --git a/tests/plugins/gs_feature_elision.py b/tests/plugins/gs_feature_elision.py
index 97a17ab3..0f63c502 100644
--- a/tests/plugins/gs_feature_elision.py
+++ b/tests/plugins/gs_feature_elision.py
@@ -1,23 +1,7 @@
-# © 2020 James R. Barlow: 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.
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MIT
+
+from __future__ import annotations
from unittest.mock import patch
diff --git a/tests/plugins/gs_pdfa_failure.py b/tests/plugins/gs_pdfa_failure.py
index 43f6df0f..a67aa872 100644
--- a/tests/plugins/gs_pdfa_failure.py
+++ b/tests/plugins/gs_pdfa_failure.py
@@ -1,23 +1,7 @@
-# © 2020 James R. Barlow: 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.
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MIT
+
+from __future__ import annotations
from unittest.mock import patch
diff --git a/tests/plugins/gs_raster_failure.py b/tests/plugins/gs_raster_failure.py
index 0d85b263..70066273 100644
--- a/tests/plugins/gs_raster_failure.py
+++ b/tests/plugins/gs_raster_failure.py
@@ -1,23 +1,7 @@
-# © 2020 James R. Barlow: 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.
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MIT
+
+from __future__ import annotations
from pathlib import Path
from subprocess import CalledProcessError
diff --git a/tests/plugins/gs_render_failure.py b/tests/plugins/gs_render_failure.py
index 3c88e71f..97ee9c77 100644
--- a/tests/plugins/gs_render_failure.py
+++ b/tests/plugins/gs_render_failure.py
@@ -1,23 +1,7 @@
-# © 2020 James R. Barlow: 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.
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MIT
+
+from __future__ import annotations
from subprocess import CalledProcessError
from unittest.mock import patch
diff --git a/tests/plugins/tesseract_badutf8.py b/tests/plugins/tesseract_badutf8.py
index 5a5e1e32..93f14f06 100644
--- a/tests/plugins/tesseract_badutf8.py
+++ b/tests/plugins/tesseract_badutf8.py
@@ -1,23 +1,5 @@
-# © 2020 James R. Barlow: 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.
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MIT
"""Tesseract bad utf8
@@ -26,6 +8,8 @@ that is not UTF-8 compatible, so we are forced to check that we can convert it
and present it to the user.
"""
+from __future__ import annotations
+
from contextlib import contextmanager
from subprocess import CalledProcessError
from unittest.mock import patch
diff --git a/tests/plugins/tesseract_big_image_error.py b/tests/plugins/tesseract_big_image_error.py
index e2382ac5..0726050d 100644
--- a/tests/plugins/tesseract_big_image_error.py
+++ b/tests/plugins/tesseract_big_image_error.py
@@ -1,23 +1,6 @@
-# © 2020 James R. Barlow: 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.
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MIT
+from __future__ import annotations
from contextlib import contextmanager
from subprocess import CalledProcessError
diff --git a/tests/plugins/tesseract_cache.py b/tests/plugins/tesseract_cache.py
index dd33383f..b32d2498 100644
--- a/tests/plugins/tesseract_cache.py
+++ b/tests/plugins/tesseract_cache.py
@@ -1,24 +1,5 @@
-# © 2020 James R. Barlow: 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.
-
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MIT
"""Cache output of tesseract to speed up test suite
The cache is keyed by by the input test file The input arguments are slugged
@@ -44,6 +25,8 @@ Assumes Tesseract 4.0.0-alpha or higher.
"""
+from __future__ import annotations
+
import argparse
import json
import logging
diff --git a/tests/plugins/tesseract_crash.py b/tests/plugins/tesseract_crash.py
index 60ff1110..33f4dbc9 100755
--- a/tests/plugins/tesseract_crash.py
+++ b/tests/plugins/tesseract_crash.py
@@ -1,23 +1,6 @@
-# © 2020 James R. Barlow: 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.
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MIT
+from __future__ import annotations
import signal
from contextlib import contextmanager
diff --git a/tests/plugins/tesseract_debug_rotate.py b/tests/plugins/tesseract_debug_rotate.py
index 30c613bd..f278cb3f 100644
--- a/tests/plugins/tesseract_debug_rotate.py
+++ b/tests/plugins/tesseract_debug_rotate.py
@@ -1,24 +1,5 @@
-# © 2020 James R. Barlow: 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.
-
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MIT
"""Tesseract no-op/fixed rotate plugin
To quickly run tests where getting OCR output is not necessary and we want to test
@@ -31,6 +12,8 @@ In 'pdf' mode, convert the image to PDF using another program.
In orientation check mode, report 0, 90, 180, 270... based on page number.
"""
+from __future__ import annotations
+
import pikepdf
from PIL import Image
diff --git a/tests/plugins/tesseract_noop.py b/tests/plugins/tesseract_noop.py
index 71120cb9..4dd18dfd 100644
--- a/tests/plugins/tesseract_noop.py
+++ b/tests/plugins/tesseract_noop.py
@@ -1,24 +1,5 @@
-# © 2020 James R. Barlow: 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.
-
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MIT
"""Tesseract no-op plugin
To quickly run tests where getting OCR output is not necessary.
@@ -30,6 +11,8 @@ In 'pdf' mode, convert the image to PDF using another program.
In orientation check mode, report the orientation is upright.
"""
+from __future__ import annotations
+
import pikepdf
from PIL import Image
diff --git a/tests/plugins/tesseract_simulate_oom_killer.py b/tests/plugins/tesseract_simulate_oom_killer.py
index d56345ff..5305c63e 100644
--- a/tests/plugins/tesseract_simulate_oom_killer.py
+++ b/tests/plugins/tesseract_simulate_oom_killer.py
@@ -1,26 +1,5 @@
-# © 2021 James R. Barlow: 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.
-
-# type: ignore
-
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MIT
"""Tesseract no-op plugin that simulates the OOM killer on page 4.
OCRmyPDF can use a lot of memory, even that it might trigger the
@@ -30,14 +9,18 @@ ensure we fail with an error rather than deadlock in such cases.
Page 4 was chosen because of this number's association with bad luck
in many East Asian cultures.
"""
+# type: ignore
+from __future__ import annotations
import os
import signal
-import sys
from pathlib import Path
from ocrmypdf import hookimpl
+# type: ignore
+
+
# Ugly hack that let us use the NoopOcrEngine without setting up packaging for our
# tests.
# This hack also requires us to set type: ignore
@@ -47,7 +30,7 @@ exec(parent)
NoopOcrEngine = locals()['NoopOcrEngine']
-class Page4Engine(NoopOcrEngine):
+class Page4Engine(NoopOcrEngine): # type: ignore
def __str__(self):
return f"NO-OP Page 4 {NoopOcrEngine.version()}"
diff --git a/tests/test_acroform.py b/tests/test_acroform.py
index 82fe8d1f..2b989efd 100644
--- a/tests/test_acroform.py
+++ b/tests/test_acroform.py
@@ -1,9 +1,7 @@
-# © 2019 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/.
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
+from __future__ import annotations
import logging
diff --git a/tests/test_api.py b/tests/test_api.py
index 78323ce0..ee2bd48a 100644
--- a/tests/test_api.py
+++ b/tests/test_api.py
@@ -1,9 +1,7 @@
-# © 2019 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/.
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
+from __future__ import annotations
import logging
from io import BytesIO, StringIO
diff --git a/tests/test_check_pdf.py b/tests/test_check_pdf.py
index 2d192dac..3127d1f2 100644
--- a/tests/test_check_pdf.py
+++ b/tests/test_check_pdf.py
@@ -1,9 +1,7 @@
-# © 2018 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/.
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
+from __future__ import annotations
import pytest
diff --git a/tests/test_completion.py b/tests/test_completion.py
index 01a02b31..74106473 100644
--- a/tests/test_completion.py
+++ b/tests/test_completion.py
@@ -1,9 +1,7 @@
-# © 2019 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/.
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
+from __future__ import annotations
import os
from subprocess import PIPE, run
diff --git a/tests/test_concurrency.py b/tests/test_concurrency.py
index fb149a2e..e5244ddb 100644
--- a/tests/test_concurrency.py
+++ b/tests/test_concurrency.py
@@ -1,8 +1,7 @@
-# © 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/.
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
+
+from __future__ import annotations
import os
diff --git a/tests/test_ghostscript.py b/tests/test_ghostscript.py
index b612fc57..caa8d6ed 100644
--- a/tests/test_ghostscript.py
+++ b/tests/test_ghostscript.py
@@ -1,9 +1,7 @@
-# © 2019 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/.
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
+from __future__ import annotations
import logging
import subprocess
diff --git a/tests/test_graft.py b/tests/test_graft.py
index 19fa3b9d..8e73622f 100644
--- a/tests/test_graft.py
+++ b/tests/test_graft.py
@@ -1,9 +1,7 @@
-# © 2019 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/.
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
+from __future__ import annotations
from unittest.mock import patch
diff --git a/tests/test_helpers.py b/tests/test_helpers.py
index 9ab133be..5d5f5d1e 100644
--- a/tests/test_helpers.py
+++ b/tests/test_helpers.py
@@ -1,9 +1,7 @@
-# © 2019 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/.
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
+from __future__ import annotations
import logging
import multiprocessing
diff --git a/tests/test_hocrtransform.py b/tests/test_hocrtransform.py
index 95777475..49a50d4e 100644
--- a/tests/test_hocrtransform.py
+++ b/tests/test_hocrtransform.py
@@ -1,9 +1,7 @@
-# © 2015 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/.
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
+from __future__ import annotations
import re
from io import StringIO
diff --git a/tests/test_image_input.py b/tests/test_image_input.py
index c3d01b5f..ef3702fe 100644
--- a/tests/test_image_input.py
+++ b/tests/test_image_input.py
@@ -1,9 +1,7 @@
-# © 2019 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/.
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
+from __future__ import annotations
from unittest.mock import patch
diff --git a/tests/test_logging.py b/tests/test_logging.py
index 6bbd551f..7e03b081 100644
--- a/tests/test_logging.py
+++ b/tests/test_logging.py
@@ -1,8 +1,7 @@
-# © 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/.
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
+
+from __future__ import annotations
import logging
diff --git a/tests/test_main.py b/tests/test_main.py
index a60c76f8..739df7b7 100644
--- a/tests/test_main.py
+++ b/tests/test_main.py
@@ -1,9 +1,7 @@
-# © 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/.
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
+from __future__ import annotations
import os
import shutil
@@ -465,12 +463,18 @@ def test_overlay(resources, outpdf):
)
-def test_destination_not_writable(resources, outdir):
- if os.name != 'nt' and (os.getuid() == 0 or os.geteuid() == 0):
- pytest.xfail(reason="root can write to anything")
+@pytest.fixture
+def protected_file(outdir):
protected_file = outdir / 'protected.pdf'
protected_file.touch()
protected_file.chmod(0o400) # Read-only
+ yield protected_file
+
+
+@pytest.mark.skipif(
+ os.name == 'nt' or os.geteuid() == 0, reason="root can write to anything"
+)
+def test_destination_not_writable(resources, protected_file):
p = run_ocrmypdf(
resources / 'jbig2.pdf',
protected_file,
@@ -480,7 +484,8 @@ def test_destination_not_writable(resources, outdir):
assert p.returncode == ExitCode.file_access_error, "Expected error"
-def test_tesseract_config_valid(resources, outdir):
+@pytest.fixture
+def valid_tess_config(outdir):
cfg_file = outdir / 'test.cfg'
with cfg_file.open('w') as f:
f.write(
@@ -490,20 +495,22 @@ language_model_penalty_non_dict_word 0
language_model_penalty_non_freq_dict_word 0
'''
)
+ yield cfg_file
+
+def test_tesseract_config_valid(resources, valid_tess_config, outpdf):
check_ocrmypdf(
resources / '3small.pdf',
- outdir / 'out.pdf',
+ outpdf,
'--tesseract-config',
- cfg_file,
+ valid_tess_config,
'--pages',
'1',
)
-@pytest.mark.slow # This test sometimes times out in CI
-@pytest.mark.parametrize('renderer', RENDERERS)
-def test_tesseract_config_invalid(renderer, resources, outdir):
+@pytest.fixture
+def invalid_tess_config(outdir):
cfg_file = outdir / 'test.cfg'
with cfg_file.open('w') as f:
f.write(
@@ -511,14 +518,19 @@ def test_tesseract_config_invalid(renderer, resources, outdir):
THIS FILE IS INVALID
'''
)
+ yield cfg_file
+
+@pytest.mark.slow # This test sometimes times out in CI
+@pytest.mark.parametrize('renderer', RENDERERS)
+def test_tesseract_config_invalid(renderer, resources, invalid_tess_config, outpdf):
p = run_ocrmypdf(
resources / 'ccitt.pdf',
- outdir / 'out.pdf',
+ outpdf,
'--pdf-renderer',
renderer,
'--tesseract-config',
- cfg_file,
+ invalid_tess_config,
)
assert (
"parameter not found" in p.stderr.lower()
@@ -801,6 +813,9 @@ def test_text_curves(resources, outpdf):
info = PdfInfo(outpdf)
assert len(info.pages[0].images) == 0, "added images to the vector PDF"
+
+def test_text_curves_force(resources, outpdf):
+ with patch('ocrmypdf._pipeline.VECTOR_PAGE_DPI', 100):
check_ocrmypdf(
resources / 'vector.pdf',
outpdf,
@@ -922,3 +937,25 @@ def test_outputtype_none(resources, outtxt):
'tests/plugins/tesseract_noop.py',
)
assert p.returncode == ExitCode.ok
+
+
+@pytest.fixture
+def graph_bad_icc(resources, outdir):
+ synth_input_file = outdir / 'graph-bad-icc.pdf'
+ with pikepdf.open(resources / 'graph.pdf') as pdf:
+ icc = pdf.make_stream(
+ b'invalid icc profile', N=3, Alternate=pikepdf.Name.DeviceRGB
+ )
+ pdf.pages[0].Resources.XObject['/Im0'].ColorSpace = pikepdf.Array(
+ [pikepdf.Name.ICCBased, icc]
+ )
+ pdf.save(synth_input_file)
+ yield synth_input_file
+
+
+def test_corrupt_icc(graph_bad_icc, outpdf, caplog):
+ result = run_ocrmypdf_api(graph_bad_icc, outpdf)
+ assert result == ExitCode.ok
+ assert any(
+ 'corrupt or unreadable ICC profile' in rec.message for rec in caplog.records
+ )
diff --git a/tests/test_metadata.py b/tests/test_metadata.py
index cde1e60c..dbd9f7f9 100644
--- a/tests/test_metadata.py
+++ b/tests/test_metadata.py
@@ -1,15 +1,12 @@
-# © 2018 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/.
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
+from __future__ import annotations
import datetime
+import warnings
from datetime import timezone
-from os import fspath
from shutil import copyfile
-from unittest.mock import patch
import pikepdf
import pytest
@@ -17,7 +14,7 @@ from pikepdf.models.metadata import decode_pdf_date
from ocrmypdf._jobcontext import PdfContext
from ocrmypdf._pipeline import convert_to_pdfa, metadata_fixup
-from ocrmypdf._plugin_manager import get_plugin_manager
+from ocrmypdf._plugin_manager import get_parser_options_plugins, get_plugin_manager
from ocrmypdf.cli import get_parser
from ocrmypdf.exceptions import ExitCode
from ocrmypdf.pdfa import file_claims_pdfa, generate_pdfa_ps
@@ -173,6 +170,19 @@ def test_creation_date_preserved(output_type, resources, infile, outpdf):
assert seconds_between_dates(date_after, datetime.datetime.now(timezone.utc)) < 1000
+@pytest.fixture
+def libxmp_file_to_dict():
+ try:
+ with warnings.catch_warnings():
+ warnings.simplefilter("ignore", DeprecationWarning)
+ from libxmp.utils import (
+ file_to_dict, # pylint: disable=import-outside-toplevel
+ )
+ except Exception: # pylint: disable=broad-except
+ pytest.skip("libxmp not available or libexempi3 not installed")
+ return file_to_dict
+
+
@pytest.mark.parametrize(
'test_file,output_type',
[
@@ -182,15 +192,12 @@ def test_creation_date_preserved(output_type, resources, infile, outpdf):
('3small.pdf', 'pdfa'),
],
)
-def test_xml_metadata_preserved(test_file, output_type, resources, outpdf):
+def test_xml_metadata_preserved(
+ libxmp_file_to_dict, test_file, output_type, resources, outpdf
+):
input_file = resources / test_file
- try:
- from libxmp.utils import file_to_dict # pylint: disable=import-outside-toplevel
- except Exception: # pylint: disable=broad-except
- pytest.skip("libxmp not available or libexempi3 not installed")
-
- before = file_to_dict(str(input_file))
+ before = libxmp_file_to_dict(str(input_file))
check_ocrmypdf(
input_file,
@@ -202,7 +209,7 @@ def test_xml_metadata_preserved(test_file, output_type, resources, outpdf):
'tests/plugins/tesseract_noop.py',
)
- after = file_to_dict(str(outpdf))
+ after = libxmp_file_to_dict(str(outpdf))
equal_properties = [
'dc:contributor',
@@ -290,8 +297,8 @@ def test_kodak_toc(resources, outpdf):
def test_metadata_fixup_warning(resources, outdir, caplog):
- options = get_parser().parse_args(
- args=['--output-type', 'pdfa-2', 'graph.pdf', 'out.pdf']
+ _parser, options, _pm = get_parser_options_plugins(
+ ['--output-type', 'pdfa-2', 'graph.pdf', 'out.pdf']
)
copyfile(resources / 'graph.pdf', outdir / 'graph.pdf')
@@ -316,6 +323,9 @@ def test_metadata_fixup_warning(resources, outdir, caplog):
assert any(record.levelname == 'WARNING' for record in caplog.records)
+XMP_MAGIC = b'W5M0MpCehiHzreSzNTczkc9d'
+
+
def test_prevent_gs_invalid_xml(resources, outdir):
generate_pdfa_ps(outdir / 'pdfa.ps')
copyfile(resources / 'trivial.pdf', outdir / 'layers.rendered.pdf')
@@ -342,7 +352,7 @@ def test_prevent_gs_invalid_xml(resources, outdir):
contents = (outdir / 'pdfa.pdf').read_bytes()
# Since the XML may be invalid, we scan instead of actually feeding it
# to a parser.
- XMP_MAGIC = b'W5M0MpCehiHzreSzNTczkc9d'
+
xmp_start = contents.find(XMP_MAGIC)
xmp_end = contents.rfind(b'<?xpacket end', xmp_start)
assert 0 < xmp_start < xmp_end
diff --git a/tests/test_optimize.py b/tests/test_optimize.py
index d5d59ec7..9c63a41d 100644
--- a/tests/test_optimize.py
+++ b/tests/test_optimize.py
@@ -1,9 +1,7 @@
-# © 2018 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/.
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
+from __future__ import annotations
from os import fspath
from pathlib import Path
diff --git a/tests/test_page_numbers.py b/tests/test_page_numbers.py
index d89a3bea..a04dbb53 100644
--- a/tests/test_page_numbers.py
+++ b/tests/test_page_numbers.py
@@ -1,9 +1,7 @@
-# © 2019 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/.
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
+from __future__ import annotations
import pytest
diff --git a/tests/test_pdfa.py b/tests/test_pdfa.py
index 75b22a57..0e33678c 100644
--- a/tests/test_pdfa.py
+++ b/tests/test_pdfa.py
@@ -1,26 +1,33 @@
-# © 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/.
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
+
+from __future__ import annotations
+
+import os
import pikepdf
import pytest
+from ocrmypdf.exceptions import MissingDependencyError
+
from .conftest import check_ocrmypdf
@pytest.mark.parametrize('optimize', (0, 3))
@pytest.mark.parametrize('pdfa_level', (1, 2, 3))
def test_pdfa(resources, outpdf, optimize, pdfa_level):
- check_ocrmypdf(
- resources / 'francais.pdf',
- outpdf,
- '--plugin',
- 'tests/plugins/tesseract_noop.py',
- f'--output-type=pdfa-{pdfa_level}',
- f'--optimize={optimize}',
- )
+ try:
+ check_ocrmypdf(
+ resources / 'francais.pdf',
+ outpdf,
+ '--plugin',
+ 'tests/plugins/tesseract_noop.py',
+ f'--output-type=pdfa-{pdfa_level}',
+ f'--optimize={optimize}',
+ )
+ except MissingDependencyError as e:
+ if 'pngquant' in str(e) and optimize in (2, 3) and os.name == 'nt':
+ pytest.xfail("pngquant currently not available on Windows")
if pdfa_level in (2, 3):
# PDF/A-2 allows ObjStm
assert b'/ObjStm' in outpdf.read_bytes()
diff --git a/tests/test_pdfinfo.py b/tests/test_pdfinfo.py
index 56052d1e..16cc5918 100644
--- a/tests/test_pdfinfo.py
+++ b/tests/test_pdfinfo.py
@@ -1,8 +1,7 @@
-# © 2015 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/.
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
+
+from __future__ import annotations
import pickle
from io import BytesIO
@@ -24,20 +23,24 @@ from ocrmypdf.pdfinfo.layout import PDFPage
# pylint: disable=protected-access
-def test_single_page_text(outdir):
+@pytest.fixture
+def single_page_text(outdir):
filename = outdir / 'text.pdf'
pdf = Canvas(str(filename), pagesize=(8 * inch, 6 * inch))
text = pdf.beginText()
text.setFont('Helvetica', 12)
text.setTextOrigin(1 * inch, 3 * inch)
text.textLine(
- "Methink'st thou art a general offence and every" " man should beat thee."
+ "Methink'st thou art a general offence and every man should beat thee."
)
pdf.drawText(text)
pdf.showPage()
pdf.save()
+ return filename
+
- info = pdfinfo.PdfInfo(filename)
+def test_single_page_text(single_page_text):
+ info = pdfinfo.PdfInfo(single_page_text)
assert len(info) == 1
page = info[0]
@@ -54,7 +57,8 @@ def eight_by_eight():
return im
-def test_single_page_image(eight_by_eight, outpdf):
+@pytest.fixture
+def eight_by_eight_regular_image(eight_by_eight, outpdf):
im = eight_by_eight
bio = BytesIO()
im.save(bio, format='PNG')
@@ -71,7 +75,11 @@ def test_single_page_image(eight_by_eight, outpdf):
outputstream=f,
**IMG2PDF_KWARGS,
)
- info = pdfinfo.PdfInfo(outpdf)
+ return outpdf
+
+
+def test_single_page_image(eight_by_eight_regular_image):
+ info = pdfinfo.PdfInfo(eight_by_eight_regular_image)
assert len(info) == 1
page = info[0]
@@ -88,16 +96,18 @@ def test_single_page_image(eight_by_eight, outpdf):
assert isclose(pdfimage.dpi.y, 8)
-def test_single_page_inline_image(eight_by_eight, outdir):
- filename = outdir / 'image-mono-inline.pdf'
- pdf = Canvas(str(filename), pagesize=(8 * 72, 6 * 72))
-
+@pytest.fixture
+def eight_by_eight_inline_image(eight_by_eight, outpdf):
+ pdf = Canvas(str(outpdf), pagesize=(8 * 72, 6 * 72))
# Draw image in a 72x72 pt or 1"x1" area
pdf.drawInlineImage(eight_by_eight, 0, 0, width=72, height=72)
pdf.showPage()
pdf.save()
+ return outpdf
+
- info = pdfinfo.PdfInfo(filename)
+def test_single_page_inline_image(eight_by_eight_inline_image):
+ info = pdfinfo.PdfInfo(eight_by_eight_inline_image)
print(info)
pdfimage = info[0].images[0]
assert isclose(pdfimage.dpi.x, 8)
@@ -177,7 +187,7 @@ def test_stack_abuse():
pdfinfo.info._interpret_contents(stream)
stream = pikepdf.Stream(p, b'q Q Q Q Q')
- with pytest.warns(UserWarning, match="underflowed") as record:
+ with pytest.warns(UserWarning, match="underflowed"):
pdfinfo.info._interpret_contents(stream)
stream = pikepdf.Stream(p, b'q ' * 135)
@@ -201,7 +211,8 @@ def test_pages_issue700(monkeypatch, resources):
)
-def test_image_scale0(resources, outpdf):
+@pytest.fixture
+def image_scale0(resources, outpdf):
with pikepdf.open(resources / 'cmyk.pdf') as cmyk:
xobj = cmyk.pages[0].as_form_xobject()
@@ -215,7 +226,12 @@ def test_image_scale0(resources, outpdf):
p, b"q 0 0 0 0 0 0 cm %s Do Q" % bytes(objname)
)
p.save(outpdf)
+ return outpdf
- pi = pdfinfo.PdfInfo(outpdf, detailed_analysis=True, progbar=False, max_workers=1)
+
+def test_image_scale0(image_scale0):
+ pi = pdfinfo.PdfInfo(
+ image_scale0, detailed_analysis=True, progbar=False, max_workers=1
+ )
assert not pi.pages[0]._images[0].dpi.is_finite
assert pi.pages[0].dpi == Resolution(0, 0)
diff --git a/tests/test_pipeline.py b/tests/test_pipeline.py
index 41cb0f04..b3fd7d08 100644
--- a/tests/test_pipeline.py
+++ b/tests/test_pipeline.py
@@ -1,8 +1,7 @@
-# © 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/.
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
+
+from __future__ import annotations
from unittest.mock import Mock
diff --git a/tests/test_preprocessing.py b/tests/test_preprocessing.py
index 6b7f77b6..b9975f41 100644
--- a/tests/test_preprocessing.py
+++ b/tests/test_preprocessing.py
@@ -1,9 +1,7 @@
-# © 2019 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/.
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
+from __future__ import annotations
from math import isclose
diff --git a/tests/test_quality.py b/tests/test_quality.py
index 132eef3d..af7acff6 100644
--- a/tests/test_quality.py
+++ b/tests/test_quality.py
@@ -1,9 +1,7 @@
-# © 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/.
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
+from __future__ import annotations
import pytest
diff --git a/tests/test_rotation.py b/tests/test_rotation.py
index 12eb04e4..1fad82e5 100644
--- a/tests/test_rotation.py
+++ b/tests/test_rotation.py
@@ -1,9 +1,7 @@
-# © 2018 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/.
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
+from __future__ import annotations
import operator
from io import BytesIO
diff --git a/tests/test_stdio.py b/tests/test_stdio.py
index a57c713a..17536145 100644
--- a/tests/test_stdio.py
+++ b/tests/test_stdio.py
@@ -1,9 +1,7 @@
-# © 2019 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/.
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
+from __future__ import annotations
import os
import sys
@@ -53,19 +51,6 @@ def test_stdout(ocrmypdf_exec, resources, outpdf):
assert check_pdf(output_file)
-@pytest.mark.skipif(sys.version_info >= (3, 7, 0), reason='better utf-8')
-@pytest.mark.skipif(
- Path('/etc/alpine-release').exists(), reason="invalid test on alpine"
-)
-@pytest.mark.skipif(os.name == 'nt', reason="invalid test on Windows")
-def test_bad_locale(monkeypatch):
- monkeypatch.setenv('LC_ALL', 'C')
- p = run_ocrmypdf('a', 'b')
- assert p.stdout == '', "stdout not clean"
- assert p.returncode != 0
- assert 'configured to use ASCII as encoding' in p.stderr, "should whine"
-
-
@pytest.mark.xfail(
os.name == 'nt' and sys.version_info < (3, 8),
reason="Windows does not like this; not sure how to fix",
diff --git a/tests/test_tesseract.py b/tests/test_tesseract.py
index c4670722..73ef3c80 100644
--- a/tests/test_tesseract.py
+++ b/tests/test_tesseract.py
@@ -1,9 +1,7 @@
-# © 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/.
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
+from __future__ import annotations
import logging
import os
diff --git a/tests/test_unpaper.py b/tests/test_unpaper.py
index 44b0e5fd..ad6df549 100644
--- a/tests/test_unpaper.py
+++ b/tests/test_unpaper.py
@@ -1,9 +1,7 @@
-# © 2015-17 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/.
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
+from __future__ import annotations
import logging
from os import fspath
diff --git a/tests/test_userunit.py b/tests/test_userunit.py
index 14ac653c..1521d45c 100644
--- a/tests/test_userunit.py
+++ b/tests/test_userunit.py
@@ -1,9 +1,7 @@
-# © 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/.
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
+from __future__ import annotations
from math import isclose
diff --git a/tests/test_validation.py b/tests/test_validation.py
index 280e25f8..570370d7 100644
--- a/tests/test_validation.py
+++ b/tests/test_validation.py
@@ -1,9 +1,7 @@
-# © 2019 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/.
+# SPDX-FileCopyrightText: 2022 James R. Barlow
+# SPDX-License-Identifier: MPL-2.0
+from __future__ import annotations
import logging
import os
@@ -44,29 +42,26 @@ def make_opts(*args, **kwargs):
def test_hocr_notlatin_warning(caplog):
- # Bypass the test to see if the language is installed; we just want to pretend
- # that a non-Latin language is installed
- vd._check_options(
- *make_opts_pm(language='chi_sim', pdf_renderer='hocr', output_type='pdfa'),
- {'chi_sim'},
+ vd.check_options_output(
+ make_opts_pm(language='chi_sim', pdf_renderer='hocr', output_type='pdfa')[0]
)
assert 'PDF renderer is known to cause' in caplog.text
def test_old_ghostscript(caplog):
- with patch('ocrmypdf._exec.ghostscript.version', return_value='9.19'):
- vd._check_options(
- *make_opts_pm(language='chi_sim', output_type='pdfa'), {'chi_sim'}
- )
+ with patch('ocrmypdf._exec.ghostscript.version', return_value='9.19'), patch(
+ 'ocrmypdf._exec.tesseract.get_languages', return_value={'eng', 'chi_sim'}
+ ):
+ vd.check_options(*make_opts_pm(language='chi_sim', output_type='pdfa'))
assert 'does not work correctly' in caplog.text
with patch('ocrmypdf._exec.ghostscript.version', return_value='9.18'):
with pytest.raises(MissingDependencyError):
- vd._check_options(*make_opts_pm(output_type='pdfa-3'), set())
+ vd.check_options(*make_opts_pm(output_type='pdfa-3'))
with patch('ocrmypdf._exec.ghostscript.version', return_value='9.24'):
with pytest.raises(MissingDependencyError):
- vd._check_options(*make_opts_pm(), set())
+ vd.check_options(*make_opts_pm())
def test_old_tesseract_error():
@@ -74,7 +69,7 @@ def test_old_tesseract_error():
with pytest.raises(MissingDependencyError):
opts = make_opts(pdf_renderer='sandwich', language='eng')
plugin_manager = get_plugin_manager(opts.plugins)
- vd._check_options(opts, plugin_manager, {'eng'})
+ vd.check_options(opts, plugin_manager)
def test_lossless_redo():
@@ -92,9 +87,9 @@ def test_mutex_options():
def test_optimizing(caplog):
- vd.check_options_optimizing(
- make_opts(optimize=0, jbig2_lossy=True, png_quality=18, jpeg_quality=10)
- )
+ opts = make_opts(optimize=0, jbig2_lossy=True, png_quality=18, jpeg_quality=10)
+ plugin_manager = get_plugin_manager(opts.plugins)
+ vd.check_options(opts, plugin_manager)
assert 'will be ignored because' in caplog.text
@@ -102,7 +97,7 @@ def test_user_words(caplog):
with patch('ocrmypdf._exec.tesseract.has_user_words', return_value=False):
opts = make_opts(user_words='foo')
plugin_manager = get_plugin_manager(opts.plugins)
- vd._check_options(opts, plugin_manager, set())
+ vd.check_options(opts, plugin_manager)
assert (
'Tesseract 4.0 (which you have installed) ignores --user-words'
in caplog.text
@@ -111,7 +106,7 @@ def test_user_words(caplog):
with patch('ocrmypdf._exec.tesseract.has_user_words', return_value=True):
opts = make_opts(user_patterns='foo')
plugin_manager = get_plugin_manager(opts.plugins)
- vd._check_options(opts, plugin_manager, set())
+ vd.check_options(opts, plugin_manager)
assert (
'Tesseract 4.0 (which you have installed) ignores --user-words'
not in caplog.text
@@ -145,22 +140,16 @@ def test_report_file_size(tmp_path, caplog):
pdf.Root.Dummy2 = waste_of_space + waste_of_space
pdf.save(out)
- with patch('ocrmypdf._validation.jbig2enc.available', return_value=True), patch(
- 'ocrmypdf._validation.pngquant.available', return_value=True
- ):
- vd.report_output_file_size(opts, in_, out)
- assert 'No reason' in caplog.text
+ vd.report_output_file_size(opts, in_, out, ['The optional dependency...'])
+ assert 'optional dependency' in caplog.text
caplog.clear()
- with patch('ocrmypdf._validation.jbig2enc.available', return_value=False), patch(
- 'ocrmypdf._validation.pngquant.available', return_value=True
- ):
- vd.report_output_file_size(opts, in_, out)
- assert 'optional dependency' in caplog.text
+ vd.report_output_file_size(opts, in_, out, [])
+ assert 'No reason' in caplog.text
caplog.clear()
opts = make_opts(in_, out, optimize=0, output_type='pdf')
- vd.report_output_file_size(opts, in_, out)
+ vd.report_output_file_size(opts, in_, out, ["Optimization was disabled."])
assert 'disabled' in caplog.text
caplog.clear()
@@ -177,7 +166,7 @@ def test_no_progress_bar(progress_bar, resources):
opts = make_opts(progress_bar=progress_bar, input_file=(resources / 'trivial.pdf'))
plugin_manager = get_plugin_manager(opts.plugins)
- vd._check_options(opts, plugin_manager, set())
+ vd.check_options(opts, plugin_manager)
pbar_disabled = None
@@ -298,13 +287,19 @@ def test_optional_program_recommended(caplog):
def test_pagesegmode_warning(caplog):
opts = make_opts(tesseract_pagesegmode='0')
plugin_manager = get_plugin_manager(opts.plugins)
- vd._check_options(opts, plugin_manager, set())
+ vd.check_options(opts, plugin_manager)
assert 'disable OCR' in caplog.text
def test_two_languages():
- vd._check_options(
- *make_opts_pm(language='fakelang1+fakelang2'), {'fakelang1', 'fakelang2'}
+ vd.check_options_languages(
+ create_options(
+ input_file='a.pdf',
+ output_file='b.pdf',
+ parser=get_parser(),
+ language='fakelang1+fakelang2',
+ ),
+ {'fakelang1', 'fakelang2'},
)