Makefile

# Inspired by: https://blog.mathieu-leplatre.info/tips-for-your-makefile-with-python.html

PYMODULE := iplib3
TESTS := tests
INSTALL_STAMP := .install.stamp
POETRY := $(shell command -v poetry 2> /dev/null)
MYPY := $(shell command -v mypy 2> /dev/null)

.DEFAULT_GOAL := help

.PHONY: all
all: install lint

.PHONY: help
help:
	@echo "Please use 'make <target>', where <target> is one of"
	@echo ""
	@echo "  install     install packages and prepare environment"
	@echo "  lint        run the code linters"
	@echo "  all         install, lint, and test the project"
	@echo "  clean       remove all temporary files listed in .gitignore"
	@echo ""
	@echo "Check the Makefile to know exactly what each target is doing."
	@echo "Most actions are configured in 'pyproject.toml'."

install: $(INSTALL_STAMP)
$(INSTALL_STAMP): pyproject.toml
	@if [ -z $(POETRY) ]; then echo "Poetry could not be found. See https://python-poetry.org/docs/"; exit 2; fi
	$(POETRY) run pip install --upgrade pip setuptools
	$(POETRY) install
	touch $(INSTALL_STAMP)

.PHONY: lint
lint: $(INSTALL_STAMP)
    # Configured in pyproject.toml
    # Skips mypy if not installed
    # 
    # $(POETRY) run isort --profile=black --lines-after-imports=2 --check-only $(TESTS) $(PYMODULE)
    # $(POETRY) run black --check $(TESTS) $(PYMODULE) --diff
	@if [ -z $(MYPY) ]; then echo "Mypy not found, skipping..."; else echo "Running Mypy..."; $(POETRY) run mypy $(PYMODULE) $(TESTS); fi
	@echo "Running Flake8..."; $(POETRY) run pflake8 # This is not a typo
	@echo "Running Pylint..."; $(POETRY) run pylint $(PYMODULE)

.PHONY: clean
clean:
    # Delete all files in .gitignore
	git clean -Xdf

# Intended for workflow use only; *CAN* be ran locally, but they're of little use

.PHONY: flake8
flake8:
    # Configured in pyproject.toml
    # Stop the build if there are Python syntax errors or undefined names
	$(POETRY) run pflake8 --count --select=E9,F63,F7,F82 --show-source --statistics
    # exit-zero treats all errors as warnings
	$(POETRY) run pflake8 --count --exit-zero --statistics

.PHONY: pylint
pylint:
    # Configured in pyproject.toml
	$(POETRY) run pylint $(PYMODULE)