Makefile

.PHONY: doc help
.DEFAULT_GOAL := help

SHELL := /usr/bin/env bash
VERSION_FILE := $(PROJECT)/version.py
VERSION := $(shell pyproject/version $(VERSION_FILE) 2> /dev/null)
PYTHON_VERSION := $(shell pyproject/python_version 2> /dev/null)
IS_PYPY := $(shell pyproject/is_pypy 2> /dev/null)
IS_PY2  := $(shell python -c "import sys; print(sys.version_info[0] == 2)")
NOOP := $(shell pyproject/chklib $(PROJECT) < pyproject/depends > /dev/null 2> /dev/null)
INSTALL_PACKAGE := $(PROJECT)_$(VERSION)
FAIL_UNDER := 100
TESTDIR := $(PROJECT)

export PYBUILD_DISABLE := test

all:

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

test_ext:

test_dep:

.requirements.txt:
	touch .requirements.txt

install: .requirements.txt  ## Standard pip install including .requirements.txt (for testing)
	pip install --upgrade -r .requirements.txt

install-edit: .requirements.txt | .deps/$(PROJECT)  ## Edit install pip install -e

test: test_dep flake8 pytest isort-check todo | test_ext  ## Testing the project: flake8 pytest isort todo

isort: .deps/isort  ## Sort the headers of the project
	isort -b concurrent.futures -vb -ns "__init__.py" -sg "" -s "" -rc -p $(PROJECT) $(PROJECT)

ifeq ($(IS_PYPY),True)
isort-check:
else
isort-check: .deps/isort pytest  ## Check the isort header order (used by test)
	isort -b concurrent.futures -df -vb -ns "__init__.py" -sg "" -s "" -rc -c -p $(PROJECT) $(PROJECT)
endif

ifeq ($(IS_PYPY),True)
pytest: .requirements.txt .deps/pytest   ## Run pytest
	rm -f *.so *.dylib
	pip install --upgrade -r .requirements.txt -e .
	py.test --doctest-modules $(TESTDIR)
else
pytest: .requirements.txt .deps/pytest  .deps/coverage .deps/pytest_cov
	rm -f *.so *.dylib
	pip install --upgrade -r .requirements.txt -e .
	py.test --doctest-modules --cov-report term-missing --cov=$(PROJECT) --cov-fail-under=$(FAIL_UNDER) --no-cov-on-fail $(TESTDIR)
endif

pytest-no-cov: install-edit | .deps/pytest  ## Run pytest without coverage
	py.test --doctest-modules $(TESTDIR)

tdoc: | .deps/sphinx install-edit  ## Regenerate doc
	touch doc/*
	make -C doc html

doc: | .deps/sphinx install-edit  ## Generate doc
	make -C doc html

ifeq ($(IS_PY2),True)
coala:
else
coala: | .deps/coalib  ## Guided additional code-analysis (more than the minimum enforced by the CI)
	if [ -e ".coafile" ]; then \
		coala; \
	else \
		coala --files="$(PROJECT)/**/*.py" --bears=PEP8Bear,PyDocStyleBear,PyLintBear --save; \
	fi
endif

.flake8:
	cp pyproject/.flake8 .flake8

flake8: .flake8 | .deps/flake8  ## Run flake8 test
	flake8 $(PROJECT)

todo:  ## Show todos in code
	grep -Inrs TODO $(PROJECT) Makefile; true

merge-log: | .deps/jinja2 .deps/click  ## Create changelog -> make merge-log from=w.x to=y.z
	pyproject/genlog -m $(GIT_HUB) $(VERSION_FILE) $(from) $(to)

commit-log: | .deps/jinja2 .deps/click  ## Create changelog -> make commit-log from=w.x to=y.z
	pyproject/genlog $(GIT_HUB) $(VERSION_FILE) $(from) $(to)

clean:  ## Clean, ATTENTION cleans everything not in git
	@if [ -e ".git" ]; then \
		echo "Cleaning using git"; \
		git clean -xdf -e .vagrant -e FINJA -e .python-version; \
		git submodule foreach --recursive 'git clean -xdf -e .vagrant -e FINJA -e .python-version'; \
	else \
		echo "Cleaning using find" \
		find . -name "*.pyc" -delete; \
		find . -name "*.pyo" -delete; \
		find . -name "__pycache__" -delete; \
		find . -name "*.o" -delete; \
		find . -name "*.obj" -delete; \
		find . -name "*.a" -delete; \
		find . -name "*.lib" -delete; \
		find . -name "*.i" -delete; \
	fi

