Makefile

SHELL:=/usr/bin/env bash

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

.PHONY: lint
lint:  # check style with flake8
#	mypy topalias tests/**/*.py
	flake8 topalias tests --ignore D100,D104,D106,D401,W504,X100,RST303,RST304,DAR103,DAR203,E203,E266,E501,W503,WPS410,WPS305,WPS421,WPS336,WPS317,WPS111,WPS226,WPS323,WPS210,WPS429,WPS220,WPS231,C901,WPS441,WPS229,WPS232,WPS202,WPS221,WPS461
#	doc8 -q docs

.PHONY: unit
unit:
	pytest

.PHONY: package
package:
	poetry check
	pip check
	# Ignoring sphinx@2 security issue for now, see:
  # https://github.com/miyakogi/m2r/issues/51
	safety check --full-report -i 38330 || true

.PHONY: test
test: lint package unit

define BROWSER_PYSCRIPT
import os, webbrowser, sys

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)

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 -fr .pytest_cache

# lint: ## check style with flake8
# 	flake8 topalias tests --ignore WPS410,WPS305,WPS421,WPS336,WPS317,WPS111

test: ## run tests quickly with the default Python
	pytest

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

coverage: ## check code coverage quickly with the default Python
	coverage run --source topalias -m pytest
	coverage report -m
	coverage html
	$(BROWSER) htmlcov/index.html

docs: ## generate Sphinx HTML documentation, including API docs
	rm -f docs/topalias.rst
	rm -f docs/modules.rst
	sphinx-apidoc -o docs/ topalias
	$(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: dist ## package and upload a release
# 	twine upload dist/*

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

.PHONY: build-deb
build-deb: dist ## build Debian package (.deb)
	@echo "Building Debian package..."
	dpkg-buildpackage -b -us -uc
	@echo "Debian package built in parent directory"

.PHONY: build-rpm
build-rpm: dist ## build RPM package for Alt Linux and other RPM-based distros
	@echo "Building RPM package..."
	@if [ ! -d ~/rpmbuild ]; then mkdir -p ~/rpmbuild/{BUILD,RPMS,SOURCES,SPECS,SRPMS}; fi
	cp dist/topalias-*.tar.gz ~/rpmbuild/SOURCES/
	cp topalias.spec ~/rpmbuild/SPECS/
	rpmbuild -ba ~/rpmbuild/SPECS/topalias.spec
	@echo "RPM package built in ~/rpmbuild/RPMS/"

.PHONY: build-arch
build-arch: ## build Arch Linux package using PKGBUILD
	@echo "Building Arch Linux package..."
	makepkg -s
	@echo "Arch Linux package built in current directory"

.PHONY: packages
packages: build-deb build-rpm build-arch ## build all package formats
	@echo "All packages built successfully"