Makefile

# -----------------------------------------------------------------------------
# Generate help output when running just `make`
# -----------------------------------------------------------------------------
.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:
	@python3 -c "$$PRINT_HELP_PYSCRIPT" < $(MAKEFILE_LIST)

# -----------------------------------------------------------------------------
# Variables
# -----------------------------------------------------------------------------

venv=.venv

BAKE_OPTIONS=--no-input

# -----------------------------------------------------------------------------
# Environment
# -----------------------------------------------------------------------------

env:  ## Install virtualenv for development (uses `pyenv`)
	python3 -m venv ${venv}
	@echo "Virtual environment created. Activate with: source ${venv}/bin/activate"
	@echo "Install dependencies with: pip install ."

env_remove:  ## Remove virtual environment
	deactivate
	rm -rf ${venv}

env_from_scratch: env_remove env  ## Create environment from scratch

# -----------------------------------------------------------------------------
# Pip
# -----------------------------------------------------------------------------

pip_install:  ## Install requirements
	python3 -m pip install -U pip
	python3 -m pip install .

# -----------------------------------------------------------------------------
# Cookiecutter
# -----------------------------------------------------------------------------

bake:  ## Generate project using defaults
	cookiecutter $(BAKE_OPTIONS) . --overwrite-if-exists

watch: bake  ## Generate project using defaults and watch for changes
	watchmedo shell-command -p '*.*' -c 'make bake -e BAKE_OPTIONS=$(BAKE_OPTIONS)' -W -R -D \{{cookiecutter.package_name}}/

replay: BAKE_OPTIONS=--replay  # Replay last cookiecutter run and watch for changes
replay: watch
	;

eat:  ## Remove generated project
	rm -rf my_awesome_project

# -----------------------------------------------------------------------------
# Git
# -----------------------------------------------------------------------------

fetch_upstream:  ## Fetch upstream changes
	git fetch upstream

preview_upstream:  ## Preview changes from upstream
	git difftool master upstream/master -y

merge_upstream:  ## Merge upstream changes into master
	git fetch upstream
	git checkout master
	git merge upstream/master

# -----------------------------------------------------------------------------
# Testing
# -----------------------------------------------------------------------------

pytest:  ## Run tests
	pytest -vx tests

pytest_generation:  ## Run tests for cookiecutter generation
	pytest -vx tests/test_cookiecutter_generation.py

# pytest_verbose:  ## Run tests in verbose mode
# 	pytest -vvs

# coverage:  ## Run tests with coverage
# 	coverage run -m pytest && coverage html

# coverage_verbose:  ## Run tests with coverage in verbose mode
# 	coverage run -m pytest -vss && coverage html

# coverage_skip:  ## Run tests with coverage and skip covered
# 	coverage run -m pytest -vs && coverage html --skip-covered

# open_coverage:  ## Open coverage report
# 	open htmlcov/index.html

# -----------------------------------------------------------------------------