This repository has been archived by the owner on Dec 19, 2023. It is now read-only.
forked from robinhood/faust
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Makefile
269 lines (207 loc) · 6.69 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
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
PROJ ?= faust
PGPIDENT? = "Celery Security Team"
PYTHON ?= python
PYTEST ?= py.test
PIP ?= pip
GIT ?= git
TOX ?= tox
NOSETESTS ?= nosetests
ICONV ?= iconv
FLAKE8 ?= flake8
PYDOCSTYLE ?= pydocstyle
MYPY ?= mypy
SPHINX2RST ?= sphinx2rst
BUMPVERSION ?= bumpversion
VULTURE ?= vulture
VULTURE_MIN_CONFIDENCE ?= 100
PRE_COMMIT ?= pre-commit
DMYPY ?= dmypy
BANDIT ?= bandit
RENDER_CONFIGREF ?= extra/tools/render_configuration_reference.py
CONFIGREF_TARGET ?= docs/includes/settingref.txt
TESTDIR ?= t
EXAMPLESDIR ?= examples
SPHINX_DIR ?= docs/
SPHINX_BUILDDIR ?= "${SPHINX_DIR}/_build"
README ?= README.rst
README_SRC ?= "docs/templates/readme.txt"
CONTRIBUTING ?= CONTRIBUTING.rst
CONTRIBUTING_SRC ?= "docs/contributing.rst"
COC ?= .github/CODE_OF_CONDUCT.md
COC_SRC ?= "docs/includes/code-of-conduct.txt"
SPHINX_HTMLDIR ?= "${SPHINX_BUILDDIR}/html"
DOCUMENTATION ?= Documentation
all: help
help:
@echo "docs - Build documentation."
@echo "livedocs - Start documentation live web server."
@echo "develop - Start contributing to Faust"
@echo " develop-hooks - Install Git commit hooks (required)"
@echo " reqs" - Install requirements
@echo " setup-develop - Run setup.py develop"
@echo "cdevelop - Like develop but installs C extensions"
@echo " reqs-rocksdb - Install python-rocksdb (require rocksdb)"
@echo " reqs-fast - Install C optimizations"
@echo " reqs-uvloop - Install uvloop extension"
@echo "test-all - Run tests for all supported python versions."
@echo "distcheck ---------- - Check distribution for problems."
@echo " test - Run unittests using current python."
@echo " lint ------------ - Check codebase for problems."
@echo " apicheck - Check API reference coverage."
@echo " configcheck - Check configuration reference coverage."
@echo " readmecheck - Check README.rst encoding."
@echo " contribcheck - Check CONTRIBUTING.rst encoding"
@echo " flakes -------- - Check code for syntax and style errors."
@echo " flakecheck - Run flake8 on the source code."
@echo " typecheck - Run the mypy type checker"
@echo " pep257check - Run pep257 on the source code."
@echo " vulture - Run vulture to find unused code."
@echo "readme - Regenerate README.rst file."
@echo "contrib - Regenerate CONTRIBUTING.rst file"
@echo "configref - Regenerate docs/userguide/settings.rst"
@echo "coc - Regenerate CODE_OF_CONDUCT.rst file"
@echo "clean-dist --------- - Clean all distribution build artifacts."
@echo " clean-git-force - Remove all uncommitted files."
@echo " clean ------------ - Non-destructive clean"
@echo " clean-pyc - Remove .pyc/__pycache__ files"
@echo " clean-docs - Remove documentation build artifacts."
@echo " clean-build - Remove setup artifacts."
@echo "bump - Bump patch version number."
@echo "bump-minor - Bump minor version number."
@echo "bump-major - Bump major version number."
@echo "hooks" - Update pre-commit hooks
@echo "release - Make PyPI release."
clean: clean-docs clean-pyc clean-build
clean-dist: clean clean-git-force
bump:
$(BUMPVERSION) patch
bump-minor:
$(BUMPVERSION) minor
bump-major:
$(BUMPVERSION) major
release:
$(PYTHON) setup.py register sdist bdist_wheel upload --sign --identity="$(PGPIDENT)"
. PHONY: Documentation
Documentation:
$(PIP) install -r requirements/docs.txt
(cd "$(SPHINX_DIR)"; $(MAKE) html)
mv "$(SPHINX_HTMLDIR)" $(DOCUMENTATION)
. PHONY: docs
docs: Documentation
. PHONY: livedocs
livedocs:
$(PIP) install -r requirements/docs.txt
$(PIP) install -r requirements/dist.txt
(cd "$(SPHINX_DIR)"; $(MAKE) livehtml)
clean-docs:
-rm -rf "$(SPHINX_BUILDDIR)"
lint: flakecheck apicheck configcheck readmecheck pep257check vulture
apicheck:
(cd "$(SPHINX_DIR)"; $(MAKE) apicheck)
configcheck:
(cd "$(SPHINX_DIR)"; $(MAKE) configcheck)
spell:
(cd "$(SPHINX_DIR)"; $(MAKE) spell)
flakecheck:
$(FLAKE8) "$(PROJ)" "$(TESTDIR)" examples/
docstylecheck:
$(PYDOCSTYLE) --match-dir '(?!types|assignor)' "$(PROJ)"
vulture:
$(VULTURE) "$(PROJ)" "$(TESTDIR)" "$(EXAMPLESDIR)" \
--min-confidence="$(VULTURE_MIN_CONFIDENCE)"
flakediag:
-$(MAKE) flakecheck
flakes: flakediag
clean-readme:
-rm -f $(README)
readmecheck:
$(ICONV) -f ascii -t ascii $(README) >/dev/null
$(README):
$(SPHINX2RST) "$(README_SRC)" --ascii > $@
readme: clean-readme $(README) readmecheck
clean-contrib:
-rm -f "$(CONTRIBUTING)"
$(CONTRIBUTING):
$(SPHINX2RST) "$(CONTRIBUTING_SRC)" > $@
contrib: clean-contrib $(CONTRIBUTING)
configref:
$(PYTHON) $(RENDER_CONFIGREF) > $(CONFIGREF_TARGET)
clean-coc:
-rm -f "$(COC)"
$(COC):
$(SPHINX2RST) "$(COC_SRC)" > $@
coc: clean-coc $(COC)
clean-pyc:
-find . -type f -a \( -name "*.pyc" -o -name "*$$py.class" \) | xargs rm
-find . -type d -name "__pycache__" | xargs rm -r
removepyc: clean-pyc
clean-build:
rm -rf build/ dist/ .eggs/ *.egg-info/ .tox/ .coverage cover/
clean-git:
$(GIT) clean -xdn
clean-git-force:
$(GIT) clean -xdf
test-all: clean-pyc
$(TOX)
test:
$(PYTHON) setup.py test
build:
$(PYTHON) setup.py sdist bdist_wheel
distcheck: lint test clean
dist: readme contrib clean-dist build
typecheck:
$(MYPY) -p $(PROJ)
.PHONY: requirements
requirements:
$(PIP) install --upgrade pip;\
for f in `ls requirements/`; do if [[ $$f =~ \.txt$$ ]]; then $(PIP) install -r requirements/$$f; fi; done
.PHONY: clean-requirements
clean-requirements:
pip freeze | xargs pip uninstall -y
$(MAKE) requirements
.PHONY:
hooks:
$(PRE_COMMIT) install
.PHONY:
cdevelop: develop reqs-ext
.PHONY:
develop: reqs develop-hooks setup-develop
.PHONY:
develop-hooks: hooks
.PHONY:
reqs: reqs-default reqs-test reqs-dist reqs-docs reqs-ci reqs-debug
.PHONY:
reqs-default:
$(PIP) install -U -r requirements/default.txt
.PHONY:
reqs-test:
$(PIP) install -U -r requirements/test.txt
.PHONY:
reqs-docs:
$(PIP) install -U -r requirements/docs.txt
.PHONY:
reqs-dist:
$(PIP) install -U -r requirements/dist.txt
.PHONY:
reqs-ci:
$(PIP) install -U -r requirements/ci.txt
.PHONY:
reqs-debug:
$(PIP) install -U -r requirements/extras/debug.txt
.PHONY:
reqs-ext: reqs-rocksdb reqs-fast reqs-uvloop
.PHONY:
reqs-rocksdb:
$(PIP) install --no-cache -U -r requirements/extras/rocksdb.txt
.PHONY:
reqs-fast:
$(PIP) install --no-cache -U -r requirements/extras/fast.txt
.PHONY:
reqs-uvloop:
$(PIP) install --no-cache -U -r requirements/extras/uvloop.txt
.PHONY:
setup-develop:
$(PYTHON) setup.py develop
.PHONY:
update-bandit:
$(BANDIT) -o extra/bandit/baseline.json -f json -c extra/bandit/config.yaml -r "$(PROJ)"