Makefile 3.72 KB
Newer Older
Daniel Scheffler's avatar
Daniel Scheffler committed
1
.PHONY: clean clean-test clean-pyc clean-build docs help nosetests
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
.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
45 46
	## don't call coverage erase here because make install calls make clean which calls make clean-test
	## -> since make install should run without the test requirements we can't use coverage erase here
47
	rm -fr .tox/
48
	rm -fr .coverage.*
49
	rm -fr htmlcov/
50 51
	rm -fr nosetests.html
	rm -fr nosetests.xml
52 53

lint: ## check style with flake8
54
	flake8 --max-line-length=120 gms_preprocessing tests > ./tests/linting/flake8.log
55
	pycodestyle gms_preprocessing --exclude="*.ipynb,*.ipynb*" --max-line-length=120 > ./tests/linting/pycodestyle.log
56
	-pydocstyle gms_preprocessing > ./tests/linting/pydocstyle.log
57

58 59 60 61 62
urlcheck: ## check for dead URLs
	urlchecker check . \
		--file-types .py,.rst,.md,.json \
		--white-listed-patterns S2_PDI_Level-1C_Tile_Metadata.xsd,Sensor+Wavelength+Definitions

63
test: ## run tests quickly with the default Python
Daniel Scheffler's avatar
Daniel Scheffler committed
64
	python setup.py test
65 66 67 68

test-all: ## run tests on every Python version with tox
	tox

Daniel Scheffler's avatar
Daniel Scheffler committed
69
coverage: clean-test ## check code coverage quickly with the default Python
Daniel Scheffler's avatar
Daniel Scheffler committed
70
	coverage run --source gms_preprocessing --source bin setup.py test
Daniel Scheffler's avatar
Daniel Scheffler committed
71 72 73
	coverage combine 	# must be called in order to make coverage work in multiprocessing
	coverage report -m
	coverage html
Daniel Scheffler's avatar
Daniel Scheffler committed
74
	# $(BROWSER) htmlcov/index.html
Daniel Scheffler's avatar
Daniel Scheffler committed
75

76
nosetests: clean-test ## Runs nosetests with coverage, xUnit and nose-html-output
Daniel Scheffler's avatar
Daniel Scheffler committed
77
	## - puts the coverage results in the folder 'htmlcov'
78 79
	## - generates 'nosetests.html' (--with-html)
	## - generates 'nosetests.xml' (--with-xunit) which is currently not visualizable by GitLab
Daniel Scheffler's avatar
Daniel Scheffler committed
80
	nosetests -vv --with-coverage --cover-package=gms_preprocessing --cover-package=bin --cover-erase --cover-html \
Daniel Scheffler's avatar
Daniel Scheffler committed
81
		--cover-html-dir=htmlcov --with-html --with-xunit --rednose --force-color
Daniel Scheffler's avatar
Daniel Scheffler committed
82

83
docs: ## generate Sphinx HTML documentation, including API docs
84
	rm -f docs/gms_preprocessing.rst
85
	rm -f docs/modules.rst
86
	sphinx-apidoc -o docs/ gms_preprocessing --doc-project 'API Reference'
87 88
	$(MAKE) -C docs clean
	$(MAKE) -C docs html
89
	# $(BROWSER) docs/_build/html/index.html
90 91 92 93 94 95 96 97 98 99 100 101 102 103

servedocs: docs ## compile the docs watching for changes
	watchmedo shell-command -p '*.rst' -c '$(MAKE) -C docs html' -R -D .

release: clean ## package and upload a release
	python setup.py sdist upload
	python setup.py bdist_wheel upload

dist: clean ## builds source and wheel package
	python setup.py sdist
	python setup.py bdist_wheel
	ls -l dist

install: clean ## install the package to the active Python's site-packages
Daniel Scheffler's avatar
Daniel Scheffler committed
104
	pip install -r requirements.txt
105
	python setup.py install
Daniel Scheffler's avatar
Daniel Scheffler committed
106 107

gitlab_CI_docker:  ## Build a docker image for CI use within gitlab
108
	cd ./tests/CI_docker/; bash ./before_script.sh
Daniel Scheffler's avatar
Daniel Scheffler committed
109
	cd ./tests/CI_docker/; bash ./build_testsuite_image.sh