Makefile

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

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
	python3 -m flake8 ldrb tests

type: ## Run mypy
	python3 -m mypy ldrb tests

test: ## run tests on every Python version with tox
	python3 -m pytest

docs: ## generate Sphinx HTML documentation, including API docs
	rm -f docs/ldrb.rst
	rm -f docs/modules.rst
	jupytext demos/demo_patient_lv.py -o docs/demo_patient_lv.md
	jupytext demos/demo_lv.py -o docs/demo_lv.md
	jupytext demos/demo_biv.py -o docs/demo_biv.md
	jupytext demos/basis_functions.py -o docs/basis_functions.md
	jupytext demos/demo_lifex_strocchi_LV.py -o docs/demo_lifex_strocchi_LV.md
	jupytext demos/demo_lifex_idealized_LV.py -o docs/demo_lifex_idealized_LV.md
	cp README.md docs/.
	sed -i.bak 's+docs/source/_static/figures/biv_fiber.png+_static/figures/biv_fiber.png+g' docs/README.md && rm -f docs/README.md.bak
	sphinx-apidoc -o docs ldrb
	jupyter-book build docs
	# python -m http.server --directory docs/_build/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
	python3 -m build
	ls -l dist

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

dev: clean ## Just need to make sure that libfiles remains
	python3 -m pip install -e ".[dev]"
	pre-commit install

bump:
	bump2version patch