Makefile

# Kudos: Adapted from Auto-documenting default target
# https://marmelab.com/blog/2016/02/29/auto-documented-makefile.html

.DEFAULT_GOAL := help

PROJECT = qf_diamond_norm
FILES = $(PROJECT) docs/conf.py setup.py

help:
	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-12s\033[0m %s\n", $$1, $$2}'

all: about coverage lint typecheck docs build   ## Run all tests

test:		## Run unittests
	pytest --disable-pytest-warnings

coverage:	## Report test coverage
	@echo
	pytest --disable-pytest-warnings --cov
	@echo

lint:		## Lint check python source
	@isort --check -m 3 --tc $(PROJECT)  ||  echo "isort:   FAILED!"
	@black --check --quiet $(PROJECT)    || echo "black:   FAILED!"
	@flake8 --quiet --quiet --output-file=/dev/null $(FILES) || echo "flake8:  FAILED!"

delint:   ## Run isort and black to delint project
	@echo	
	isort -m 3 --tc $(PROJECT)
	@echo
	black $(PROJECT)
	@echo

typecheck:	## Static typechecking 
	mypy $(PROJECT)

docs:		## Build documentation
	(cd docs; make html)

docs-open:  ## Build documentation and open in webbrowser
	(cd docs; make html)
	open docs/_build/html/index.html

docs-clean: 	## Clean documentation build
	(cd docs; make clean)

pragmas:	## Report all pragmas in code
	@echo
	@echo "** Code that needs something done **"
	@grep 'TODO' --color -r -n $(FILES) || echo "No TODO pragmas"
	@echo
	@echo "** Code that needs fixing **"
	@grep 'FIXME' --color -r -n $(FILES) || echo "No FIXME pragmas"
	@echo
	@echo "** Code that needs documenting **"
	@grep 'DOCME' --color -r -n $(FILES) || echo "No DOCME pragmas"
	@echo
	@echo "** Code that needs more tests **"
	@grep 'TESTME' --color -r -n $(FILES) || echo "No TESTME pragmas"
	@echo
	@echo "** Implementation notes **"
	@grep 'NB:' --color -r -n $(FILES)  || echo "No NB implementation notes Pragmas"
	@echo	
	@echo "** Acknowledgments **"
	@grep 'kudos:' --color -r -n -i $(FILES) || echo "No kudos"
	@echo
	@echo "** Pragma for test coverage **"
	@grep 'pragma: no cover' --color -r -n $(FILES) || echo "No Typecheck Pragmas"
	@echo
	@echo "** flake8 linting pragmas **"
	@echo "(http://flake8.pycqa.org/en/latest/user/error-codes.html)"
	@grep '# noqa:' --color -r -n $(FILES) || echo "No flake8 pragmas"
	@echo
	@echo "** Typecheck pragmas **"
	@grep '# type:' --color -r -n $(FILES) || echo "No Typecheck Pragmas"

about:	## Report versions of dependent packages
	@python -m $(PROJECT).about

status:  ## git status -uno
	@echo
	@git status -uno

build: ## Setuptools build
	./setup.py clean --all
	./setup.py sdist bdist_wheel


clean: ## Clean up after setuptools
	./setup.py clean --all


.PHONY: help
.PHONY: docs
.PHONY: build