Makefile

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

define BROWSER_PYSCRIPT
import os, webbrowser, sys
from urllib.request import pathname2url

webbrowser.open(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-docs: ## remove docs artifacts
	rm -f docs/apidoc/xclim*.rst
	rm -f docs/apidoc/modules.rst
	rm -f docs/notebooks/data/*.nc
	$(MAKE) -C docs clean

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 and black
	black --check xclim tests
	isort --check xclim tests
	ruff check xclim tests
	flake8 --config=.flake8 xclim tests
	vulture xclim tests
	nbqa black --check docs
	blackdoc --check --exclude=xclim/indices/__init__.py xclim
	blackdoc --check docs
	codespell xclim tests docs
	yamllint --config-file=.yamllint.yaml xclim

test: ## run tests quickly with the default Python
	pytest
	pytest --no-cov --nbval --dist=loadscope --rootdir=tests/ docs/notebooks --ignore=docs/notebooks/example.ipynb
	pytest --rootdir=tests/ --xdoctest xclim

test-all: ## run tests on every Python version with tox
	tox

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

autodoc-obsolete: clean-docs ## create sphinx-apidoc files (obsolete)
	mkdir -p docs/apidoc/
	sphinx-apidoc -o docs/apidoc/ --private --module-first xclim xclim/testing/tests

autodoc-custom-index: clean-docs ## create sphinx-apidoc files but with special index handling for indices and indicators
	mkdir -p docs/apidoc/
	sphinx-apidoc -o docs/apidoc/ --private --module-first xclim xclim/testing/tests xclim/indicators xclim/indices
	rm docs/apidoc/xclim.rst
	env SPHINX_APIDOC_OPTIONS="members,undoc-members,show-inheritance,noindex" sphinx-apidoc -o docs/apidoc/ --private --module-first xclim xclim/testing/tests

linkcheck: autodoc-custom-index ## run checks over all external links found throughout the documentation
	$(MAKE) -C docs linkcheck

docs: autodoc-custom-index ## generate Sphinx HTML documentation, including API docs, but without indexes for for indices and indicators
	$(MAKE) -C docs html
ifndef READTHEDOCS
	## Start http server and show in browser.
	## We want to have the cli command run in the foreground, so it's easy to kill.
	## And we wait 2 sec for the server to start before opening the browser.
	\{ sleep 2; $(BROWSER) http://localhost:54345 \} &
	python -m http.server 54345 --directory docs/_build/html/
endif

servedocs: autodoc-custom-index ## generate Sphinx HTML documentation, including API docs, but without indexes for for indices and indicators, and watch for changes
	$(MAKE) -C docs livehtml

release: dist ## package and upload a release
	flit publish dist/*

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

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

develop: clean ## install the package and development dependencies in editable mode to the active Python's site-packages
	python -m pip install --no-user --editable ".[dev]"

upstream: clean develop ## install the GitHub-based development branches of dependencies in editable mode to the active Python's site-packages
	python -m pip install --no-user --requirement requirements_upstream.txt