-
Notifications
You must be signed in to change notification settings - Fork 118
/
Makefile
212 lines (166 loc) · 7.27 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
src.python := $(shell find ./whylogs -type f -name "*.py")
tst.python := $(shell find ./tests -type f -name "*.py")
src.python.pyc := $(shell find ./whylogs -type f -name "*.pyc")
src.proto.dir := ../proto/src
src.proto := $(shell find $(src.proto.dir) -type f -name "*.proto")
src.proto.v0.dir := ../proto/v0
src.proto.v0 := $(shell find $(src.proto.v0.dir) -type f -name "*.proto")
version := 1.3.31
dist.dir := dist
egg.dir := .eggs
build.dir := build
# This isn't exactly true but its the only thing that we easily know the name of at this point. Its a good proxy for
# the wheel since its created along with it.
build.wheel := $(dist.dir)/whylogs-$(version).tar.gz
build.proto.dir := whylogs/core/proto
build.proto := $(patsubst $(src.proto.dir)/%.proto,$(build.proto.dir)/%_pb2.py,$(src.proto))
build.proto.v0.dir := whylogs/core/proto/v0
build.proto.v0 := $(patsubst $(src.proto.v0.dir)/%.proto,$(build.proto.v0.dir)/%_pb2.py,$(src.proto.v0))
default: dist
release: install pre-commit test dist ## Compile distribution files and run all tests and checks.
pre-commit: proto
@$(call i, Running pre-commit checks)
poetry run pre-commit run --all-files
@# There is no official hook for pyright and the community one requires duplicating config from pyproject.toml
poetry run pyright
.PHONY: dist clean clean-test help format lint test install coverage docs livedocs default proto proto-v0 github release
.PHONY: test-system-python format-fix blackd jupyter-kernel docs livedocs fix
ifeq ($(shell which poetry), )
$(error "Can't find poetry on the path. Install it at https://python-poetry.org/docs.")
endif
install-poetry:
@$(call i, Installing Poetry)
curl -sSL https://install.python-poetry.org | python3 - --version 1.6.1
echo "Add ~/.local/bin to your PATH"
help:
@python -c "$$PRINT_HELP_PYSCRIPT" < $(MAKEFILE_LIST)
bump-patch: ## Bump the patch version (_._.X) everywhere it appears in the project
@$(call i, Bumping the patch number)
poetry run bumpversion patch --allow-dirty
bump-minor: ## Bump the minor version (_.X._) everywhere it appears in the project
@$(call i, Bumping the minor number)
poetry run bumpversion minor --allow-dirty
bump-major: ## Bump the major version (X._._) everywhere it appears in the project
@$(call i, Bumping the major number)
poetry run bumpversion major --allow-dirty
bump-release: ## Convert the version into a release variant (_._._) everywhere it appears in the project
@$(call i, Removing the dev build suffix)
poetry run bumpversion release --allow-dirty
bump-build: ## Bump the build number (_._._-____XX) everywhere it appears in the project
@$(call i, Bumping the build number)
poetry run bumpversion build --allow-dirty
publish: clean dist ## Clean the project, generate new distribution files and publish them to pypi
@$(call i, Publishing the currently built dist to pypi)
poetry publish
blackd:
@$(call i, Running the black server)
poetry run blackd
clean: clean-test ## Remove all build artifacts
rm -rf $(dist.dir)
rm -rf $(build.dir)
rm -f $(src.python.pyc)
rm -rf $(egg.dir)
rm -rf $(build.proto)
rm -rf $(build.proto.v0)
rm -f requirements.txt
clean-test: ## Remove test and coverage artifacts
rm -f .coverage
rm -fr htmlcov/
rm -fr .pytest_cache
dist: $(build.wheel) ## Create distribution tarballs and wheels
docs: ## Use poetry to run the make html command within the proper directory
cd docs && \
poetry run make html
livedocs:
cd docs && \
poetry run make livehtml
$(build.wheel): $(src.python) $(build.proto) $(build.proto.v0)
@$(call i, Generating distribution files)
poetry build
@$(call i, Distribution files created)
@find dist -type f
proto: $(build.proto)
proto-v0: $(build.proto.v0)
requirements.txt:
@$(call i, Generating a requirements.txt file from poetry)
poetry export -f requirements.txt --output requirements.txt --dev
$(build.proto): $(src.proto)
@$(call i, Generating python source for protobuf)
$(eval MYPY := $(shell poetry run which protoc-gen-mypy))
protoc -I $(src.proto.dir) --plugin=protoc-gen-mypy=$(MYPY) --python_out=$(build.proto.dir) $(src.proto) --mypy_out=$(build.proto.dir)
@$(call i, Generating python source for protobuf v0)
$(eval MYPY := $(shell poetry run which protoc-gen-mypy))
protoc -I $(src.proto.v0.dir) --plugin=protoc-gen-mypy=$(MYPY) --python_out=$(build.proto.v0.dir) $(src.proto.v0) --mypy_out=$(build.proto.v0.dir)
poetry run 2to3 --nobackups --write ${build.proto.v0.dir}
$(build.proto.v0): $(src.proto.v0)
@$(call i, Generating python source for protobuf v0)
$(eval MYPY := $(shell poetry run which protoc-gen-mypy))
protoc -I $(src.proto.v0.dir) --plugin=protoc-gen-mypy=$(MYPY) --python_out=$(build.proto.v0.dir) $(src.proto.v0) --mypy_out=$(build.proto.v0.dir)
poetry run 2to3 --nobackups --write ${build.proto.v0.dir}
lint: ## Check code for lint errors.
@$(call i, Running the linter)
poetry run flake8
lint-fix: ## Automatically fix linting issues.
@$(call i, Running the linter)
poetry run autoflake --in-place --remove-all-unused-imports --remove-unused-variables $(src.python) $(tst.python)
fix: lint-fix format-fix ## Automatically fix linting and formatting issues.
format: ## Check style formatting.
@$(call w, format is deprecated running pre-commit instead)
poetry run pre-commit run --all-files
format-fix: ## Fix formatting with pre-commit (black, isort, flake, + configured hooks).
@$(call w, format-fix is deprecated running pre-commit instead)
poetry run pre-commit run --all-files
test: dist ## Run unit tests.
@$(call i, Running tests)
poetry run pytest -v
test-system-python: dist ## Run tests using the system `python` instead of the locally declared poetry python
@$(call i, Running tests using the globally installed python)
python -m poetry run python --version
python -m poetry run pytest -vv --cov='whylogs_v1/.' tests/
test-notebooks: ## Run tests for the notebooks
@$(call i, Running notebook tests)
poetry run pytest --no-cov --maxfail=1 test_notebooks/notebook_tests.py
telemetry-opt-out: ## create opt out file
@$(call i, Creating whylogs telemetry opt-out file)
mkdir ~/.whylogs && echo "" >> ~/.whylogs/disable_telemetry
install: ## Install all dependencies with poetry.
@$(call i, Installing dependencies)
poetry install -E "viz s3 spark mlflow image fugue gcs embeddings proc"
coverage: ## Generate test coverage reports.
@$(call i, Generating test coverage)
poetry run pytest --cov='whylogs_v1/.' tests/
poetry run python -m coverage report
jupyter-kernel: ## Install a kernel for this workspace in Jupyter. You should have jupyterlab installed on your system.
@$(call i, Installing a kernel for this workspace for Jupyter)
poetry run python -m ipykernel install --user --name=whylogs-v1-dev
define BROWSER_PYSCRIPT
import os, webbrowser, sys
from urllib.request import pathname2url
webbrowser.open("file://" + pathname2url(os.path.abspath(sys.argv[1])))
endef
export BROWSER_PYSCRIPT
BROWSER := poetry run python -c "$$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
define i
echo
python highlight/colors.py INFO "$1"
echo
endef
define w
echo
python highlight/colors.py WARN "$1"
echo
endef
define e
echo
python highlight/colors.py ERROR "$1"
echo
endef