-
Notifications
You must be signed in to change notification settings - Fork 0
/
Makefile
102 lines (79 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
MODULE := thermal_conductivity_step
.PHONY: help clean clean-build clean-docs clean-pyc clean-test lint format typing test
.PHONY: dependencies test-all coverage html docs servedocs release check-release
.PHONY: dist install uninstall
.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"
help:
@python -c "$$PRINT_HELP_PYSCRIPT" < $(MAKEFILE_LIST)
clean: clean-build clean-pyc clean-test ## remove all build, test, coverage and Python artifacts
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 {} +
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 {} +
clean-test: ## remove test and coverage artifacts
rm -fr .tox/
rm -f .coverage
rm -fr htmlcov/
find . -name '.pytype' -exec rm -fr {} +
lint: ## check style with black and flake8
black --extend-exclude '_version.py' --check --diff $(MODULE) tests
flake8 --color never $(MODULE) tests
format: ## reformat with with yapf and isort
black --extend-exclude '_version.py' $(MODULE) tests
test: ## run tests quickly with the default Python
pytest tests/
coverage: ## check code coverage quickly with the default Python
pytest -v --cov=$(MODULE) --cov-report term --color=yes tests/
coverage-html: ## check code coverage quickly with the default Python, showing as html
pytest -v --cov=$(MODULE) --cov-report=html:htmlcov --cov-report term --color=yes tests/
$(BROWSER) htmlcov/index.html
clean-docs: ## remove files associated with building the docs
rm -f docs/api/$(MODULE).rst
rm -f docs/api/modules.rst
$(MAKE) -C docs clean
html: clean-docs ## generate Sphinx HTML documentation, including API docs
sphinx-apidoc -o docs/api $(MODULE)
$(MAKE) -C docs html
rm -f docs/api/$(MODULE).rst
rm -f docs/api/modules.rst
docs: html ## Make the html docs and show in the browser
$(BROWSER) docs/_build/html/index.html
servedocs: docs ## compile the docs watching for changes
watchmedo shell-command -p '*.rst' -c '$(MAKE) -C docs html' -R -D .
release: dist ## package and upload a release
python -m twine upload dist/*
check-release: dist ## check the release for errors
python -m twine check dist/*
dist: clean ## builds source and wheel package
python -m build
ls -l dist
install: uninstall ## install the package to the active Python's site-packages
pip install .
uninstall: clean ## uninstall the package
pip uninstall --yes $(MODULE)