Makefile

.PHONY: reqs up down rm clean lint format unused safe types precommit

-include .env
export

## Install requrements
reqs:
	poetry install

## Start the app
up:
	docker compose -p redbox-copilot-streamlit --profile frontend --profile backend-core up --build --detach

## Stop the app
down:
	docker compose -p redbox-copilot-streamlit down

## Removes all data from data dir
rm:
	make down
	find data/* \( -type f -o -type d \) ! -name '.gitkeep' -delete

## Stop the app and remove unnecesary data
clean:
	docker compose down -v --rmi all --remove-orphans
	make rm

## Lint the codebase
lint:
	poetry run ruff check . --fix

## Format the codebase
format:
	poetry run ruff format .
	poetry run ruff format **/*.ipynb

## Find unusued code
unused:
	vulture .
	deptry .

## Scan the codebase for safety issues
safe:
	poetry run bandit -ll -c pyproject.toml -r .

## Scan the codebase for typing issues
types:
	poetry run mypy redbox streamlit_app --ignore-missing-imports

## Run all precommit hooks without running git
precommit:
	pre-commit run -a


#################################################################################
# Self Documenting Commands                                                     #
#################################################################################

.DEFAULT_GOAL := help

# Inspired by <http://marmelab.com/blog/2016/02/29/auto-documented-makefile.html>
# sed script explained:
# /^##/:
# 	* save line in hold space
# 	* purge line
# 	* Loop:
# 		* append newline + line to hold space
# 		* go to next line
# 		* if line starts with doc comment, strip comment character off and loop
# 	* remove target prerequisites
# 	* append hold space (+ newline) to line
# 	* replace newline plus comments by `---`
# 	* print line
# Separate expressions are necessary because labels cannot be delimited by
# semicolon; see <http://stackoverflow.com/a/11799865/1968>
.PHONY: help
help:
	@echo "$$(tput bold)Available rules:$$(tput sgr0)"
	@echo
	@sed -n -e "/^## / { \
		h; \
		s/.*//; \
		:doc" \
		-e "H; \
		n; \
		s/^## //; \
		t doc" \
		-e "s/:.*//; \
		G; \
		s/\\n## /---/; \
		s/\\n/ /g; \
		p; \
	}" ${MAKEFILE_LIST} \
	| LC_ALL='C' sort --ignore-case \
	| awk -F '---' \
		-v ncol=$$(tput cols) \
		-v indent=19 \
		-v col_on="$$(tput setaf 6)" \
		-v col_off="$$(tput sgr0)" \
	'{ \
		printf "%s%*s%s ", col_on, -indent, $$1, col_off; \
		n = split($$2, words, " "); \
		line_length = ncol - indent; \
		for (i = 1; i <= n; i++) { \
			line_length -= length(words[i]) + 1; \
			if (line_length <= 0) { \
				line_length = ncol - indent - length(words[i]) - 1; \
				printf "\n%*s ", -indent, " "; \
			} \
			printf "%s ", words[i]; \
		} \
		printf "\n"; \
	}' \
	| more $(shell test $(shell uname) = Darwin && echo '--no-init --raw-control-chars')