update:  ## Update submodules
	git submodule update --init --recursive

dist: clean update  ## Create dist for building debian packages (used by target deb)
	git checkout-index -a -f --prefix=$(INSTALL_PACKAGE)/
	git submodule foreach --recursive 'git checkout-index -a -f --prefix=${PWD}/$(INSTALL_PACKAGE)$${toplevel#${PWD}}/$$path/'
	make log
	cp debian/changelog $(INSTALL_PACKAGE)/debian/changelog
	cp CHANGELOG.rst $(INSTALL_PACKAGE)/CHANGELOG.rst
	tar cfz ../$(INSTALL_PACKAGE).orig.tar.gz $(INSTALL_PACKAGE)
	rm -rf $(INSTALL_PACKAGE)

log: | .deps/jinja2 .deps/click .deps/dateutil  ## Create log for packages (git add and git commit needed!)
	pyproject/genchangelog $(PROJECT) CHANGELOG debian/changelog CHANGELOG.rst

deb: dist  ## Build a debian package
	sudo apt-get install -y  build-essential devscripts equivs
	sudo mk-build-deps -i debian/control -t 'apt-get --no-install-recommends -y'
	rm -rf *.deb
	dpkg-buildpackage -us -uc

rpm:  ## Build a rpm package
	python setup.py bdist_rpm

pypi:  ## Release package to pypi
	python setup.py sdist upload -s

.deps/$(PROJECT):
	pip install --upgrade -r .requirements.txt -e .

.deps/isort:
	pip install --upgrade isort
	@pyenv rehash > /dev/null 2> /dev/null; true

.deps/flake8: | .deps/flake8_mock .deps/flake8_tuple .deps/flake8_string_format .deps/flake8_debugger .deps/flake8_deprecated .deps/flake8_comprehensions
	pip install --upgrade 'flake8'
	@pyenv rehash > /dev/null 2> /dev/null; true

.deps/flake8_mock:
	LC_ALL="C.UTF-8" pip install --upgrade flake8-mock -r pyproject/.flake8-req.txt

.deps/flake8_tuple:
	pip install --upgrade flake8-tuple -r pyproject/.flake8-req.txt

.deps/flake8_string_format:
	pip install --upgrade flake8-string-format -r pyproject/.flake8-req.txt

.deps/flake8_debugger:
	pip install --upgrade flake8-debugger -r pyproject/.flake8-req.txt

.deps/flake8_deprecated:
	pip install --upgrade flake8-deprecated -r pyproject/.flake8-req.txt

.deps/flake8_future_import:
	pip install --upgrade flake8-future-import -r pyproject/.flake8-req.txt

.deps/flake8_comprehensions:
	pip install --upgrade flake8-comprehensions -r pyproject/.flake8-req.txt

.deps/pytest: | .deps/pytest_mock .deps/pytest_catchlog .deps/freeze .deps/testfixtures .deps/hypothesis
	pip install --upgrade pytest
	@pyenv rehash > /dev/null 2> /dev/null; true

.deps/pytest_cov:
	pip install --upgrade pytest-cov

.deps/pytest_mock:
	pip install --upgrade pytest-mock

.deps/pytest_catchlog:
	pip install --upgrade pytest-catchlog

.deps/sphinx: | .deps/sphinx_rtd_theme
	pip install --upgrade sphinx
	@pyenv rehash > /dev/null 2> /dev/null; true

.deps/sphinx_rtd_theme:
	pip install --upgrade sphinx_rtd_theme

.deps/hypothesis: | .deps/hypothesispytest
	pip install --upgrade hypothesis

.deps/hypothesispytest:
	pip install --upgrade hypothesis-pytest

.deps/freeze:
	pip install --upgrade freeze

.deps/testfixtures:
	pip install --upgrade testfixtures

.deps/coverage:
	pip install --upgrade coverage
	@pyenv rehash > /dev/null 2> /dev/null; true

.deps/jinja2:
	pip install --upgrade jinja2

.deps/click:
	pip install --upgrade click

.deps/dateutil:
	pip install --upgrade python-dateutil

.deps/cffi:
	pip install --upgrade cffi

ifeq ($(IS_PY2),True)
.deps/coalib:
else
.deps/coalib:
	pip install --upgrade coala-bears
	@pyenv rehash > /dev/null 2> /dev/null; true
endif