Makefile

.DEFAULT_GOAL := help

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


.PHONY:help
help:
	@python -c "$$PRINT_HELP_PYSCRIPT" < $(MAKEFILE_LIST)

.PHONY:clean
clean: ## remove build artifacts, compiled files, and cache
	rm -fr build/
	rm -fr docs/_build/
	rm -fr dist/
	rm -fr .eggs/
	find . -name '*.egg-info' -exec rm -fr {} +
	find . -name '*.egg' -exec rm -f {} +
	find . -name '*.pyc' -exec rm -f {} +
	find . -name '*.pyo' -exec rm -f {} +
	find . -name '*~' -exec rm -f {} +
	find . -name '__pycache__' -exec rm -fr {} +
	rm -f .coverage
	rm -fr htmlcov/
	rm -fr .pytest_cache

.PHONY:lint
lint:
	pre-commit run --all-files

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

.ONESHELL:
.PHONY:test-template
test-template: ## run tests quickly with the default Python
	rm -rf /tmp/osl-python-package
	cookiecutter --output-dir /tmp/ --no-input .
	cd /tmp/osl-python-package
	conda env create --file conda/dev.yaml --force
	conda activate osl-python-package
	poetry install
	pre-commit install
	make docs

.PHONY:docs
docs: ## generate Sphinx HTML documentation, including API docs
	rm -rf docs/_build
	jupyter-book build docs

.PHONY:build
build:
	poetry build