gitinspector/Makefile

.PHONY: clean clean-test clean-pyc clean-build docs help
.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 -f .coverage
	rm -fr .pytest_cache

lint: ## check style with flake8
	# stop the build if there are Python syntax errors or undefined names
	flake8 gitinspector tests --count --select=E9,F63,F7,F82 --show-source --statistics --builtins="_"
	# exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
	flake8 gitinspector tests --count --ignore=E722,W503,E401,C901 --exit-zero --max-complexity=10 --max-line-length=127 --statistics --builtins="_"

format: ## auto format all the code with black
	black gitinspector --line-length 127

test: ## run tests quickly with the default Python
	pytest

test-debug: ## run tests with debugging enabled
	LOGLEVEL=debug; py.test -s --pdb

test-coverage: ## check code coverage quickly with the default Python
	coverage run --source gitinspector -m pytest
	coverage report -m

test-coverage-report: test-coverage ## Report coverage to Coveralls
	coveralls

release: dist ## package and upload a release
	twine upload dist/*

dist: clean requirements ## 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 setup.py install

requirements:
	pipenv lock -r --dev > requirements.txt