Makefile

PY=python3
VENV=venv
BIN=$(VENV)/bin
PYTHON=$(BIN)/python


# -------------------------------------------------------------------
# Development-related commands
# Run commands inside virtualenv - https://earthly.dev/blog/python-makefile/
# -------------------------------------------------------------------


$(VENV)/bin/activate: requirements.txt
	$(PY) -m venv $(VENV)
	@echo "\n\033[1;36m[2/3] Upgrading pip and installing requirements 🔧 📦 🔧 \033[0m\n"
	$(PYTHON) -m pip install --upgrade pip
	$(BIN)/pip install -r requirements.txt


install-django: $(VENV)/bin/activate
	@echo "\033[1;37m---- Installing Django 💚 ---- \033[0m\n"
	$(PYTHON) -m pip install Django~=3.2.7


# -------------------------------------------------------------------
# Local development-related commands
# -------------------------------------------------------------------


## @(development) - Run the example app
run-example: install-django
	@echo "\033[1;37m---- Running migrations 🗂 ---- \033[0m\n"
	$(PYTHON) example/manage.py migrate --noinput --settings=example.project.settings
	@echo "\n\033[1;37m---- Loading fixtures 💽 ---- \033[0m\n"
	$(PYTHON) example/manage.py loaddata fake_data.json --settings=example.project.settings
	@echo "\n\033[1;37m---- Running server 🏃‍♀️ ---- \033[0m\n"
	$(PYTHON) example/manage.py runserver --settings=example.project.settings


## @(development) - Run tests with coverage and make reports
coverage: install-django
	@echo "\033[1;37m---- Running unittests 🧪✨ ---- \033[0m\n"
	DJANGO_SETTINGS_MODULE=tests.settings \
	$(BIN)/coverage run -m django test && $(BIN)/coverage report
	$(BIN)/coverage html
	$(BIN)/coverage xml


## @(development) - Run linting and formatting checks
lint: $(VENV)/bin/activate
	@echo "\n\033[1;36m[1/4] Running pycln check 👻 🧹 👻\033[0m\n"
	$(BIN)/pycln . --config pyproject.toml -vc
	@echo "\n\033[1;36m[2/4] Running isort check 👀 👀 👀\033[0m\n"
	$(BIN)/isort . -vc
	@echo "\n\033[1;36m[3/4] Running black check 🖤 🔥 🖤\033[0m\n"
	$(BIN)/black  . -v --check
	@echo "\n\033[1;36m[4/4] Running flake8 🥶 🍦 🥶\033[0m\n"
	$(BIN)/flake8 .


## @(development) - Run linting and formatting
format: $(VENV)/bin/activate
	@echo "\n\033[1;36m[1/4] Running pycln 👻 🧹 👻\033[0m\n"
	$(BIN)/pycln . --config pyproject.toml -v
	@echo "\n\033[1;36m[2/4] Running isort 👀 👀 👀\033[0m\n"
	$(BIN)/isort . -v
	@echo "\n\033[1;36m[3/4] Running black 🖤 🔥 🖤\033[0m\n"
	$(BIN)/black  . -v
	@echo "\n\033[1;36m[4/4] Running flake8 🥶 🍦 🥶\033[0m\n"
	$(BIN)/flake8 .


# -------------------------------------------------------------------
# Misc. commands
# -------------------------------------------------------------------


## @(misc) - Remove cached files and dirs from workspace
clean:
	@echo "\033[1;37m---- Cleaning workspace 🧹💨 ----\033[0m\n"
	find . -type f -name "*.pyc" -delete
	find . -type d -name "__pycache__" -delete
	find . -type f -name "*.DS_Store" -delete


## @(misc) - Remove virtualenv directory
rm-venv:
	@echo "\033[1;37m---- Removing virtualenv 🗂 🧹💨 ----\033[0m\n"
	rm -rf $(VENV)


# -------------------------------------------------------------------
# Self-documenting Makefile targets - https://git.io/Jg3bU
# -------------------------------------------------------------------

.DEFAULT_GOAL := help

help:
	@echo "Usage:"
	@echo "  make <target>"
	@echo ""
	@echo "Targets:"
	@awk '/^[a-zA-Z\-\_0-9]+:/ \
		{ \
			helpMessage = match(lastLine, /^## (.*)/); \
			if (helpMessage) { \
				helpCommand = substr($$1, 0, index($$1, ":")-1); \
				helpMessage = substr(lastLine, RSTART + 3, RLENGTH); \
				helpGroup = match(helpMessage, /^@([^ ]*)/); \
				if (helpGroup) { \
					helpGroup = substr(helpMessage, RSTART + 1, index(helpMessage, " ")-2); \
					helpMessage = substr(helpMessage, index(helpMessage, " ")+1); \
				} \
				printf "%s|  %-18s %s\n", \
					helpGroup, helpCommand, helpMessage; \
			} \
		} \
		{ lastLine = $$0 }' \
		$(MAKEFILE_LIST) \
	| sort -t'|' -sk1,1 \
	| awk -F '|' ' \
			{ \
			cat = $$1; \
			if (cat != lastCat || lastCat == "") { \
				if ( cat == "0" ) { \
					print "\nTargets:" \
				} else { \
					gsub("_", " ", cat); \
					printf "\n%s\n", cat; \
				} \
			} \
			print $$2 \
		} \
		{ lastCat = $$1 }'
	@echo ""