Makefile

.PHONY: all clean clean-env clean-test clean-pyc clean-build clean-other help dev test test-unit test-integration test-debug test-cov tests-cov-fail pre-commit lint format format-docs analyze docs
.DEFAULT_GOAL := help

# The `.ONESHELL` and setting `SHELL` allows us to run commands that require
# `conda activate`
.ONESHELL:
SHELL := /bin/bash
# For GNU Make v4 and above, you must include the `-c` in order for `make` to find symbols from `PATH`
.SHELLFLAGS := -c -o pipefail -o errexit
CONDA_ACTIVATE = source $$(conda info --base)/etc/profile.d/conda.sh ; conda activate ; conda activate
# Ensure that we are using the python interpreter provided by the conda environment.
PYTHON3 := "$(CONDA_PREFIX)/bin/python3"

CONDA_ENV_NAME ?= mailgun
SRC_DIR = mailgun
TEST_DIR = tests
SCRIPTS_DIR = scripts/
REQUIRED_VARS := APIKEY DOMAIN

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"

clean:	clean-cov clean-build clean-pyc clean-test clean-temp clean-other ## remove all build, test, coverage and Python artifacts

clean-cov:
	rm -rf .coverage
	rm -rf htmlcov
	rm -rf reports/{*.html,*.png,*.js,*.css,*.json}
	rm -rf pytest.xml
	rm -rf pytest-coverage.txt

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-env:					## remove conda environment
	conda remove -y -n $(CONDA_ENV_NAME) --all ; conda info

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

clean-temp:	## remove temp artifacts
	rm -fr temp/tmp.txt
	rm -fr tmp.txt

clean-other:
	rm -fr *.prof
	rm -fr profile.html profile.json
	rm -fr wget-log
	rm -fr logs/*.log
	rm -fr *.txt

help:
	$(PYTHON3) -c "$$PRINT_HELP_PYSCRIPT" < $(MAKEFILE_LIST)

environment:	## handles environment creation
	conda env create -f environment.yaml --name $(CONDA_ENV_NAME) --yes
	conda run --name $(CONDA_ENV_NAME) pip install .

environment-dev:	## Handles environment creation
	conda env create -n $(CONDA_ENV_NAME)-dev -y --file environment-dev.yaml
	conda run --name $(CONDA_ENV_NAME)-dev pip install -e .

install: clean	## install the package to the active Python's site-packages
	pip install .

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

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

dev: clean		## install the package's development version to a fresh environment
	conda env create -f environment.yaml --name $(CONDA_ENV_NAME) --yes
	conda run --name $(CONDA_ENV_NAME) pip install -e .

dev-full: clean		## install the package's development version to a fresh environment
	conda env create -f environment-dev.yaml --name $(CONDA_ENV_NAME)-dev --yes
	conda run --name $(CONDA_ENV_NAME)-dev pip install -e .
	$(CONDA_ACTIVATE) $(CONDA_ENV_NAME)-dev && pre-commit install


pre-commit:		## runs pre-commit against files. NOTE: older files are disabled in the pre-commit config.
	pre-commit run --all-files

check-env:
	@missing=0; \
	for v in $(REQUIRED_VARS); do \
	  if [ -z "$${!v}" ]; then \
	    echo "Missing required env var: $$v"; \
	    missing=1; \
	  fi; \
	done; \
	if [ $$missing -ne 0 ]; then \
	  echo "Aborting tests due to missing env vars."; \
	  exit 1; \
	fi

test: test-unit


test-unit:		## run unit tests only (no API key required)
	$(PYTHON3) -m pytest -v --capture=no $(TEST_DIR)/unit/

test-integration: check-env		## run integration tests only (requires APIKEY and DOMAIN)
	$(PYTHON3) -m pytest -v --capture=no $(TEST_DIR)/integration/tests.py

test-debug:		## run unit tests with debugging info
	$(PYTHON3) -m pytest -vv --capture=no $(TEST_DIR)/unit/

test-cov:		## check test coverage (unit tests only)
	$(PYTHON3) -m pytest --cov-config=.coveragerc --cov=$(SRC_DIR) \
		$(TEST_DIR)/unit/ --cov-report term-missing

test-cov-fail:		## check test coverage with fail-under (unit tests only)
	$(PYTHON3) -m pytest --cov-config=.coveragerc --cov=$(SRC_DIR) \
		$(TEST_DIR)/unit/ --cov-fail-under=80 --cov-report term-missing --cov-report=html

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

lint-black:
	black --line-length=100 $(SRC_DIR) $(TEST_DIR)
lint-isort:
	isort --profile black --line-length=100 $(SRC_DIR) $(TEST_DIR)
lint-flake8:
	@flake8 $(SRC_DIR) $(TEST_DIR)
lint-pylint:
	pylint --rcfile=.pylintrc $(SRC_DIR) $(TEST_DIR)
lint-refurb:
	@refurb $(SRC_DIR)

format-black:
	@black --line-length=100 $(SRC_DIR) $(TEST_DIR) $(SCRIPTS_DIR)
format-isort:
	@isort --profile black --line-length=88 $(SRC_DIR) $(TEST_DIR) $(SCRIPTS_DIR)
format: format-black format-isort

format:			## runs the code auto-formatter
	isort
	black

format-docs:	## runs the docstring auto-formatter. Note this requires manually installing `docconvert` with `pip`
	docconvert --in-place --config .docconvert.json $(SRC_DIR)

analyze:		## runs static analyzer on the project
	mypy --config-file=.mypy.ini --cache-dir=/dev/null $(SRC_DIR) $(TEST_DIR) $(SCRIPTS_DIR)

lint-mypy-report:
	@mypy $(SRC_DIR) --html-report ./mypy_html