conda_helpers/Makefile

.PHONY: clean clean-build clean-docs clean-pyc clean-test coverage coverall devenv docs help install lint nox prepareenv repo serve-docs test testall testfunctional tox venvexists
.DEFAULT_GOAL := help

define BROWSER_PYSCRIPT
import os, webbrowser, sys

try:
	from urllib import pathname2url
except:
	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)


venvexists:  ## helper to check if a virtual environment exists
	@test -x .venv/bin/python || { echo "No virtual environment found, please run 'make devenv'"; exit 1; }

clean: clean-build clean-docs 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-docs:  ## remove documentation artifacts
	rm -fr site/

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 .mypy_cache/
	rm -fr .pytest_cache/
	rm -fr .ruff_cache/
	rm -fr .nox/
	rm -fr .tox/
	rm -f .coverage
	rm -fr htmlcov/

lint: venvexists  ## reformat with black and check style with flake8
	.venv/bin/black src tests noxfile.py
	.venv/bin/ruff src tests noxfile.py

test: lint  ## run tests quickly, stop on first error
	.venv/bin/pytest tests --stepwise --disable-warnings -m "not functional"

testfunctional: lint ## run functional tests, stop on first error
	.venv/bin/pytest tests --stepwise -m "functional"

testall: lint  ## run all tests
	.venv/bin/pytest tests

coverage: lint  ## functional test suite, check code coverage and open coverage report
	.venv/bin/pytest tests --cov=conda_helpers --cov=tests -m "functional"
	.venv/bin/coverage html
	$(BROWSER) htmlcov/index.html

coverall: lint   ## full test suite, check code coverage and open coverage report
	.venv/bin/pytest tests --cov=conda_helpers --cov=tests
	.venv/bin/coverage html
	$(BROWSER) htmlcov/index.html

nox: venvexists  ## run fully isolated tests with nox
	.venv/bin/nox

tox: venvexists  ## old habits die hard: typo-squatting to use nox
	.venv/bin/nox

docs: venvexists  ## build the documentation using mkdocs
	.venv/bin/mkdocs build

serve-docs: docs  ## build the documentation and serve them in a web server
	.venv/bin/mkdocs serve

install: venvexists  ## install updated project.toml
	.venv/bin/pip3 install -e ".[dev,docs,test]"

prepareenv:  ## helper to create virtual environment and install basic packages
	rm -fr .venv/
	python3 -m venv --prompt conda_helpers .venv
	.venv/bin/pip3 install --upgrade pip wheel
	.venv/bin/pip3 install -e ".[dev,docs,test]"

devenv: prepareenv  ## setup development environment including precommit hooks
	.venv/bin/pre-commit install --install-hooks

repo: prepareenv  ## complete project setup with development environment and git repo
	git init .
	git add .
	git commit -m "import of project template"
	git branch -m main
	git remote add origin https://git.cpi.imtek.uni-freiburg.de/holgi/conda_helpers.git
	git push -u origin main --no-verify
	
	.venv/bin/pre-commit install --install-hooks