Makefile

SHELL=/bin/bash
.DEFAULT_GOAL := help


# ---------------------------------
# Project specific targets
# ---------------------------------
#
# Add any targets specific to the current project in here.



# -------------------------------
# Common targets for Dev projects
# -------------------------------
#
# Edit these targets so they work as expected on the current project.
#
# Remember there may be other tools which use these targets, so if a target is not suitable for
# the current project, then keep the target and simply make it do nothing.

help: ## This help dialog.
help: help-display

clean: ## Remove unneeded files generated from the various build tasks.
clean: build-clean coverage-clean

reset: ## Reset your local environment. Useful after switching branches, etc.
reset: venv-check venv-wipe install-local

check: ## Check for any obvious errors in the project's setup.
check: pipdeptree-check

format: ## Run this project's code formatters.
format: yapf-format isort-format

lint: ## Lint the project.
lint: yapf-lint isort-lint flake8-lint

test: ## Run unit and integration tests.
test: pytest-test

test-report: ## Run and report on unit and integration tests.
test-report: coverage-clean test coverage-report

deploy: ## Deploy this project to demo or live.
deploy:
	@echo "Not a deployable project. Maybe you want to do a 'make release' instead?"

release: ## Package and release this project to PyPi.
release: clean build-release

dist: ## Builds source and wheel package
dist: clean build-dist

docs: ## Build the docs
docs: sphinx-apidoc sphinx-html



# ---------------
# Utility targets
# ---------------
#
# Targets which are used by the common targets. You likely want to customise these per project,
# to ensure they're pointing at the correct directories, etc.

# Build
build-clean:
	rm -fr build/
	rm -fr dist/
	rm -fr .eggs/
	find . -name '*.egg-info' -exec rm -fr {} +
	find . -name '*.egg' -exec rm -f {} +

build-release:
	@echo
	@echo "This will package and release this project to PyPi."
	@echo
	@echo "A checklist before you continue:"
	@echo
	@echo " - have you ran 'versionbump'?"
	@echo " - have you pushed the commit and tag created by 'versionbump'?"
	@echo " - are you sure the project is in a state to be released?"
	@echo
	@read -p "Press <enter> to continue. Or <ctrl>-c to quit and address the above points."
	python setup.py sdist upload
	python setup.py bdist_wheel upload

build-dist:
	python setup.py sdist
	python setup.py bdist_wheel
	ls -l dist


# Virtual Environments
venv-check:
ifndef VIRTUAL_ENV
	$(error Must be in a virtualenv)
endif

venv-wipe: venv-check
	if ! pip list --format=freeze | grep -v "^appdirs=\|^distribute=\|^packaging=\|^pip=\|^pyparsing=\|^setuptools=\|^six=\|^wheel=" | xargs pip uninstall -y; then \
	    echo "Nothing to remove"; \
	fi


# Installs
install-local: pip-install-local


# Pip
pip-install-local: venv-check
	pip install -r requirements/local.txt


# ISort
isort-version:
	isort --version

isort-lint: isort-version
	isort --recursive --check-only --diff cofecms

isort-format: isort-version
	isort --recursive cofecms


# Flake8
flake8-lint:
	flake8 cofecms


# Pytest
pytest-test:
	coverage run --source cofecms -m pytest


# Coverage
coverage-report: coverage-html coverage-xml
	coverage report --show-missing

coverage-html:
	coverage html

coverage-xml:
	coverage xml

coverage-clean:
	rm -rf htmlcov
	rm -rf reports
	rm -f .coverage


# YAPF
yapf-lint:
	yapf_lint_output="`yapf -r -p -d --style .style.yapf cofecms tests`" && \
	if [[ $$yapf_lint_output ]]; then echo -e "$$yapf_lint_output"; exit 1; fi

yapf-format:
	yapf -r -i -p --style .style.yapf cofecms tests


#pipdeptree
pipdeptree-check:
	@pipdeptree --warn fail > /dev/null


# Help
help-display:
	@awk '/^[[:alnum:]-]*: ##/ { split($$0, x, "##"); printf "%20s%s\n", x[1], x[2]; }' $(MAKEFILE_LIST)


# Sphinx
sphinx-html:
	$(MAKE) -C docs clean
	$(MAKE) -C docs html

sphinx-apidoc:
	rm -f docs/pycofecms.rst
	rm -f docs/modules.rst
	sphinx-apidoc -o docs/ cofecms