-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathMakefile
144 lines (87 loc) · 3 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
# Declare global variables
BASE_DIR = ${PWD}
PACKAGE_NAME = matplotlib-radar
PACKAGE_DIR = $(BASE_DIR)/matplotlib_radar
TEST_DIR = $(BASE_DIR)/tests
DOCS_DIR = $(BASE_DIR)/docs
PYTHON_OPT = python3
PIP_OPT = $(PYTHON_OPT) -m pip --require-virtualenv
MYPY_OPT = $(PYTHON_OPT) -m mypy
TEST_OPT = $(PYTHON_OPT) -m pytest
TWINE_OPT = $(PYTHON_OPT) -m twine
SPHINX_OPT = $(PYTHON_OPT) -m sphinx
COVERAGE_OPT = $(PYTHON_OPT) -m coverage
FLIT_OPT = $(PYTHON_OPT) -m flit
RUFF_OPT = $(PYTHON_OPT) -m ruff
PRE_COMMIT_OPT = pre-commit
# Run help by default
.DEFAULT_GOAL := help
.PHONY : help
help: ## This help.
@awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z_-]+:.*?## / {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST)
# Dependency handling
.PHONY : install
install: ## install all python dependencies
# Install dev dependencies
@$(PIP_OPT) install -e ".[test,docs]" --upgrade
.PHONY : freeze
freeze: ## Freeze package dependencies
@$(PYTHON_OPT) --version > .python-version
@$(PIP_OPT) freeze --exclude $(PACKAGE_NAME) > requirements.txt
.PHONY : build
build: # Twine package upload and checks
# Remove old keggtools package
@$(PIP_OPT) uninstall $(PACKAGE_NAME) -y --quiet
# Remove dist folder
@rm -rf ./dist/*
# Build package with flit backend
@$(FLIT_OPT) build --setup-py
# Check package using twine
@$(TWINE_OPT) check --strict ./dist/*
# Install package with flit
@$(FLIT_OPT) install --deps=none
.PHONY : format
format: ## Lint and format code with flake8 and black
@$(RUFF_OPT) format $(PACKAGE_DIR) $(TEST_DIR) $(DOCS_DIR)/source/conf.py
@$(RUFF_OPT) check --fix $(PACKAGE_DIR) $(TEST_DIR) $(DOCS_DIR)/source/conf.py
.PHONY: testing
testing: ## Unittest of package
# @$(TEST_OPT) --show-capture=log
@$(COVERAGE_OPT) run -m pytest
@$(COVERAGE_OPT) html
# Long coverage report
@$(COVERAGE_OPT) report -m
.PHONY: typing
typing: ## Run static code analysis
@$(MYPY_OPT) $(PACKAGE_DIR) $(TEST_DIR) $(DOCS_DIR)/source/conf.py
.PHONY: clean
clean: ## Clean all build and caching directories
# Remove package build folders
@rm -rf ./build
@rm -rf ./dist
@rm -rf ./$(PACKAGE_NAME).egg-info
# Remove mypy and pytest caching folders
@rm -rf ./.mypy_cache
@rm -rf ./.pytest_cache
@rm -rf ./coverage
@rm -f .coverage
# Remove build folders for docs
@rm -rf ./docs/_build
@rm -rf ./docs/dist
.PHONY: docs
docs: ## Build sphinx docs
@rm -rf ./docs/_build
@$(SPHINX_OPT) -M doctest $(DOCS_DIR)/source $(DOCS_DIR)/_build
@$(SPHINX_OPT) -M coverage $(DOCS_DIR)/source $(DOCS_DIR)/_build
# Build HTML version
@$(SPHINX_OPT) -M html $(DOCS_DIR)/source $(DOCS_DIR)/_build
.PHONY : open-docs
open-docs: ## Open build docs in webbrowser
@$(PYTHON_OPT) -m webbrowser -t file:///${PWD}/docs/_build/html/index.html
# Run all checks (always before committing!)
.PHONY: check
check: install freeze format typing testing build docs precommit ## Full check of package
.PHONY : precommit
precommit: ## Run precommit file
# @pre-commit run --all-files --verbose
@$(PRE_COMMIT_OPT) run --all-files