Makefile

sources = src tests scripts

.PHONY: .poetry  ## Check that PDM is installed
.poetry:
	@poetry -V || echo 'Please install PDM: https://python-poetry.org/docs/#installation'

.PHONY: .pre-commit  ## Check that pre-commit is installed
.pre-commit:
	@pre-commit -V || echo 'Please install pre-commit: https://pre-commit.com/'

.PHONY: install  ## Install the package, dependencies, and pre-commit for local development
install: .poetry .pre-commit
	poetry install
	pre-commit install --install-hooks

.PHONY: update  ## Update all libraries and export the requirements
update:
	poetry update
	poetry export -o requirements-docs.txt --only=docs --without-hashes
	echo "-e ." | cat - requirements-docs.txt > temp && mv temp requirements-docs.txt


.PHONY: lint  ## Lint python source files
lint: .poetry
	poetry run ruff check $(sources)
	poetry run ruff format --check $(sources)

.PHONY: clean  ## Clear local caches and build artifacts
clean:
	rm -rf `find . -name __pycache__`
	rm -f `find . -type f -name '*.py[co]'`
	rm -f `find . -type f -name '*~'`
	rm -f `find . -type f -name '.*~'`
	rm -rf .cache
	rm -rf .pytest_cache
	rm -rf .ruff_cache
	rm -rf htmlcov
	rm -rf *.egg-info
	rm -f .coverage
	rm -f .coverage.*
	rm -rf build
	rm -rf dist
	rm -rf site
	rm -rf docs/_build
	rm -rf docs/.changelog.md docs/.version.md docs/.tmp_schema_mappings.html
	rm -rf fastapi/test.db
	rm -rf coverage.xml

.PHONY: docs  ## Generate the docs
docs:
	poetry run mkdocs build --strict

.PHONY: help  ## Display this message
help:
	@grep -E \
		'^.PHONY: .*?## .*$$' $(MAKEFILE_LIST) | \
		sort | \
		awk 'BEGIN {FS = ".PHONY: |## "}; {printf "\033[36m%-19s\033[0m %s\n", $$2, $$3}'