Makefile

.DEFAULT_GOAL := help
PKG = riptide-ffa

dist: ## Build source distribution, must have installed 'develop' extra dependencies
	python -m build --sdist

docker: ## Build riptide-ffa docker image
	docker build --file docker/Dockerfile --tag ${PKG} .

# NOTE: -e installs in "Development Mode"
# See: https://packaging.python.org/tutorials/installing-packages/
install: ## Install the package in development mode
	pip install -e .

# NOTE: remove the .egg-info directory
uninstall: ## Uninstall the package
	pip uninstall ${PKG}
	rm -rf ${PKG}.egg-info

# GLORIOUS hack to autogenerate Makefile help
# This simply parses the double hashtags that follow each Makefile command
# https://marmelab.com/blog/2016/02/29/auto-documented-makefile.html
help: ## Print this help message
	@echo "Makefile help for ${PKG}"
	@echo "===================================================================="
	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}'

clean: ## Remove all python cache and build files
	find . -type f -name "*.pyc" -delete
	find . -type d -name "__pycache__" -delete
	rm -rf .eggs/
	rm -rf build/
	rm -rf dist/
	rm -rf tmp/
	rm -f .coverage

tests: ## Run the unit tests and print a coverage report
	pytest --cov --verbose --cov-report term-missing riptide/tests

.PHONY: dist docker install uninstall help clean upload upload_test tests