Makefile

# =============================================================================
# MAKEFILE FOR streamlit-shap-app
# =============================================================================
#
# To do stuff with make, you type `make` in a directory that has a file called
# "Makefile". You can also type `make -f <makefile>` to use a different filename.
#
# A Makefile is a collection of rules. Each rule is a recipe to do a specific
# thing, sort of like a grunt task or an npm package.json script.
#
# A rule looks like this:
#
# <target>: <prerequisites...>
# 	<commands>
#
# The "target" is required. The prerequisites are optional, and the commands
# are also optional, but you have to have one or the other.
#
# Type `make` to show the available targets and a description of each.
#

# =============================================================================
# GLOBAL VARIABLES
# =============================================================================

PROJECTNAME := $(shell basename "$(PWD)")
PYTHON_INTERPRETER := python3.10
COMMIT_ID=$(shell git rev-parse HEAD)

.SILENT: ;               # no need for @

# =============================================================================
# ENVIRONMENT SETUP
# =============================================================================

##@ Environment

setup: poetry-install pre-commit-install  ## Setup Virtual Environment

    poetry-install:  ## Install dependencies using Poetry
		poetry env use $(PYTHON_INTERPRETER)
		poetry install
		poetry self add poetry-plugin-up

    pre-commit-install:  ## Install pre-commit hooks
		poetry run pre-commit install

.PHONY: setup poetry-install pre-commit-install

update-deps: pip-upgrade poetry-update pre-commit-autoupdate  ## Update dependencies

    pip-upgrade:  ## Upgrade pip
		poetry run pip install --upgrade pip

    poetry-update:  ## Update Poetry dependencies
		poetry self update
		poetry update
		poetry lock

    pre-commit-autoupdate:  ## Update pre-commit hooks
		poetry run pre-commit autoupdate -c .pre-commit-config.yaml

upgrade-deps: update-deps ## Upgrade dependencies to the latest versions
	# https://github.com/MousaZeidBaker/poetry-plugin-up
	poetry up
	$(MAKE) freeze-deps


.PHONY: update-deps upgrade-deps local pip-upgrade poetry-update pre-commit-autoupdate

local: setup update-deps  ## Locally install the package
	poetry run python src/shap_app --help

activate:  ## Activate the virtual environment
	poetry shell

freeze-deps:
	poetry run pip-compile --upgrade --output-file=pip/requirements.txt --resolver=backtracking --verbose

.PHONY: activate freeze-deps local

# =============================================================================
# DEVELOPMENT
# =============================================================================

##@ Development

load-env:  ## Load environment variables
	# add to main application
	python -c "from dotenv import load_dotenv; load_dotenv()"

add-all:  ## Add all files to git
	# not added to `pre-commit-tool` in order to prevent unwanted behavior when running in workflows
	git add -A

pre-commit: add-all  ## Manually run all pre-commit hooks
	poetry run pre-commit run -c .pre-commit-config.yaml

pre-commit-tool:  ## Manually run a single pre-commit hook (e.g. `make pre-commit-tool TOOL=black`)
	poetry run pre-commit run --hook-stage manual $(TOOL) -c .pre-commit-config.yaml

# https://commitizen-tools.github.io/commitizen/bump/
#commit: pre-commit tests  ## Commit changes
commit: pre-commit  ## Commit changes
	./scripts/commit.sh

bump:  ## Bump version and update changelog
	poetry run cz bump --changelog --check-consistency --annotated-tag --retry
	git push -u origin HEAD --follow-tags

.PHONY: pre-commit pre-commit-tool commit bump

check-newrelic:  ## Check New Relic configuration
	poetry run newrelic-admin validate-config newrelic.ini

run-newrelic:  ## Run New Relic
	poetry run NEW_RELIC_CONFIG_FILE=newrelic.ini newrelic-admin run-program shap-app

# =============================================================================
# TESTING
# =============================================================================

##@ Testing

tests: unit-tests  ## run all tests
	@echo "+ $@"

unit-tests: ## run unit-tests with pytest
	@echo "+ $@"
	@TEST_MODE=True poetry run python -m pytest  -vvvvsra --doctest-modules tests/

