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
|
#!/usr/bin/make -f
PYTHON=python3
SPHINX_APIDOC=sphinx-apidoc
TARGET=bpack
.PHONY: default help dist check fullcheck coverage clean cleaner distclean \
lint docs api
default: help
help:
@echo "Usage: make <TARGET>"
@echo "Available targets:"
@echo " help - print this help message"
@echo " dist - generate the distribution packages (source and wheel)"
@echo " check - run a full test (using pytest)"
@echo " fullcheck - run a full test (using tox)"
@echo " coverage - run tests and generate the coverage report"
@echo " clean - clean build artifacts"
@echo " cleaner - clean cache files and working directories of al tools"
@echo " distclean - clean all the generated files"
@echo " lint - perform check with code linter (flake8, black)"
@echo " docs - generate the sphinx documentation"
@echo " api - update the API source files in the documentation"
dist:
$(PYTHON) -m build
$(PYTHON) -m twine check dist/*.tar.gz dist/*.whl
check:
$(PYTHON) -m pytest --doctest-modules $(TARGET)
fullcheck:
$(PYTHON) -m tox run
coverage:
$(PYTHON) -m pytest --doctest-modules --cov=$(TARGET) --cov-report=html --cov-report=term
clean:
$(RM) -r *.*-info build
find . -name __pycache__ -type d -exec $(RM) -r {} +
# $(RM) -r __pycache__ */__pycache__ */*/__pycache__ */*/*/__pycache__
$(RM) $(TARGET)/*.c $(TARGET)/*.cpp $(TARGET)/*.so $(TARGET)/*.o
if [ -f docs/Makefile ] ; then $(MAKE) -C docs clean; fi
$(RM) -r docs/_build
cleaner: clean
$(RM) -r .coverage htmlcov
$(RM) -r .pytest_cache .tox
$(RM) -r .mypy_cache .ruff_cache
$(RM) -r .ipynb_checkpoints
distclean: cleaner
$(RM) -r dist
lint:
$(PYTHON) -m flake8 --count --statistics $(TARGET)
$(PYTHON) -m pydocstyle --count $(TARGET)
$(PYTHON) -m isort --check $(TARGET)
$(PYTHON) -m black --check $(TARGET)
# $(PYTHON) -m mypy --check-untyped-defs --ignore-missing-imports $(TARGET)
# ruff check $(TARGET)
docs:
mkdir -p docs/_static
$(MAKE) -C docs html
api:
$(RM) -r docs/api
$(SPHINX_APIDOC) --module-first --separate --no-toc -o docs/api \
--doc-project "$(TARGET) API" --templatedir docs/_templates/apidoc \
$(TARGET) $(TARGET)/tests
|
