Makefile

# the default goal is build
.DEFAULT_GOAL := build

# Set the shell to bash
SHELL := /bin/bash

# Get the location of the Python package binaries.
PYTHON_PACKAGE_BINARIES := $(shell python3 -m site --user-base)/bin

# Get the current working directory
CWD := $(shell pwd)

# Get the bookbuilderpy version.
VERSION := $(shell (less '$(CWD)/bookbuilderpy/version.py' | sed -n 's/__version__.*=\s*"\(.*\)"/\1/p'))

# Print the status information.
status:
	echo "working directory: '$(CWD)'." &&\
	echo "bookbuilderpy version to build: '$(VERSION)'." &&\
	echo "python package binaries: '$(PYTHON_PACKAGE_BINARIES)'." &&\
	echo "shell: '$(SHELL)'"

# Cleaning means that the package is uninstalled if it is installed.
# Also, all build artifacts are deleted (as they will be later re-created).
clean: status
	echo "Cleaning up by first uninstalling bookbuilderpy (if installed) and then deleting all auto-generated stuff." && \
	pip uninstall -y bookbuilderpy || true && \
	echo "bookbuilderpy is no longer installed; now deleting auto-generated stuff." && \
	rm -rf bookbuilderpy.egg-info && \
	rm -rf .pytest_cache && \
	rm -rf build && \
	rm -rf dist && \
	rm -rf *.whl && \
	rm -rf docs/build && \
	mv docs/source/index.rst docs/source/index.x && \
	rm -rf docs/source/*.rst && \
	mv docs/source/index.x docs/source/index.rst && \
	echo "Done cleaning up, bookbuilderpy is uninstalled and auto-generated stuff is deleted."

# Initialization: Install all requirements, both for executing the library and for the tests.
init: clean
	echo "Initialization: first install required packages from requirements.txt." && \
	pip --no-input --timeout 360 --retries 100 install -r requirements.txt && ## nosem \
	echo "Finished installing required packages from requirements.txt, now installing packages required for development from requirements-dev.txt." && \
	pip --no-input --timeout 360 --retries 100 install -r requirements-dev.txt && ## nosem \
	echo "Finished installing requirements from requirements-dev.txt."

# Run the unit tests.
test: init
	echo "$(NOW): Erasing old coverage data." &&\
	coverage erase &&\
	echo "$(NOW): The original value of PATH is '${PATH}'." &&\
	export PATH="${PATH}:${PYTHON_PACKAGE_BINARIES}" &&\
	echo "$(NOW): PATH is now '${PATH}'." &&\
	echo "$(NOW): Running pytest tests." && \
	timeout --kill-after=15s 90m coverage run --include="bookbuilderpy/*" -m pytest --strict-config tests && \
	echo "$(NOW): Running pytest with doctests." && \
	timeout --kill-after=15s 90m coverage run -a --include="bookbuilderpy/*" -m pytest --strict-config --doctest-modules --ignore=tests && \
	echo "$(NOW): Finished running pytest tests."

# Perform static code analysis.
static_analysis: init
	echo "$(NOW): The original value of PATH is '${PATH}'." &&\
	export PATH="${PATH}:${PYTHON_PACKAGE_BINARIES}" &&\
	echo "$(NOW): PATH is now '${PATH}'." &&\
	echo "$(NOW): Running static code analysis, starting with flake8." && \
	flake8 . --ignore=,B008,B009,B010,DUO102,TRY003,TRY101,W503 && \
	echo "$(NOW): Finished running flake8, now applying pylint to package." &&\
	pylint bookbuilderpy --disable=C0103,C0302,C0325,R0801,R0901,R0902,R0903,R0911,R0912,R0913,R0914,R0915,R1702,R1728,W0212,W0238,W0703 &&\
	echo "$(NOW): Done with pylint, now trying mypy." &&\
	mypy bookbuilderpy --no-strict-optional --check-untyped-defs &&\
	echo "$(NOW): Done with mypy, now doing pyflakes." &&\
	python3 -m pyflakes . &&\
	echo "$(NOW): Done with pyflakes, now applying bandit to find security issues." &&\
	bandit -r bookbuilderpy -s B311 &&\
	bandit -r tests -s B311,B101 &&\
	echo "$(NOW): Done with bandit, now using pyroma to check setup.py." &&\
	pyroma . &&\
	echo "$(NOW): Done with pyroma, now applying semgrep." &&\
	(semgrep --error --strict --use-git-ignore --skip-unknown-extensions --optimizations all --config=auto || semgrep --error --strict --use-git-ignore --skip-unknown-extensions --optimizations all --config=auto --verbose) &&\
	echo "$(NOW): Done with semgrep, now applying pydocstyle." &&\
	pydocstyle --convention=pep257 &&\
	echo "$(NOW): Done with pydocstyle, now applying tryceratops." &&\
	tryceratops -i TRY003 -i TRY101 bookbuilderpy &&\
	tryceratops -i TRY003 -i TRY101 tests &&\
	echo "$(NOW): Done with tryceratops, now applying unimport." &&\
	unimport bookbuilderpy &&\
	unimport tests &&\
	echo "$(NOW): Done with unimport, now applying vulture." &&\
	vulture . --min-confidence 61 &&\
	echo "$(NOW): Done with vulture, now applying dodgy." &&\
	dodgy &&\
	echo "$(NOW): Done with dodgy, now running pycodestyle." &&\
	pycodestyle bookbuilderpy &&\
	pycodestyle tests &&\
	echo "$(NOW): Done with pycodestyle, now running ruff." &&\
	ruff --target-version py310 --select A,ANN,B,C,C4,COM,D,DJ,DTZ,E,ERA,EXE,F,G,I,ICN,INP,ISC,N,NPY,PIE,PLC,PLE,PLR,PLW,PT,PYI,Q,RET,RSE,RUF,S,SIM,T,T10,T20,TID,TRY,UP,W,YTT --ignore=ANN001,ANN002,ANN003,ANN101,ANN204,ANN401,B008,B009,B010,C901,D203,D208,D212,D401,D407,D413,N801,PLR0911,PLR0912,PLR0913,PLR0915,PLR2004,RUF100,TRY003,UP035 --line-length 79 bookbuilderpy &&\
	ruff --target-version py310 --select A,ANN,B,C,C4,COM,D,DJ,DTZ,E,ERA,EXE,F,G,I,ICN,ISC,N,NPY,PIE,PLC,PLE,PLR,PLW,PYI,Q,RET,RSE,RUF,T,SIM,T10,T20,TID,TRY,UP,W,YTT --ignore=ANN001,ANN002,ANN003,ANN101,ANN204,ANN401,B008,B009,B010,C901,D203,D208,D212,D401,D407,D413,N801,PLR0911,PLR0912,PLR0913,PLR0915,PLR2004,RUF100,TRY003,UP035 --line-length 79 tests &&\
    echo "$(NOW): Done with ruff, now running autoflake." &&\
    autoflake -c -r bookbuilderpy &&\
    autoflake -c -r tests &&\
	echo "$(NOW): Done: All static checks passed."

# We use sphinx to generate the documentation.
# This automatically checks the docstrings and such and such.
create_documentation: static_analysis test
	echo "The original value of PATH is '${PATH}'." &&\
	export PATH="${PATH}:${PYTHON_PACKAGE_BINARIES}" &&\
	echo "PATH is now '${PATH}'." &&\
	echo "First creating the .rst files from the source code." && \
	sphinx-apidoc -M --ext-autodoc -o docs/source ./bookbuilderpy && \
	echo "Now creating the documentation build folder and building the documentation." && \
	sphinx-build -W -a -E -b html docs/source docs/build && \
	echo "Done creating HTML documentation, cleaning up documentation temp files." && \
	mv docs/source/index.rst docs/source/index.tmp && \
	rm -rf docs/source/*.rst && \
	rm -rf docs/source/*.md && \
	mv docs/source/index.tmp docs/source/index.rst && \
	echo "Now copying LICENSE." &&\
	pygmentize -f html -l text -O full -O style=default -o docs/build/LICENSE.html LICENSE &&\
	echo "Finished copying LICENSE, now creating coverage report." &&\
	mkdir -p docs/build/tc &&\
	coverage html -d docs/build/tc --include="bookbuilderpy/*" &&\
	echo "Now creating coverage badge." &&\
	coverage-badge -o docs/build/tc/badge.svg &&\
	if [[ -f docs/build/tc/badge.svg ]];then \
		echo "docs/build/tc/badge.svg exists."; \
	else \
		echo "docs/build/tc/badge.svg does not exist!"; exit 1; \
	fi &&\
	echo "Deleting .gitignore file." &&\
	rm -f docs/build/tc/.gitignore &&\
	echo "Done creating coverage data. Now creating .nojekyll files." &&\
	touch "docs/build/.nojekyll" &&\
	touch "docs/build/.doctrees/.nojekyll" &&\
	touch "docs/build/_modules/.nojekyll" &&\
	touch "docs/build/_sources/.nojekyll" &&\
	touch "docs/build/tc/.nojekyll" &&\
	echo "Done creating the documentation."

# Create different distribution formats, also to check if there is any error.
create_distribution: static_analysis test create_documentation
	echo "Now building source distribution file." &&\
	python3 setup.py check &&\
	python3 -m build &&\
	echo "Done with the build process, now checking result." &&\
	python3 -m twine check dist/* &&\
	echo "Now testing the tar.gz." &&\
	export tempDir=`mktemp -d` &&\
	echo "Created temp directory '$$tempDir'. Creating virtual environment." &&\
	python3 -m venv "$$tempDir" &&\
	echo "Created virtual environment, now activating it." &&\
	source "$$tempDir/bin/activate" &&\
	echo "Now installing tar.gz." &&\
	python3 -m pip --no-input --timeout 360 --retries 100 --require-virtualenv install "$(CWD)/dist/bookbuilderpy-$(VERSION).tar.gz" && ## nosem \
	echo "Installing tar.gz has worked. We now create the list of packages in this environment via pip freeze." &&\
	pip freeze > "$(CWD)/dist/bookbuilderpy-$(VERSION)-requirements_frozen.txt" &&\
	echo "Now fixing bookbuilderpy line in requirements file." &&\
	sed -i "s/^bookbuilderpy.*/bookbuilderpy==$(VERSION)/" "$(CWD)/dist/bookbuilderpy-$(VERSION)-requirements_frozen.txt" &&\
	echo "Now we deactivate the environment." &&\
	deactivate &&\
	echo "Finished, cleaning up." &&\
	rm -rf "$$tempDir" &&\
	echo "Now testing the wheel." &&\
	export tempDir=`mktemp -d` &&\
	echo "Created temp directory '$$tempDir'. Creating virtual environment." &&\
	python3 -m venv "$$tempDir" &&\
	echo "Created virtual environment, now activating it." &&\
	source "$$tempDir/bin/activate" &&\
	echo "Now installing wheel." &&\
	python3 -m pip --no-input --timeout 360 --retries 100 --require-virtualenv install "$(CWD)/dist/bookbuilderpy-$(VERSION)-py3-none-any.whl" && ## nosem \
	echo "Finished, cleaning up." &&\
	deactivate &&\
	rm -rf "$$tempDir" &&\
	echo "Now also packaging the documentation." &&\
	cd docs/build &&\
	tar --dereference --exclude=".nojekyll" -c * | xz -v -9e -c > "$(CWD)/dist/bookbuilderpy-$(VERSION)-documentation.tar.xz" &&\
	cd $(CWD) &&\
	echo "Successfully finished building source distribution."

# We install the package and see if that works out.
install: create_distribution
	echo "Now installing bookbuilderpy." && \
	pip --no-input --timeout 360 --retries 100 -v install . && \
	echo "Successfully installed bookbuilderpy."

# The meta-goal for a full build
build: status clean init test static_analysis create_documentation create_distribution install
	echo "The build has completed."

# .PHONY means that the targets init and test are not associated with files.
# see https://stackoverflow.com/questions/2145590
.PHONY: build clean create_distribution create_documentation init install static_analysis status test