-
Notifications
You must be signed in to change notification settings - Fork 45
/
Makefile
234 lines (176 loc) · 6.12 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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
.DEFAULT_GOAL := help
define BROWSER_PYSCRIPT
import os, webbrowser, sys
try:
from urllib import pathname2url
except:
from urllib.request import pathname2url
webbrowser.open("file://" + pathname2url(os.path.abspath(sys.argv[1])))
endef
export BROWSER_PYSCRIPT
define PRINT_HELP_PYSCRIPT
import re, sys
for line in sys.stdin:
match = re.match(r'^([a-zA-Z_-]+):.*?## (.*)$$', line)
if match:
target, help = match.groups()
print("%-20s %s" % (target, help))
endef
export PRINT_HELP_PYSCRIPT
BROWSER := python -c "$$BROWSER_PYSCRIPT"
.PHONY: help
help:
@python -c "$$PRINT_HELP_PYSCRIPT" < $(MAKEFILE_LIST)
# CLEAN TARGETS
.PHONY: clean-build
clean-build: ## remove build artifacts
rm -fr build/
rm -fr dist/
rm -fr .eggs/
find . -name '*.egg-info' -exec rm -fr {} +
find . -name '*.egg' -exec rm -f {} +
.PHONY: clean-pyc
clean-pyc: ## remove Python file artifacts
find . -name '*.pyc' -exec rm -f {} +
find . -name '*.pyo' -exec rm -f {} +
find . -name '*~' -exec rm -f {} +
find . -name '__pycache__' -exec rm -fr {} +
.PHONY: clean-coverage
clean-coverage: ## remove coverage artifacts
rm -f .coverage
rm -f .coverage.*
rm -fr htmlcov/
.PHONY: clean-test
clean-test: ## remove test artifacts
rm -fr .tox/
rm -fr .pytest_cache
.PHONY: clean
clean: clean-build clean-pyc clean-test clean-coverage ## remove all build, test, coverage and Python artifacts
# INSTALL TARGETS
.PHONY: install
install: clean-build clean-pyc ## install the package to the active Python's site-packages
pip install .
.PHONY: install-test
install-test: clean-build clean-pyc ## install the package and test dependencies
pip install .[test]
.PHONY: install-develop
install-develop: clean-build clean-pyc ## install the package in editable mode and dependencies for development
pip install -e .[dev]
# LINT TARGETS
.PHONY: lint
lint:
invoke lint
.PHONY: fix-lint
fix-lint:
invoke fix-lint
# TEST TARGETS
.PHONY: test-unit
test-unit: ## run tests quickly with the default Python
invoke unit
.PHONY: test-integration
test-integration: ## run integration tests
invoke integration
.PHONY: test-readme
test-readme: ## run the readme snippets
invoke readme
.PHONY: test
test: test-unit test-integration test-readme ## test everything that needs test dependencies
.PHONY: test-devel
test-devel: lint ## test everything that needs development dependencies
.PHONY: test-all
test-all: ## run tests on every Python version with tox
tox -r
.PHONY: coverage
coverage: ## check code coverage quickly with the default Python
coverage run --source sdmetrics -m pytest
coverage report -m
coverage html
$(BROWSER) htmlcov/index.html
# RELEASE TARGETS
.PHONY: dist
dist: clean ## builds source and wheel package
python -m build --wheel --sdist
ls -l dist
.PHONY: publish-confirm
publish-confirm:
@echo "WARNING: This will irreversibly upload a new version to PyPI!"
@echo -n "Please type 'confirm' to proceed: " \
&& read answer \
&& [ "$${answer}" = "confirm" ]
.PHONY: publish-test
publish-test: dist publish-confirm ## package and upload a release on TestPyPI
twine upload --repository-url https://test.pypi.org/legacy/ dist/*
.PHONY: publish
publish: dist publish-confirm ## package and upload a release
twine upload dist/*
.PHONY: bumpversion-release
bumpversion-release: ## Merge main to stable and bumpversion release
git checkout stable || git checkout -b stable
git merge --no-ff main -m"make release-tag: Merge branch 'main' into stable"
bump-my-version bump release
git push --tags origin stable
.PHONY: bumpversion-release-test
bumpversion-release-test: ## Merge main to stable and bumpversion release
git checkout stable || git checkout -b stable
git merge --no-ff main -m"make release-tag: Merge branch 'main' into stable"
bump-my-version bump release --no-tag
@echo git push --tags origin stable
.PHONY: bumpversion-patch
bumpversion-patch: ## Merge stable to main and bumpversion patch
git checkout main
git merge stable
bump-my-version bump --no-tag patch
git push
.PHONY: bumpversion-candidate
bumpversion-candidate: ## Bump the version to the next candidate
bump-my-version bump candidate --no-tag
.PHONY: bumpversion-minor
bumpversion-minor: ## Bump the version the next minor skipping the release
bump-my-version bump --no-tag minor
.PHONY: bumpversion-major
bumpversion-major: ## Bump the version the next major skipping the release
bump-my-version bump --no-tag major
.PHONY: bumpversion-revert
bumpversion-revert: ## Undo a previous bumpversion-release
git checkout main
git branch -D stable
CLEAN_DIR := $(shell git status --short | grep -v ??)
CURRENT_BRANCH := $(shell git rev-parse --abbrev-ref HEAD 2>/dev/null)
CHANGELOG_LINES := $(shell git diff HEAD..origin/stable HISTORY.md 2>&1 | wc -l)
.PHONY: check-clean
check-clean: ## Check if the directory has uncommitted changes
ifneq ($(CLEAN_DIR),)
$(error There are uncommitted changes)
endif
.PHONY: check-main
check-main: ## Check if we are in main branch
ifneq ($(CURRENT_BRANCH),main)
$(error Please make the release from main branch\n)
endif
.PHONY: check-history
check-history: ## Check if HISTORY.md has been modified
ifeq ($(CHANGELOG_LINES),0)
$(error Please insert the release notes in HISTORY.md before releasing)
endif
.PHONY: check-deps
check-deps: # Dependency targets
$(eval allow_list='numpy=|pandas=|scikit-learn=|scipy=|tqdm=|plotly=|copulas=')
pip freeze | grep -v "SDMetrics.git" | grep -E $(allow_list) | sort > $(OUTPUT_FILEPATH)
.PHONY: git-push
git-push: ## Simply push the repository to github
git push
.PHONY: check-release
check-release: check-clean check-main check-history ## Check if the release can be made
@echo "A new release can be made"
.PHONY: release
release: check-release bumpversion-release publish bumpversion-patch
.PHONY: release-test
release-test: check-release bumpversion-release-test publish-test bumpversion-revert
.PHONY: release-candidate
release-candidate: check-main publish bumpversion-candidate git-push
.PHONY: release-candidate-test
release-candidate-test: check-clean check-main publish-test
.PHONY: release-minor
release-minor: check-release bumpversion-minor release
.PHONY: release-major
release-major: check-release bumpversion-major release