forked from pik-primap/primap2
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Makefile
96 lines (74 loc) · 2.79 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
.PHONY: clean clean-test clean-pyc clean-build docs help virtual-environment install-pre-commit stubs update-venv README.rst
.DEFAULT_GOAL := help
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
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/
rm -fr .pytest_cache
lint: venv ## check style with pre-commit hooks
venv/bin/pre-commit run --all-files
test: venv ## run tests quickly with the default Python
venv/bin/pytest --xdoc -rx
test-all: ## run tests on every Python version with tox
tox -p
coverage: venv ## check code coverage quickly with the default Python
venv/bin/coverage run --source primap2 -m pytest
venv/bin/coverage report -m
venv/bin/coverage html
ls htmlcov/index.html
docs: venv ## generate Sphinx HTML documentation, including API docs
rm -rf docs/generated
$(MAKE) -C docs clean
$(MAKE) -C docs html
servedocs: docs ## compile the docs watching for changes
watchmedo shell-command -p '*.rst' -c '$(MAKE) -C docs html' -R -D .
release: venv dist ## package and upload a release
venv/bin/twine upload dist/*
dist: clean venv ## builds source and wheel package
venv/bin/python -m build
ls -l dist
install: clean ## install the package to the active Python's site-packages
python setup.py install
virtual-environment: venv ## setup a virtual environment for development
venv: requirements_dev.txt setup.cfg
[ -d venv ] || python3 -m venv venv
venv/bin/python -m pip install --upgrade pip wheel
venv/bin/python -m pip install --upgrade -e .[dev]
touch venv
update-venv:
[ -d venv ] || python3 -m venv venv
venv/bin/python -m pip install --upgrade pip wheel
venv/bin/python -m pip install --upgrade --upgrade-strategy eager -e .[dev]
touch venv
install-pre-commit: update-venv ## install the pre-commit hooks
venv/bin/pre-commit install
stubs: venv ## generate directory with xarray stubs with inserted primap2 stubs
rm -rf stubs
mkdir -p stubs
venv/bin/stubgen -p xarray -o stubs
(cd stubs; patch -s -p0 < ../primap-stubs.patch)
README.rst: ## Update the citation information from zenodo
venv/bin/python update_citation_info.py