Makefile

.PHONY: clean-pyc clean-build doc clean visualize-tests build
BROWSER := python -mwebbrowser

help:
	@echo "clean - remove all build, test, coverage and Python artifacts"
	@echo "clean-build - remove build artifacts"
	@echo "clean-pyc - remove Python file artifacts"
	@echo "clean-test - remove test and coverage artifacts"
	@echo "lint - check style with ruff"
	@echo "test - run tests quickly with the default Python"
	@echo "coverage - check code coverage quickly with the default Python"
	@echo "docs - generate Sphinx HTML documentation, including API docs"
	@echo "release - package and upload a release"
	@echo "dist - package"
	@echo "install - install the package to the active Python's site-packages"
	@echo "develop - install the package in development mode"

clean: clean-build clean-cache clean-test

clean-build:
	rm -fr build/
	rm -fr dist/
	find . -name '*.egg-info' -exec rm -fr {} +

clean-cache:
	find . -name '__pycache__' -exec rm -fr {} +

clean-test:
	rm -f .coverage
	rm -f coverage.xml
	rm -fr htmlcov/
	rm -fr tests/result_images/*

ruff:
	ruff check . $(args)

format:
	ruff format . --check

format-fix:
	ruff format .

lint: ruff

lint-fix:
	make lint args="--fix"

fix: format-fix lint-fix

typecheck:
	pyright

test: clean-test
	export MATPLOTLIB_BACKEND=agg
	pytest

visualize-tests:
	python tools/visualize_tests.py

update-baseline-images:
	python tools/update_baseline_images.py

coverage:
	coverage report -m
	coverage html
	$(BROWSER) htmlcov/index.html

doc:
	$(MAKE) -C doc doc

doc-preview:
	$(MAKE) -C doc preview

release-major:
	@python ./tools/release-checklist.py major

release-minor:
	@python ./tools/release-checklist.py minor

release-patch:
	@python ./tools/release-checklist.py patch

dist: clean
	python -m build
	ls -l dist

build: dist

install: clean
	uv pip install ".[extra]"

doc-deps:
	uv pip install -e ".[doc]"
	uv pip install -r requirements/doc.txt
	cd doc && make deps

develop: clean-cache
	uv pip install -e ".[all]"

develop-update: clean-cache
	uv pip install --upgrade -e ".[all]"
	pre-commit autoupdate