Makefile

# This file is part of aptscan
# https://github.com/scorphus/aptscan

# Licensed under the BSD-3-Clause license:
# https://opensource.org/licenses/BSD-3-Clause
# Copyright (c) 2024, Pablo S. Blum de Aguiar <scorphus@gmail.com>

# list all available targets
list:
	@sh -c "$(MAKE) -p no_targets__ | awk -F':' '/^[a-zA-Z0-9][^\$$#\/\\t=]*:([^=]|$$)/ {split(\$$1,A,/ /);for(i in A)print A[i]}' | grep -v '__\$$' | grep -v 'make\[1\]' | grep -v 'Makefile' | sort"
.PHONY: list
# required for list
no_targets__:

# install dependencies and pre-commit hooks
setup:
	@PIP_REQUIRE_VIRTUALENV=true pip install -U -e .\[tests\]
	@pre-commit install -f --hook-type pre-commit
	@pre-commit install -f --hook-type pre-push
.PHONY: setup

# install dependencies
setup-ci:
	@pip install -U -e .\[tests\]
.PHONY: setup-ci

# run isort, black and flake8 for style guide enforcement
isort:
	@isort .
.PHONY: isort

black:
	@black .
.PHONY: black

pylint:
	@pylint aptscan
	@pylint --rc-file tests/pylintrc tests
.PHONY: pylint

mypy:
	@mypy .
	@echo Remember to run “make mypy-strict” for strict type checking

mypy-strict:
	@mypy --strict .

lint: isort black pylint mypy
.PHONY: lint

# run tests with coverage
test:
	@pytest --cov=aptscan tests
.PHONY: test

# report coverage in html format
coverage: test
	@coverage html
.PHONY: coverage

# clean python object, test and coverage files
pyclean:
	@find . -type d -iname '__pycache__' -exec rm -rf \{\} + -print
	@find . -type d -iname '.benchmarks' -exec rm -rf \{\} + -print
	@find . -type d -iname '.mypy_cache' -exec rm -rf \{\} + -print
	@find . -type d -iname '.pytest_cache' -exec rm -rf \{\} + -print
	@find . -type d -iname '*.egg-info' -exec rm -rf \{\} + -print
	@find . -type f -iname '.coverage' -exec rm -rf \{\} + -print
	@find . -type f -name "*.pyc" -delete -print
.PHONY: pyclean