Makefile

SHELL = bash

.DEFAULT_GOAL := main
.PHONY := headers compile install main clean pylint test all docs help uninstall

PY = python3
MANAGE = $(PY) ./manage.py
INSTALLATION_PATH = /usr/bin/cati

GIT_IS_INSTALLED = 0
ifneq (,$(shell command -v git))
GIT_IS_INSTALLED = 1
endif

### headers		update codes copyright headers
headers:
	@$(MANAGE) update-headers
	@echo -e "\033[32mCode copyright headers updated successfuly\033[0m"

### compile		compile program with pyinstaller
compile: all
	$(PY) -m PyInstaller cati/__main__.py --onefile --name cati

### install		installs program on system
install: ./dist/cati
	@cp ./dist/cati $(INSTALLATION_PATH)
	@mkdir -p /usr/share/bash-completion/completions
	@cp ./etc/shell-completion/cati.bash /usr/share/bash-completion/completions/cati
	@mkdir -p /usr/share/man/man1
	@cp ./etc/manpages/cati.1 /usr/share/man/man1/cati.1
	@echo -e "\033[32mCati installed successfuly\033[0m"
	@$(INSTALLATION_PATH)

### uninstall   removes cati from your system(not removes configuration and database)
uninstall: /usr/bin/cati
	@rm $(INSTALLATION_PATH)
	@rm /usr/share/bash-completion/completions/cati
	@rm /usr/share/man/man1/cati.1
	@echo -e "\033[32mCati REMOVED successfuly\033[0m"

### clean		clear build files
clean:
	@rm dist/ build/ *.spec *.egg-info -rf
	@echo -e "\033[32mall of build files cleared successfuly\033[0m"

main: compile

### pylint		check code with pylint
pylint:
	@$(PY) -m pylint $(shell find cati -type f -name "*.py") | grep -v "(invalid-name)" > pylint.out

### docs		generates api documentation
docs:
	@rm -rf doc/api
	@printf 'Generating doc... '
	@PYTHONPATH='$(shell pwd)' $(PY) -m pdoc cati --output-dir doc/api --skip-errors &> /dev/null
	@echo "#### This api documentation is auto generated from docstrings with pdoc" > doc/api/README.md
	-@MANWIDTH=80 man etc/manpages/cati.1 > doc/cli-manual.txt
	@printf '\033[32mFinished\033[0m\n'

### test		run tests
test:
	@echo ''
	@$(PY) tests/run.py
	@echo ''

### help		shows this help
help:
	@echo 'Makefile commands:'
	@cat $(shell pwd)/Makefile | grep '###' | grep -v '@cat'

### all			do all of actions
all: headers docs test
ifeq (1,$(GIT_IS_INSTALLED))
	-@git status
endif