aboutsummaryrefslogtreecommitdiffhomepage
path: root/Makefile
blob: 2f01dd7e834beb0400ebdfb456fdca7bbff7def1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
.PHONY: clean clean-test clean-pyc clean-build help lint coverage coverage-html release dist install run debug docs
.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"
PIPENV := pipenv
PIPRUN := $(PIPENV) run
PIPINST := $(PIPENV) --bare install --dev --skip-lock

help:
	@python -c "$$PRINT_HELP_PYSCRIPT" < $(MAKEFILE_LIST)

clean: clean-build clean-pyc clean-test ## remove all build, test, coverage and Python artifacts
	make -C docs clean

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 {} +
	$(PIPRUN) pip uninstall -y nncli

clean-test: ## remove test and coverage artifacts
	rm -f .coverage
	rm -fr htmlcov/
	rm -fr .pytest_cache
	rm -fr .tox

lint: ## check style with pylint
	$(PIPRUN) pylint nncli tests --disable=parse-error
	$(PIPRUN) vulture nncli .vulture_whitelist.py

test: ## run tests quickly with the default Python
	$(PIPRUN) python -m pytest

test-all: ## run tests on every Python version with tox
	$(PIPRUN) tox

test-install: ## install dependenices from Pipfile (for tox / CI builds)
	$(PIPINST)

coverage: ## check code coverage quickly with the default Python
	$(PIPRUN) python -m pytest --cov=nncli

coverage-html: coverage ## generate an HTML report and open in browser
	$(PIPRUN) coverage html
	$(BROWSER) htmlcov/index.html

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

dist: ## builds source and wheel package
	$(PIPRUN) flit build
	ls -l dist

docs: ## builds the sphinx documentation and opens in the browser
	make -C docs html
	make -C docs latexpdf
	make -C docs man
	$(BROWSER) docs/build/html/index.html

install: ## install the package to the active Python's site-packages
	$(PIPRUN) flit install --deps=none

run: ## run the package from site-packages
	$(PIPRUN) python -m nncli $(cmd)

debug: install ## debug the package from site packages
	$(PIPRUN) pudb3 $$($(PIPRUN) which nncli) $(cmd)