Makefile

# Makefile for the Python project
#
# It supports creating distribution files, and deploying them to Pypi and Pypitest or installing them locally
#
# A Python interpreter is required, and it should be accessible from the command line.
 
# Sets the variables.
 
# Sets the Python executable.
# It will be the executable for the interpreter set up for the command line.
PYTHON   = python3
 
# Sets the distribution folder.
# It will be the 'dist' folder.
DISTDIR   = dist
 
# Sets the .egg file path.
# The file will be located at the project's root.
EGGDIR    = dice-notation.egg-info

# Sets the tox folder path.
# It will be the '.tox' folder.
TOXDIR    = .tox

# Sets the docs output folder path.
# It will be in the 'docs' folder.
DOCBUILDDIR = docs\\build

# User-friendly check for sphinx-build
ifeq ($(shell which $(PYTHON) >/dev/null 2>&1; echo $$?), 1)
$(error The '$(PYTHON)' command was not found. Make sure you have a version of the python interpreter installed, then add the directory where it was installed to the PATH.)
endif

.PHONY: help clean

# Help option
# Shows the allowed commands to be received as parameters
help:
	@echo "Please use 'make <target>' where <target> is one of"
	@echo "  clean          to remove the distribution folders"
	@echo "  build          to build the distribution"
	@echo "  install        to install the project"
	@echo "  requirements   to install the project requirements"
	@echo "  register       to register on pypi"
	@echo "  register-test  to register on testpypi"
	@echo "  deploy         to upload to pypi"
	@echo "  deploy-test    to upload to testpypi"
	@echo "  test           to run tests"

# Clean option
# Removes the distribution folder and the .egg file
clean:
	rm -r -f $(DISTDIR)
	rm -r -f $(EGGDIR)
	rm -r -f $(TOXDIR)
	rm -r -f $(DOCBUILDDIR)

# Distribution.
build:
	$(PYTHON) setup.py sdist

# Install in local libraries repository
install:
	$(PYTHON) setup.py install

# Install the project requirements
requirements:
	pip install --upgrade -r requirements.txt

# Pypi registration.
register:
	$(PYTHON) setup.py register -r pypi

# Pypitest registration.
register-test:
	$(PYTHON) setup.py register -r testpypi

# Pypi deployment.
deploy:
	$(PYTHON) setup.py sdist
	twine upload dist/*

# Pypitest deployment.
deploy-test:
	$(PYTHON) setup.py sdist upload -r testpypi

# Tests suite.
test:
	tox