Makefile

.PHONY: all
all: venv download-libraries pre-commit-install help

.PHONY: help
help: ## Display this help.
	@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n  make \033[36m<target>\033[0m\n"} /^[a-zA-Z_0-9-]+:.*?##/ { printf "  \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)

##@ Development

ACTIVATE_VENV := . venv/bin/activate;
BOARD_MOUNT_POINT ?= /Volumes/PYSQUARED

venv:
	@echo "Creating virtual environment..."
	@python3 -m venv venv
	@$(ACTIVATE_VENV) pip install --upgrade pip --quiet
	@$(ACTIVATE_VENV) pip install --requirement requirements.txt --quiet

.PHONY: download-libraries
download-libraries: venv ## Download the required libraries
	@echo "Downloading libraries..."
	@$(ACTIVATE_VENV) pip install --requirement lib/requirements.txt --target lib --no-deps --upgrade --quiet
	@rm -rf lib/*.dist-info

.PHONY: pre-commit-install
pre-commit-install: venv
	@echo "Installing pre-commit hooks..."
	@$(ACTIVATE_VENV) pre-commit install > /dev/null

.PHONY: fmt
fmt: pre-commit-install ## Lint and format files
	$(ACTIVATE_VENV) pre-commit run --all-files

.PHONY: test
test: venv ## Run tests
	$(ACTIVATE_VENV) python3 -m pytest tests/unit

.PHONY: install
install: build ## Install the project onto a connected PROVES Kit use `BOARD_MOUNT_POINT` to specify the mount point
	rsync -avh artifacts/proves/ $(BOARD_MOUNT_POINT) --delete

.PHONY: clean
clean: ## Remove all gitignored files such as downloaded libraries and artifacts
	git clean -dfX

##@ Build

.PHONY: build
build: download-libraries ## Build the project, store the result in the artifacts directory
	@echo "Creating artifacts/proves"
	@rm -rf artifacts/proves/
	@mkdir -p artifacts/proves
	@cp config.json artifacts/proves/
	@cp ./*.py artifacts/proves/
	@find ./lib -type d -name '__pycache__' -prune -o -type f -print | cpio -pdm artifacts/proves/
	@echo "Creating artifacts/proves.zip"
	@zip -r artifacts/proves.zip artifacts/proves > /dev/null