Makefile

# NOTE: install the package itselt to make the CLI commands available (required for the tests)
install:
	@echo "installing the development dependencies..."
	@poetry install --all-extras --sync --with dev,docs,plot
	@#poetry install --no-dev


update:
	@echo "updating the dependencies pinned in 'pyproject.toml':"
	@poetry update -vvv
	#poetry export -f requirements.txt --output docs/requirements.txt --without-hashes

lock:
	@echo "pinning the dependencies in 'pyproject.toml':"
	@poetry lock -vvv


test:
	poetry run pytest

tox:
	@poetry run tox

hook:
	@pre-commit install
	@pre-commit run --all-files

hookup:
	@pre-commit autoupdate
	@pre-commit install

clean:
	rm -rf .pytest_cache .coverage coverage.xml tests/__pycache__ .mypyp_cache/ .tox


build:
	poetry build

# documentation generation:
# https://docs.readthedocs.io/en/stable/intro/getting-started-with-sphinx.html
docs:
	(cd docs && make html)


.PHONY: clean test build docs