unit-tests-cov: ## run unit-tests with pytest and show coverage (terminal + html)
	@echo "+ $@"
	@TEST_MODE=True poetry run pytest -vvvvsra -p no:cacheprovider --doctest-modules --cov=src \
	--cov-report term-missing --cov-report=html tests/

unit-tests-cov-fail: ## run unit-tests and show coverage (terminal + xml) & fail if coverage too low & create files for CI
	@echo "+ $@"
	@TEST_MODE=True poetry run pytest -vvvvsra -p no:cacheprovider --doctest-modules --cov=src \
	--cov-report term-missing --cov-report=xml --cov-fail-under=10 --junitxml=pytest.xml \
	tests/ | tee pytest-coverage.txt

single-test: ## run a single test with pytest (e.g. `make single-test TEST=tests/test_utils.py::test_get_project_root`)
	@echo "+ $@"
	@TEST_MODE=True poetry run pytest -vvvvsra --doctest-modules -k $(TEST)

clean-cov: ## remove output files from pytest & coverage
	@rm -rf .coverage
	@rm -rf coverage.xml
	@rm -rf htmlcov
	@rm -rf pytest.xml
	@rm -rf pytest-coverage.txt
	@rm -rf dist

.PHONY: tests unit-tests unit-tests-cov unit-tests-cov-fail single-test

# =============================================================================
# DOCUMENTATION
# =============================================================================

##@ Documentation

docs-serve: ## serve documentation locally
	mkdocs serve

docs-build: ## build documentation locally
	mkdocs build

docs-deploy: ## build & deploy documentation to "gh-pages" branch
	mkdocs gh-deploy -m "docs: update documentation" -v --force

clean-docs: ## remove output files from mkdocs
	rm -rf site

.PHONY: docs-serve docs-build docs-deploy clean-docs

# =============================================================================
# RUN APPLICATION
# =============================================================================

##@ Run Application
run:  ## Run the application
	poetry run streamlit run src/shap_app/app.py

.PHONY: run

# =============================================================================
# BUILD & RELEASE
# =============================================================================

##@ Build & Release

clean: clean-docs  clean-cov  ## Clean package
	find . -type d -name '__pycache__' | xargs rm -rf
	find . -type d -name '.temp' | xargs rm -rf
	find . -type f -name '.coverage' | xargs rm -rf
	rm -rf build dist

build:  pre-commit tests clean  ## Build the project
	poetry build

deploy:  ## Deploy to PyPI
	poetry publish --build

.PHONY: build clean deploy

# -----------------------------------------------------------------------------
# GIT
# -----------------------------------------------------------------------------

##@ Git Shortcuts

git-commit-num:
	@echo "+ $@"
	@echo $(shell git rev-list --all --count)

.PHONY: git-commit-num

current_branch := $(shell git symbolic-ref --short HEAD)

checkout-main:  ## Switch to main branch
	@echo "+ $@"
	if [ "$(current_branch)" != "main" ]; then \
		git checkout main; \
	fi
	git pull --all
	git fetch --tags

.PHONY: checkout-main

commit_count := $(shell git rev-list --all --count)

check-branch-name:
ifeq ($(BRANCH),)
	$(error BRANCH variable is not set. Please provide a branch name with BRANCH=mybranch)
endif

new-branch: check-branch-name  ## Create a new branch
	git checkout -b $(BRANCH)_$(commit_count)

new-feat-branch: check-branch-name  ## Create a new feature branch
	git checkout -b feat/$(BRANCH)_$(commit_count)

new-version-branch:  ## Create a new version branch
	NEW_VERSION=$(shell poetry run cz bump --dry-run | grep 'bump: version' | awk -F ' ' '{print $$NF}'); \
	git checkout -b v$$NEW_VERSION

.PHONY: check-branch-name new-branch new-feat-branch new-version-branch

# =============================================================================
# ADDITIONAL
# =============================================================================

# =============================================================================
# SELF DOCUMENTATION
# =============================================================================

##@ Help

.DEFAULT_GOAL := help
.PHONY: help

help:  ## Display this help
	echo
	echo " The following commands can be run for "$(PROJECTNAME)":"
	echo
	awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n  make \033[36m<target>\033[0m\n"} /^[a-zA-Z_-]+:.*?##/ \
	{ printf "  \033[36m%-20s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' \
	$(MAKEFILE_LIST)