mirror of
https://github.com/ocrmypdf/OCRmyPDF.git
synced 2025-08-14 11:42:14 +00:00
632dab2cc0
We no longer use Ghostscript to manage PDF metadata, instead omitting the DOCINFO segment from the pdfmark file we generate. Instead all of the relevant metadata code has been migrated to pikepdf, and we use that API. This should be more consistent and fixes the Ghostscript version-depedent quirks. Also removes our python-xmp-toolkit dependency, except for testing.
279 lines
8.8 KiB
Python
279 lines
8.8 KiB
Python
#!/usr/bin/env python3
|
|
# -*- coding: utf-8 -*-
|
|
# © 2015 James R. Barlow: github.com/jbarlow83
|
|
#
|
|
# This file is part of OCRmyPDF.
|
|
#
|
|
# OCRmyPDF is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# OCRmyPDF is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with OCRmyPDF. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
from __future__ import print_function, unicode_literals
|
|
|
|
import sys
|
|
if sys.version_info < (3, 5):
|
|
print("Python 3.5 or newer is required", file=sys.stderr)
|
|
sys.exit(1)
|
|
|
|
from setuptools import setup, find_packages # nopep8
|
|
from subprocess import STDOUT, check_output, CalledProcessError # nopep8
|
|
from collections.abc import Mapping # nopep8
|
|
import re # nopep8
|
|
|
|
|
|
missing_program = '''
|
|
The program '{program}' could not be executed or was not found on your
|
|
system PATH.
|
|
'''
|
|
|
|
unknown_version = '''
|
|
OCRmyPDF requires '{program}' {need_version} or higher. Your system has
|
|
'{program}' but we cannot tell what version is installed. Contact the
|
|
package maintainer.
|
|
'''
|
|
|
|
old_version = '''
|
|
OCRmyPDF requires '{program}' {need_version} or higher. Your system appears
|
|
to have {found_version}. Please update this program.
|
|
'''
|
|
|
|
okay_its_optional = '''
|
|
This program is OPTIONAL, so installation of OCRmyPDF can proceed, but
|
|
some functionality may be missing.
|
|
'''
|
|
|
|
not_okay_its_required = '''
|
|
This program is REQUIRED for OCRmyPDF to work. Installation will abort.
|
|
'''
|
|
|
|
osx_install_advice = '''
|
|
If you have homebrew installed, try these command to install the missing
|
|
packages:
|
|
brew update
|
|
brew upgrade
|
|
brew install {package}
|
|
'''
|
|
|
|
linux_install_advice = '''
|
|
On systems with the aptitude package manager (Debian, Ubuntu), try these
|
|
commands:
|
|
sudo apt-get update
|
|
sudo apt-get install {package}
|
|
|
|
On RPM-based systems (Red Hat, Fedora), search for instructions on
|
|
installing the RPM for {program}.
|
|
'''
|
|
|
|
|
|
def get_platform():
|
|
if sys.platform.startswith('freebsd'):
|
|
return 'freebsd'
|
|
elif sys.platform.startswith('linux'):
|
|
return 'linux'
|
|
return sys.platform
|
|
|
|
|
|
def _error_trailer(program, package, optional, **kwargs):
|
|
if optional:
|
|
print(okay_its_optional.format(**locals()), file=sys.stderr)
|
|
else:
|
|
print(not_okay_its_required.format(**locals()), file=sys.stderr)
|
|
|
|
if isinstance(package, Mapping):
|
|
package = package[get_platform()]
|
|
|
|
if get_platform() == 'darwin':
|
|
print(osx_install_advice.format(**locals()), file=sys.stderr)
|
|
elif get_platform() == 'linux':
|
|
print(linux_install_advice.format(**locals()), file=sys.stderr)
|
|
|
|
|
|
def error_missing_program(
|
|
program,
|
|
package,
|
|
optional
|
|
):
|
|
print(missing_program.format(**locals()), file=sys.stderr)
|
|
_error_trailer(**locals())
|
|
|
|
|
|
def error_unknown_version(
|
|
program,
|
|
package,
|
|
optional,
|
|
need_version
|
|
):
|
|
print(unknown_version.format(**locals()), file=sys.stderr)
|
|
_error_trailer(**locals())
|
|
|
|
|
|
def error_old_version(
|
|
program,
|
|
package,
|
|
optional,
|
|
need_version,
|
|
found_version
|
|
):
|
|
print(old_version.format(**locals()), file=sys.stderr)
|
|
_error_trailer(**locals())
|
|
|
|
|
|
def check_external_program(
|
|
program,
|
|
need_version,
|
|
package,
|
|
version_check_args=['--version'],
|
|
version_scrape_regex=re.compile(r'(\d+\.\d+(?:\.\d+)?)'),
|
|
optional=False):
|
|
|
|
print('Checking for {program} >= {need_version}...'.format(
|
|
program=program, need_version=need_version))
|
|
try:
|
|
result = check_output(
|
|
[program] + version_check_args,
|
|
universal_newlines=True, stderr=STDOUT)
|
|
except (CalledProcessError, FileNotFoundError):
|
|
error_missing_program(program, package, optional)
|
|
if not optional:
|
|
sys.exit(1)
|
|
print('Continuing install without {program}'.format(program=program))
|
|
return
|
|
|
|
try:
|
|
found_version = version_scrape_regex.search(result).group(1)
|
|
except AttributeError:
|
|
error_unknown_version(program, package, optional, need_version)
|
|
sys.exit(1)
|
|
|
|
if found_version < need_version:
|
|
error_old_version(program, package, optional, need_version,
|
|
found_version)
|
|
|
|
print('Found {program} {found_version}'.format(
|
|
program=program, found_version=found_version))
|
|
|
|
|
|
command = next((arg for arg in sys.argv[1:] if not arg.startswith('-')), '')
|
|
forced = ('--force' in sys.argv)
|
|
|
|
|
|
if not forced and command.startswith('install') or \
|
|
command in ['check', 'test', 'nosetests', 'easy_install']:
|
|
check_external_program(
|
|
program='tesseract',
|
|
need_version='3.04', # using backport for Travis CI
|
|
package={'darwin': 'tesseract', 'linux': 'tesseract-ocr'}
|
|
)
|
|
check_external_program(
|
|
program='gs',
|
|
need_version='9.15', # limited by Travis CI / Ubuntu 14.04 backports
|
|
package='ghostscript'
|
|
)
|
|
check_external_program(
|
|
program='unpaper',
|
|
need_version='6.1', # latest sane version
|
|
package='unpaper',
|
|
optional=True
|
|
)
|
|
check_external_program(
|
|
program='qpdf',
|
|
need_version='8.0.2', # test suite known to fail on 5.1.1
|
|
package='qpdf'
|
|
)
|
|
check_external_program(
|
|
program='pngquant',
|
|
need_version='2.0.0',
|
|
package='pngquant',
|
|
optional=True
|
|
)
|
|
|
|
if 'upload' in sys.argv[1:]:
|
|
print('Use twine to upload the package - setup.py upload is insecure')
|
|
sys.exit(1)
|
|
|
|
tests_require = open('requirements/test.txt', encoding='utf-8').read().splitlines()
|
|
|
|
|
|
def readme():
|
|
with open('README.md', encoding='utf-8') as f:
|
|
return f.read()
|
|
|
|
setup(
|
|
name='ocrmypdf',
|
|
description='OCRmyPDF adds an OCR text layer to scanned PDF files, allowing them to be searched',
|
|
long_description=readme(),
|
|
long_description_content_type='text/markdown',
|
|
url='https://github.com/jbarlow83/OCRmyPDF',
|
|
author='James R. Barlow',
|
|
author_email='jim@purplerock.ca',
|
|
packages=find_packages('src', exclude=["tests", "tests.*"]),
|
|
package_dir={'': 'src'},
|
|
keywords=['PDF', 'OCR', 'optical character recognition', 'PDF/A', 'scanning'],
|
|
classifiers=[
|
|
"Programming Language :: Python :: 3.5",
|
|
"Programming Language :: Python :: 3.6",
|
|
"Programming Language :: Python :: 3.7",
|
|
"Development Status :: 5 - Production/Stable",
|
|
"Environment :: Console",
|
|
"Intended Audience :: End Users/Desktop",
|
|
"Intended Audience :: Science/Research",
|
|
"Intended Audience :: System Administrators",
|
|
"License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
|
|
"Operating System :: MacOS :: MacOS X",
|
|
"Operating System :: POSIX",
|
|
"Operating System :: POSIX :: BSD",
|
|
"Operating System :: POSIX :: Linux",
|
|
"Topic :: Scientific/Engineering :: Image Recognition",
|
|
"Topic :: Text Processing :: Indexing",
|
|
"Topic :: Text Processing :: Linguistic",
|
|
],
|
|
python_requires=' >= 3.5',
|
|
setup_requires=[
|
|
'cffi >= 1.9.1', # to build the leptonica module
|
|
'pytest-runner', # to enable python setup.py test
|
|
'setuptools_scm', # so that version will work
|
|
'setuptools_scm_git_archive' # enable version from github tarballs
|
|
],
|
|
use_scm_version={'version_scheme': 'post-release'},
|
|
cffi_modules=[
|
|
'src/ocrmypdf/lib/compile_leptonica.py:ffibuilder'
|
|
],
|
|
install_requires=[
|
|
'cffi >= 1.9.1', # must be a setup and install requirement
|
|
'img2pdf >= 0.3.0, < 0.4', # pure Python, so track HEAD closely
|
|
'pdfminer.six == 20181108',
|
|
'pikepdf >= 0.3.7, < 0.4',
|
|
'Pillow >= 4.0.0, != 5.1.0 ; sys_platform == "darwin"',
|
|
# Pillow < 4 has BytesIO/TIFF bug w/img2pdf 0.2.3
|
|
# block 5.1.0, broken wheels
|
|
'reportlab >= 3.3.0', # oldest released version with sane image handling
|
|
'ruffus >= 2.7.0',
|
|
],
|
|
extras_require={
|
|
'fitz': [], # Backward compatibility
|
|
},
|
|
tests_require=tests_require,
|
|
entry_points={
|
|
'console_scripts': [
|
|
'ocrmypdf = ocrmypdf.__main__:run_pipeline'
|
|
],
|
|
},
|
|
package_data={'ocrmypdf': ['data/sRGB.icc']},
|
|
include_package_data=True,
|
|
zip_safe=False,
|
|
project_urls={
|
|
'Documentation': 'https://ocrmypdf.readthedocs.io/',
|
|
'Source': 'https://github.com/jbarlow83/ocrmypdf',
|
|
'Tracker': 'https://github.com/jbarlow83/ocrmypdf/issues'
|
|
}
|
|
)
|