Makefile

SHELL = /usr/bin/env bash

# Sources Root
SOURCES_ROOT = $(CURDIR)/src

# Python
PYTHON = python3
PYTHON_PIP = $(PYTHON) -m pip
PYTHON_PIP_VERSION_SPECIFIER = ==22.3.1
PYTHON_VIRTUALENV_DIR = venv

# Tox
TOXENV ?= py310

.DEFAULT_GOAL := help
.PHONY: help
.PHONY: clean clean-build clean-pyc clean-test
.PHONY: install-dev install-deps-dev
.PHONY: lint test test-all test-coverage
.PHONY: test-coverage-report test-coverage-report-console test-coverage-report-xml test-coverage-report-html
.PHONY: docs build dist deploy upload-release
.PHONY: docker-compose-run-test
.PHONY: python-virtualenv
.PHONY: python-pip-install

help:
	@grep '^[a-zA-Z]' $(MAKEFILE_LIST) | sort | awk -F ':.*?## ' 'NF==2 {printf "\033[36m  %-25s\033[0m %s\n", $$1, $$2}'

clean: clean-build clean-pyc clean-test ## remove all build, test, lint, coverage and Python artifacts

clean-build: ## remove build artifacts (dist, docs, etc)
	rm -rf .eggs/
	rm -rf build/
	rm -rf docs/_build/
	rm -f docs/fd_dj_accounts.rst
	rm -f docs/modules.rst
	rm -rf dist/
	find . -name '*.egg-info' -exec rm -rf {} +
	find . -name '*.egg' -exec rm -f {} +

clean-pyc: ## remove Python file artifacts
	find . -name '*.pyc' -exec rm -f {} +
	find . -name '*.pyo' -exec rm -f {} +
	find . -name '*~' -exec rm -f {} +
	find . -name '__pycache__' -exec rm -rf {} +

clean-test: ## remove test, lint and coverage artifacts
	rm -rf .cache/
	rm -rf .tox/
	rm -f .coverage
	rm -rf htmlcov/
	rm -rf test-reports/
	rm -rf .mypy_cache/

install-dev: install-deps-dev
install-dev: ## Install for development
	python -m pip install --editable .
	python -m pip check

install-deps-dev: python-pip-install
install-deps-dev: ## Install dependencies for development
	python -m pip install -r requirements.txt
	python -m pip check

	python -m pip install -r requirements_test.txt
	python -m pip check

	python -m pip install -r requirements_release.txt
	python -m pip check

lint: FLAKE8_FILES = *.py "$(SOURCES_ROOT)"
lint: ## run tools for code style analysis, static type check, etc
	flake8  --config=setup.cfg  $(FLAKE8_FILES)
	mypy  --config-file setup.cfg

test: ## run tests quickly with the default Tox Python
	tox -e "$(TOXENV)"

test-all: ## run tests on every Python version with tox
	tox

test-coverage: ## run tests and record test coverage
	coverage run --rcfile=setup.cfg runtests.py tests

test-coverage-report: test-coverage-report-console
test-coverage-report: test-coverage-report-xml
test-coverage-report: test-coverage-report-html
test-coverage-report: ## Run tests, measure code coverage, and generate reports

test-coverage-report-console: ## print test coverage summary
	coverage report --rcfile=setup.cfg -m

test-coverage-report-xml: ## Generate test coverage XML report
	coverage xml --rcfile=setup.cfg

test-coverage-report-html: ## generate test coverage HTML report
	coverage html --rcfile=setup.cfg

docs: ## generate Sphinx HTML documentation, including API docs
	rm -f docs/fd_dj_accounts.rst
	rm -f docs/modules.rst
	sphinx-apidoc -o docs/ "$(SOURCES_ROOT)/fd_dj_accounts"
	$(MAKE) -C docs clean
	$(MAKE) -C docs html

build: ## Build Python package
	$(PYTHON) setup.py build

dist: build ## builds source and wheel package
	python setup.py sdist
	python setup.py bdist_wheel
	twine check dist/*
	ls -l dist

upload-release: ## upload dist packages
	python -m twine upload 'dist/*'

deploy: upload-release
deploy: ## Deploy or publish

python-virtualenv: ## Create virtual Python environment
	$(PYTHON) -m venv "$(PYTHON_VIRTUALENV_DIR)"

python-pip-install: ## Install Pip
	$(PYTHON_PIP) install 'pip$(PYTHON_PIP_VERSION_SPECIFIER)'

docker-compose-run-test: export COMPOSE_FILE = docker-compose.yml:docker-compose.test.yml
docker-compose-run-test:  ## Run tests with Docker Compose
	docker compose run --rm --env TOXENV=py38 -- app-python3.8
	docker compose run --rm --env TOXENV=py39 -- app-python3.9
	docker compose run --rm --env TOXENV=py310 -- app-python3.10