-
Notifications
You must be signed in to change notification settings - Fork 27
/
Makefile
179 lines (150 loc) · 5.4 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
#################################################################################
# This Makefile is self-documented
# Use ## before target to provide a description
#################################################################################
.DEFAULT_GOAL := help
SHELL = /bin/bash
#################################################################################
# INSTALL/SETUP COMMANDS #
#################################################################################
.PHONY: install, install-dev
## Install this package
install:
pipenv install .
## Install this package with packages required for development
install-dev:
pipenv install -e '.[tests, docs]'
#################################################################################
# CHECK CODE QUALITY COMMANDS #
#################################################################################
.PHONY: test test-cov check-code check-all
## Run pytest
test:
pipenv run pytest -v hottbox
## Run pytest with coverage
test-cov:
pipenv run pytest -v --cov hottbox --cov-branch --cov-report term-missing
## Check code quality
check-code:
pipenv run bandit -r hottbox -c bandit.yml -f html -o .reports/hottbox-bandit.html
## Run full check of hottbox
check-all: test-cov check-code
#################################################################################
# CLEAN COMMANDS #
#################################################################################
.PHONY: clean clean-build clean-test clean-all
## Remove Python file artifacts
clean:
find . -name '*.pyc' -exec rm -f {} +
find . -name '*.pyo' -exec rm -f {} +
find . -name '*~' -exec rm -f {} +
find . -name '__pycache__' -exec rm -fr {} +
## Remove build artifacts
clean-build:
rm -fr build/
rm -fr dist/
rm -fr .eggs/
find . -name '*.egg-info' -exec rm -fr {} +
find . -name '*.egg' -exec rm -f {} +
## Remove test and coverage artifacts
clean-test:
find . -name '*.coverage' -exec rm -f {} +
find . -name '*.coverage.*' -exec rm -f {} +
rm -fr .tox/
rm -fr htmlcov/
rm -fr .reports/
rm -fr .pytest_cache
## Remove all build, test, coverage and Python artifacts
clean-all: clean clean-build clean-test
#################################################################################
# DOCKER RELATED COMMANDS #
#################################################################################
.PHONY: base-image dev-image dev-container
## Create base docker image
base-image:
@printf "\n\n"
@printf "======================================\n"
@printf "=== ===\n"
@printf "=== Creating base docker image ===\n"
@printf "=== ===\n"
@printf "======================================\n\n"
docker build -t hottbox-dev-base \
-f docker/hottbox-dev-base.dockerfile \
.
## Create docker image with hottbox installed in development mode
dev-image: base-image
@printf "\n\n"
@printf "=============================================\n"
@printf "=== ===\n"
@printf "=== Creating development docker image ===\n"
@printf "=== ===\n"
@printf "=============================================\n\n"
docker build -t hottbox-dev \
-f docker/hottbox-dev.dockerfile \
.
## Run docker container with hottbox installed in development mode
dev-container:
docker run -it --hostname=localhost --rm hottbox-dev
#################################################################################
# For self-documenting of Makefile: use '##' before target to provide a description
#
# References:
# https://marmelab.com/blog/2016/02/29/auto-documented-makefile.html
# https://github.com/drivendata/cookiecutter-data-science/blob/master/%7B%7B%20cookiecutter.repo_name%20%7D%7D/Makefile
#
# sed script explained:
# /^##/:
# * save line in hold space
# * purge line
# * Loop:
# * append newline + line to hold space
# * go to next line
# * if line starts with doc comment, strip comment character off and loop
# * remove target prerequisites
# * append hold space (+ newline) to line
# * replace newline plus comments by `---`
# * print line
# Separate expressions are necessary because labels cannot be delimited by
# semicolon; see <http://stackoverflow.com/a/11799865/1968>
#
#################################################################################
.PHONY: help
## Show this message
help:
@echo "$$(tput bold)Available rules:$$(tput sgr0)"
@echo
@sed -n -e "/^## / { \
h; \
s/.*//; \
:doc" \
-e "H; \
n; \
s/^## //; \
t doc" \
-e "s/:.*//; \
G; \
s/\\n## /---/; \
s/\\n/ /g; \
p; \
}" ${MAKEFILE_LIST} \
| LC_ALL='C' sort --ignore-case \
| awk -F '---' \
-v ncol=$$(tput cols) \
-v indent=25 \
-v col_on="$$(tput setaf 6)" \
-v col_off="$$(tput sgr0)" \
'{ \
printf "%s%*s%s ", col_on, -indent, $$1, col_off; \
n = split($$2, words, " "); \
line_length = ncol - indent; \
for (i = 1; i <= n; i++) { \
line_length -= length(words[i]) + 1; \
if (line_length <= 0) { \
line_length = ncol - indent - length(words[i]) - 1; \
printf "\n%*s ", -indent, " "; \
} \
printf "%s ", words[i]; \
} \
printf "\n"; \
}' \
| more $(shell test $(shell uname) = Darwin && echo '--no-init --raw-control-chars')