brewtils/Makefile at master · hazmat345/brewtils · GitHub

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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
# Makefile for brewtils

PYTHON        = python
MODULE_NAME   = brewtils
TEST_DIR      = test

.PHONY: clean clean-build clean-docs clean-test clean-pyc docs help test

.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"


# Misc
help:
	@$(PYTHON) -c "$$PRINT_HELP_PYSCRIPT" < $(MAKEFILE_LIST)

install: clean ## install the package to the active Python's site-packages
	$(PYTHON) setup.py install


# Dependencies
deps: ## install python dependencies
	pip install -r requirements.txt


# Cleaning
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-docs: ## remove doc artifacts
	rm -f docs/$(MODULE_NAME).rst
	rm -f docs/modules.rst

clean-python: ## 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-sphinx: ## requires sphinx to be installed
	$(MAKE) -C docs clean

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

clean-all: clean-build clean-docs clean-python clean-sphinx clean-test ## remove everything

clean: clean-build clean-docs clean-python clean-test ## remove everything but sphinx


# Linting
lint: ## check style with flake8
	flake8 $(MODULE_NAME) $(TEST_DIR)


# Testing / Coverage
test-python: ## run tests quickly with the default Python
	pytest $(TEST_DIR)

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

test: test-python ## alias of test-python

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

coverage-view: coverage ## view coverage report in a browser
	$(BROWSER) htmlcov/index.html


# Documentation
docs: ## generate Sphinx HTML documentation, including API docs
	sphinx-apidoc -o docs/ brewtils
	$(MAKE) -C docs html

docs-view: docs ## view generated documenation in a browser
	$(BROWSER) docs/_build/html/index.html

docs-serve: docs ## generate the docs and watch for changes
	watchmedo shell-command -p '*.rst' -c '$(MAKE) -C docs html' -R -D .


# Packaging
package-source: ## builds source package
	$(PYTHON) setup.py sdist

package-wheel: ## builds wheel package
	$(PYTHON) setup.py bdist_wheel

package: clean package-source package-wheel ## builds source and wheel package
	ls -l dist


# Publishing
publish-package-test: package ## upload a package to the testpypi
	twine upload --repository testpypi dist/*

publish-package: package ## upload a package
	twine upload dist/*