Makefile

.PHONY: clean docs package run clean_raw clean_de clean_features start_jupyter

#################################################################################
# GLOBALS                                                                       #
#################################################################################

PROJECT_DIR := $(shell dirname $(realpath $(lastword $(MAKEFILE_LIST))))
DATA_DIR := $(realpath data)
PROFILE = default
PROJECT_NAME = phantasyfootballer
PYTHON_INTERPRETER = python

## Execute the kedro run command
run:
	kedro run

## Run the data import pipeline
download_data: clean_raw
	kedro run --pipeline di

## Transform all notebooks to scripts (use the path for 1 notebook)
notebook_convert:
	kedro jupyter convert --all

## Clean up the raw data files - delete all files in 01_raw
## (data will need to be re-downloaded)
clean-raw:
	find data/01_raw -type f -name '*.csv' -delete

## Clean intermediate files - delete all files in 02_intermediate
clean-intermediate:
	find data/02_intermediate -type f -name '*.csv' -delete

## Clean primary data - delete all files in 03_primary
clean-primary:
	find data/03_primary -type f -name '*.csv' -delete

## Remove files associated with data engineering (primary/intermediate)
clean-de: clean-primary clean-intermediate

## delete data features - delete all files in 04_feature
clean-features:
	find data/04_feature -type f -name '*.csv' -delete

## delete all generated data (features, primary, intermediate, raw)
clean-data: clean-features clean-primary clean-intermediate clean-raw

## Clean up the old files
clean:
	rm -fv src/dist/.

## Clean up journals and trim logs
clean-logs:
	touch logs/errors_2.log logs/info_2.log logs/info.log logs/errors.log
	tail -100 logs/errors.log > logs/errors_2.log 
	mv -f logs/errors_2.log logs/errors.log
	tail -100 logs/info.log > logs/info_2.log
	mv -f logs/info_2.log logs/info.log
	rm -f logs/journals/*.log

## Package the Python code in to an .egg and .wheel
package: clean
	kedro package

## Do all the pre-checks
pre-reqs: pre-check

### Do the pre-checks
pre-check: unittest
	black .
	flake8
	mypy

## Update version for a patch (do this after pulling)
patch: 
	bump2version --allow-dirty --verbose patch

## Update version on each commit
build: pre-check
	bump2version --allow-dirty --verbose build

## Update version that will be released (takes off the dev tag, do this before pushing)
release: 
	bump2version --verbose release

## Print the current version
current-version:
	@bump2version -n --allow-dirty --list patch | awk 'BEGIN {FS="="}; /current_version=/ {print $2}'

## Build api odx using Sphinx
docs:
	kedro build-docs

## Install Python Dependencies
requirements:
	kedro build-reqs

## Start jupyter
start_jupyter:
	jupyter notebook --ip=0.0.0.0 \
		--port=7999 --allow-root --no-browser \
		--notebook-dir /workspaces/phantasyfootballer/notebooks --autoreload

## Run unit tests
unittest:
	pytest

#################################################################################
# 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')