Makefile

.PHONY: clean clean-test clean-pyc clean-build docs help
.DEFAULT_GOAL := help

define BROWSER_PYSCRIPT
import os, webbrowser, sys, mkdocs

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 -fr {} +

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 htmlcov

lint: ## check style with flake8
	flake8 unifiedbooster tests

coverage: ## check code coverage quickly with the default Python
	coverage run --source unifiedbooster setup.py test
	coverage report -m
	coverage html
	$(BROWSER) htmlcov/index.html

docs: install ## generate docs		
	pip install black pdoc 
	black unifiedbooster/* --line-length=80	
	find unifiedbooster/ -name "*.py" -exec autopep8 --max-line-length=80 --in-place {} +
	pdoc -t docs unifiedbooster/* --output-dir unifiedbooster-docs
	find . -name '__pycache__' -exec rm -fr {} +

servedocs: install ## compile the docs watching for change	 	
	pip install black pdoc 
	black unifiedbooster/* --line-length=80	
	find unifiedbooster/ -name "*.py" -exec autopep8 --max-line-length=80 --in-place {} +
	pdoc -t docs unifiedbooster/* 
	find . -name '__pycache__' -exec rm -fr {} +

build-site: docs ## export mkdocs website to a folder		
	cp -rf unifiedbooster-docs/* ../../Pro_Website/Techtonique.github.io/unifiedbooster
	find . -name '__pycache__' -exec rm -fr {} +

release: dist ## package and upload a release
	pip install twine --ignore-installed
	python3 -m twine upload --repository pypi dist/* --verbose

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

install: clean ## install the package to the active Python's site-packages
	python3 -m pip install .

run-examples: ## run all examples with one command
	find examples -maxdepth 2 -name "*.py" -exec  python3 {} \;

run-tests: ## run all the tests with one command
	python3 -m coverage run -m unittest discover -s tests -p "*.py"
	python3 -m coverage report --omit="venv/*,tests/*"	
	python3 -m coverage html --omit="venv/*,tests/*"
	$(BROWSER) htmlcov/index.html