PyOptik/Makefile at master · MartinPdeS/PyOptik · 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
PYTHON ?= python3.11
BUILD_DIR ?= build
DIST_DIR ?= dist
DOCS_DIR ?= docs
DOCS_BUILD_DIR ?= $(DOCS_DIR)/build
RELEASE_KIND := $(filter major minor patch,$(MAKECMDGOALS))

.PHONY: help quality test docs build install uninstall quick rebuild editable \
	 setup download-all clean

.PHONY: release tag major minor patch

help:
	@echo "PyOptik development targets:"
	@echo "  make quality       Run static checks"
	@echo "  make test          Run the offline test suite"
	@echo "  make docs          Build the documentation with warnings as errors"
	@echo "  make build         Build source and wheel distributions"
	@echo "  make install       Install the package"
	@echo "  make editable      Install the package in editable mode"
	@echo "  make setup         Download the complete material snapshot"
	@echo "  make download-all  Download the complete upstream catalog"
	@echo "  make quick         Run quality checks, tests, and build"
	@echo "  make rebuild       Clean, then run the quick workflow"
	@echo "  make clean         Remove generated build and test artifacts"
	@echo "  make release patch Create and push the next patch release"

quality:
	$(PYTHON) -m flake8 PyOptik tests

test:
	MPLBACKEND=Agg MPLCONFIGDIR=$${TMPDIR:-/tmp}/pyoptik-matplotlib \
		$(PYTHON) -m pytest -m 'not network'

docs:
	MPLBACKEND=Agg MPLCONFIGDIR=$${TMPDIR:-/tmp}/pyoptik-matplotlib \
		$(PYTHON) -m sphinx -b html -W --keep-going \
			$(DOCS_DIR)/source $(DOCS_BUILD_DIR)/html

build:
	$(PYTHON) -m build --outdir $(DIST_DIR)

install:
	$(PYTHON) -m pip install .

uninstall:
	$(PYTHON) -m pip uninstall -y PyOptik

quick: quality test build

rebuild: clean quick

editable:
	$(PYTHON) -m pip install --no-build-isolation -e .

setup:
	$(PYTHON) -m PyOptik setup $(ARGS)

download-all:
	$(PYTHON) -m PyOptik download-all $(ARGS)

tag:
	$(PYTHON) tools/release_tag.py "$(VERSION)"

release:
	@test "$(words $(RELEASE_KIND))" -eq 1 || { echo "usage: make release [patch|minor|major]" >&2; exit 2; }
	@set -eu; tag="$$($(PYTHON) tools/next_release_version.py $(RELEASE_KIND))"; $(PYTHON) tools/release_tag.py "$$tag"; git push origin HEAD "refs/tags/$$tag"

major minor patch:
	@:

clean:
	rm -rf $(BUILD_DIR) $(DIST_DIR) $(DOCS_BUILD_DIR) \
		.pytest_cache htmlcov .coverage