Makefile

.PHONY: clean clean-test clean-pyc clean-build docs help
.DEFAULT_GOAL := help
define BROWSER_PYSCRIPT
import os, webbrowser, sys
try:
	from urllib import pathname2url
except:
	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)


.PHONY: pip-tools
pip-tools:
	which pip-compile || pip install -U "pip-tools>=1.6.0"


.PHONY: bootstrap
bootstrap: pip-tools  ## bootstrap the development environment
	pip install -U "setuptools==32.3.1"
	pip install -U pip
	pip install -r requirements.txt -r requirements_dev.txt
	pip install --editable .


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 -fr .tox/
	rm -f .coverage
	rm -fr htmlcov/
	rm -rf .pytest_cache

lint: ## check style with pylint
	pycodestyle etcdb
	pylint etcdb

test: ## run tests quickly with the default Python
	py.test -x --cov=etcdb --cov-report term-missing tests/unit

test-functional: ## run functional tests. Must be run in a Vagrant machine.
	py.test -sxv tests/functional


test-all: ## run tests on every Python version with tox
	tox

coverage: ## check code coverage quickly with the default Python
	py.test --cov=etcdb --cov-report term-missing tests/unit

docs: ## generate Sphinx HTML documentation, including API docs
	rm -f docs/etcdb.rst
	rm -f docs/modules.rst
	sphinx-apidoc -o docs/ etcdb
	$(MAKE) -C docs clean
	$(MAKE) -C docs html
	$(BROWSER) docs/_build/html/index.html

servedocs: docs ## compile the docs watching for changes
	watchmedo shell-command -p '*.rst' -c '$(MAKE) -C docs html' -R -D .

release: clean ## package and upload a release
	python setup.py sdist upload
	python setup.py bdist_wheel upload

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

install: clean ## install the package to the active Python's site-packages
	python setup.py install

docker-start:
	@docker run \
		-v $(shell pwd):/etcdb \
		--rm \
		-it \
		ubuntu:xenial \
		/bin/bash -l

docker-test-func:
	@docker run \
		-v $(shell pwd):/etcdb \
		--rm \
		ubuntu:xenial \
		/bin/bash -l /etcdb/support/run_func_test.sh