-
Notifications
You must be signed in to change notification settings - Fork 5
/
Makefile
211 lines (161 loc) · 5.8 KB
/
Makefile
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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
# Project settings
PROJECT := verchew
PACKAGE := verchew
REPOSITORY := jacebrowning/verchew
# Project paths
PACKAGES := $(PACKAGE) tests
CONFIG := $(wildcard *.py)
MODULES := $(wildcard $(PACKAGE)/*.py)
# Virtual environment paths
VIRTUAL_ENV ?= .venv
# MAIN TASKS ##################################################################
.PHONY: all
all: format check test mkdocs ## Run all tasks that determine CI status
.PHONY: dev
dev: install .clean-test ## Continuously run all CI tasks when files chanage
poetry run sniffer
.PHONY: run ## Start the program
run: install
poetry run python $(PACKAGE)/__main__.py
.PHONY: ipython ## Launch an IPython session
ipython: install
poetry run ipython --ipython-dir=notebooks
# SYSTEM DEPENDENCIES #########################################################
.PHONY: doctor
doctor: ## Confirm system dependencies are available
bin/verchew
# PROJECT DEPENDENCIES ########################################################
DEPENDENCIES := $(VIRTUAL_ENV)/.poetry-$(shell bin/checksum pyproject.toml poetry.lock)
.PHONY: install
install: $(DEPENDENCIES) .cache
$(DEPENDENCIES): poetry.lock
@ poetry config virtualenvs.in-project true
poetry install
@ touch $@
ifndef CI
poetry.lock: pyproject.toml
poetry lock --no-update
@ touch $@
endif
.cache:
@ mkdir -p .cache
# CHECKS ######################################################################
.PHONY: format
format: install
poetry run isort $(PACKAGES) notebooks
poetry run black $(PACKAGES) notebooks
@ echo
.PHONY: check
check: install format ## Run formaters, linters, and static analysis
ifdef CI
git diff --exit-code
endif
poetry run mypy $(PACKAGES) --config-file=.mypy.ini
poetry run pylint $(PACKAGES) --rcfile=.pylint.ini
poetry run pydocstyle $(PACKAGES) $(CONFIG)
# TESTS #######################################################################
RANDOM_SEED ?= $(shell date +%s)
FAILURES := .cache/v/cache/lastfailed
PYTEST_OPTIONS := --random --random-seed=$(RANDOM_SEED)
ifndef DISABLE_COVERAGE
PYTEST_OPTIONS += --cov=$(PACKAGE)
endif
PYTEST_RERUN_OPTIONS := --last-failed --exitfirst
.PHONY: test
test: test-all ## Run unit and integration tests
.PHONY: test-unit
test-unit: install
@ ( mv $(FAILURES) $(FAILURES).bak || true ) > /dev/null 2>&1
poetry run pytest $(PACKAGE) $(PYTEST_OPTIONS)
@ ( mv $(FAILURES).bak $(FAILURES) || true ) > /dev/null 2>&1
poetry run coveragespace update unit
.PHONY: test-int
test-int: install
@ if test -e $(FAILURES); then poetry run pytest tests $(PYTEST_RERUN_OPTIONS); fi
@ rm -rf $(FAILURES)
poetry run pytest tests $(PYTEST_OPTIONS)
poetry run coveragespace update integration
.PHONY: test-all
test-all: install
@ if test -e $(FAILURES); then poetry run pytest $(PACKAGES) $(PYTEST_RERUN_OPTIONS); fi
@ rm -rf $(FAILURES)
poetry run pytest $(PACKAGES) $(PYTEST_OPTIONS)
poetry run coveragespace update overall
.PHONY: read-coverage
read-coverage:
bin/open htmlcov/index.html
# DOCUMENTATION ###############################################################
MKDOCS_INDEX := site/index.html
.PHONY: docs
docs: mkdocs uml ## Generate documentation and UML
.PHONY: mkdocs
mkdocs: install $(MKDOCS_INDEX)
$(MKDOCS_INDEX): docs/requirements.txt mkdocs.yml docs/*.md
@ mkdir -p docs/about
@ cd docs && ln -sf ../README.md index.md
@ cd docs/about && ln -sf ../../CHANGELOG.md changelog.md
@ cd docs/about && ln -sf ../../CONTRIBUTING.md contributing.md
@ cd docs/about && ln -sf ../../LICENSE.md license.md
poetry run mkdocs build --clean --strict
docs/requirements.txt: poetry.lock
@ rm -f $@
@ poetry export --with dev --without-hashes | grep jinja2 >> $@
@ poetry export --with dev --without-hashes | grep markdown >> $@
@ poetry export --with dev --without-hashes | grep mkdocs >> $@
@ poetry export --with dev --without-hashes | grep pygments >> $@
@ poetry export --with dev --without-hashes | grep importlib-metadata >> $@
.PHONY: uml
uml: install docs/*.png
docs/*.png: $(MODULES)
poetry run pyreverse $(PACKAGE) -p $(PACKAGE) -a 1 -f ALL -o png --ignore tests
- mv -f classes_$(PACKAGE).png docs/classes.png
- mv -f packages_$(PACKAGE).png docs/packages.png
.PHONY: mkdocs-serve
mkdocs-serve: mkdocs
eval "sleep 3; bin/open http://127.0.0.1:8000" &
poetry run mkdocs serve
# BUILD #######################################################################
DIST_FILES := dist/*.tar.gz dist/*.whl
EXE_FILES := dist/$(PROJECT).*
.PHONY: dist
dist: install $(DIST_FILES)
$(DIST_FILES): $(MODULES) pyproject.toml
rm -f $(DIST_FILES)
poetry build
.PHONY: exe
exe: install $(EXE_FILES)
$(EXE_FILES): $(MODULES) $(PROJECT).spec
# For framework/shared support: https://github.com/yyuu/pyenv/wiki
poetry run pyinstaller $(PROJECT).spec --noconfirm --clean
$(PROJECT).spec:
poetry run pyi-makespec $(PACKAGE)/__main__.py --onefile --windowed --name=$(PROJECT)
# RELEASE #####################################################################
.PHONY: upload
upload: dist ## Upload the current version to PyPI
git diff --name-only --exit-code
poetry publish
bin/open https://pypi.org/project/$(PROJECT)
# CLEANUP #####################################################################
.PHONY: clean
clean: .clean-build .clean-docs .clean-test .clean-install ## Delete all generated and temporary files
.PHONY: clean-all
clean-all: clean
rm -rf $(VIRTUAL_ENV)
.PHONY: .clean-install
.clean-install:
find $(PACKAGES) -name '__pycache__' -delete
rm -rf *.egg-info
.PHONY: .clean-test
.clean-test:
rm -rf .cache .pytest .coverage htmlcov
.PHONY: .clean-docs
.clean-docs:
rm -rf docs/*.png site
.PHONY: .clean-build
.clean-build:
rm -rf *.spec dist build
# HELP ########################################################################
.PHONY: help
help: install
@ grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
.DEFAULT_GOAL := help