docstruct/Makefile at master · bertsky/docstruct · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
PYTHON = python3
PIP = pip3
PYTHONIOENCODING=utf8
PYTEST_ARGS ?= "-vv --workspace=all"

DOCKER_BASE_IMAGE ?= docker.io/ocrd/core:latest
DOCKER_TAG ?= ocrd/docstruct
DOCKER ?= docker

help:
	@echo
	@echo "  Targets"
	@echo
	@echo "    deps         Install only Python deps via pip"
	@echo "    install      Install full Python package via pip"
	@echo "    install-dev  Install in editable mode"
	@echo "    build        Build binary and source Python package"
	@echo "    docker       Build a Docker image $(DOCKER_TAG) from $(DOCKER_BASE_IMAGE)"
	@echo "    test         Run tests via Pytest"
	@echo "    repo/assets  Clone OCR-D/assets to ./repo/assets"
	@echo "    tests/assets Copy to ./tests/assets"
	@echo ""
	@echo "  Variables"
	@echo ""
	@echo "    DOCKER_TAG  Docker container tag ($(DOCKER_TAG))"
	@echo "    PYTEST_ARGS Additional runtime options for pytest ($(PYTEST_ARGS))"
	@echo "                (See --help, esp. custom option --workspace)"

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

deps-test:
	$(PIP) install -r requirements-test.txt

# Install Python package via pip
install:
	$(PIP) install .

install-dev:
	$(PIP) install -e .

build:
	$(PIP) install build wheel
	$(PYTHON) -m build .

# Run test
test: tests/assets
	$(PYTHON) -m pytest  tests --durations=0 $(PYTEST_ARGS)

coverage:
	coverage erase
	$(MAKE) test PYTHON="coverage run"
	coverage report -m

#
# Assets
#

# Update OCR-D/assets submodule
.PHONY: repos always-update tests/assets
repo/assets: always-update
	git submodule sync --recursive $@
	if git submodule status --recursive $@ | grep -qv '^ '; then \
		git submodule update --init --recursive $@ && \
		touch $@; \
	fi

benner_herrnhuterey04_1748.ocrd.zip:
	wget https://github.com/OCR-D/gt_structure_text/releases/download/v1.5.0/$@

# Setup test assets
tests/assets: benner_herrnhuterey04_1748.ocrd.zip
tests/assets: repo/assets
	mkdir -p $@
	cp -a $</data/* $@
	$(foreach BAG,$(filter %.zip,$^),ocrd zip spill -d $@/$(basename $(BAG)) $(BAG))

docker:
	$(DOCKER) build \
	--build-arg DOCKER_BASE_IMAGE=$(DOCKER_BASE_IMAGE) \
	--build-arg VCS_REF=$$(git rev-parse --short HEAD) \
	--build-arg BUILD_DATE=$$(date -u +"%Y-%m-%dT%H:%M:%SZ") \
	-t $(DOCKER_TAG) .

.PHONY: help deps deps-test install install-dev build test coverage docker