Makefile

export

SHELL = /bin/bash
PYTHON = python3
PIP = pip3
LOG_LEVEL = INFO
PYTHONIOENCODING=utf8

# pytest args. Set to '-s' to see log output during test execution, '--verbose' to see individual tests. Default: '$(PYTEST_ARGS)'
PYTEST_ARGS =

# Docker container tag
DOCKER_TAG = 'ocrd/tesserocr'

# BEGIN-EVAL makefile-parser --make-help Makefile

help:
	@echo ""
	@echo "  Targets"
	@echo ""
	@echo "    deps-ubuntu   Dependencies for deployment in an ubuntu/debian linux"
	@echo "                  (lib*-dev merely for building tesserocr with pip)"
	@echo "                  (tesseract-ocr: Ubuntu 18.04 now ships 4.0.0,"
	@echo "                   which is unsupported. Add the tesseract-ocr PPA"
	@echo "                   from Alexander Pozdnyakov which provides 4.1.0."
	@echo "                   See https://launchpad.net/~alex-p/+archive/ubuntu/tesseract-ocr"
	@echo "                   for details.)"
	@echo "    deps          Install Python deps for install via pip"
	@echo "    deps-test     Install Python deps for test via pip"
	@echo "    docker        Build docker image"
	@echo "    install       Install this package"
	@echo "    test          Run unit tests"
	@echo "    coverage      Run unit tests and determine test coverage"
	@echo "    test-cli      Test the command line tools"
	@echo "    test/assets   Setup test assets"
	@echo "    repo/assets   Clone OCR-D/assets to ./repo/assets"
	@echo "    assets-clean  Remove symlinks in test/assets"
	@echo ""
	@echo "  Variables"
	@echo ""
	@echo "    PYTEST_ARGS  pytest args. Set to '-s' to see log output during test execution, '--verbose' to see individual tests. Default: '$(PYTEST_ARGS)'"
	@echo "    DOCKER_TAG   Docker container tag"

# END-EVAL

# Dependencies for deployment in an ubuntu/debian linux
# (lib*-dev merely for building tesserocr with pip)
# (tesseract-ocr: Ubuntu 18.04 now ships 4.0.0,
#  which is unsupported. Add the tesseract-ocr PPA
#  from Alexander Pozdnyakov which provides 4.1.0.
#  See https://launchpad.net/~alex-p/+archive/ubuntu/tesseract-ocr
#  for details.)
deps-ubuntu:
	apt-get install -y --no-install-recommends software-properties-common
	add-apt-repository -y ppa:alex-p/tesseract-ocr
	apt-get install -y \
		g++ \
		git \
		python3 \
		python3-pip \
		libtesseract-dev \
		libleptonica-dev \
		tesseract-ocr-eng \
		tesseract-ocr

# Install Python deps for install via pip
deps:
	$(PIP) install -U pip
	$(PIP) install -r requirements.txt

# Install Python deps for test via pip
deps-test:
	$(PIP) install -U pip
	$(PIP) install -r requirements_test.txt

# Build docker image
docker:
	docker build -t $(DOCKER_TAG) .

# Install this package
install: deps
	$(PIP) install -U pip
	$(PIP) install .

# Run unit tests
test: test/assets deps-test
	# declare -p HTTP_PROXY
	$(PYTHON) -m pytest --continue-on-collection-errors test $(PYTEST_ARGS)

# Run unit tests and determine test coverage
coverage: deps-test
	coverage erase
	make test PYTHON="coverage run"
	coverage report
	coverage html

# Test the command line tools
test-cli: test/assets
	$(PIP) install -e .
	rm -rfv test/workspace
	cp -rv test/assets/kant_aufklaerung_1784 test/workspace
	cd test/workspace/data && \
		ocrd-tesserocr-segment-region -l DEBUG -I OCR-D-IMG -O OCR-D-SEG-REGION ; \
		ocrd-tesserocr-segment-line   -l DEBUG -I OCR-D-SEG-REGION -O OCR-D-SEG-LINE ; \
		ocrd-tesserocr-recognize      -l DEBUG -I OCR-D-SEG-LINE -O OCR-D-TESS-OCR

.PHONY: test test-cli install deps deps-ubuntu deps-test help

#
# Assets
#

# Setup test assets (copy repo/assets)
# FIXME remove/update if already present
test/assets: repo/assets
	mkdir -p $@
	cp -r -t $@ repo/assets/data/*

# Clone OCR-D/assets to ./repo/assets
# FIXME does not work if already checked out
# FIXME should be a proper (VCed) submodule
repo/assets:
	mkdir -p $(dir $@)
	git clone https://github.com/OCR-D/assets "$@"


.PHONY: assets-clean
# Remove symlinks in test/assets
assets-clean:
	rm -rf test/assets