mirror of
https://github.com/TECHNOFAB11/bumpver.git
synced 2025-12-12 06:20:08 +01:00
Apply bootstrapit.sh
This commit is contained in:
Manuel Barkhau
parent
6416df7094
commit
d951483a83
26 changed files with 1260 additions and 80 deletions
425
makefile
Normal file
425
makefile
Normal file
|
|
@ -0,0 +1,425 @@
|
|||
# Helpful Links
|
||||
|
||||
# http://clarkgrubb.com/makefile-style-guide
|
||||
# https://explainshell.com
|
||||
# https://stackoverflow.com/questions/448910
|
||||
# https://shiroyasha.svbtle.com/escape-sequences-a-quick-guide-1
|
||||
|
||||
MAKEFLAGS += --warn-undefined-variables
|
||||
SHELL := /bin/bash
|
||||
.SHELLFLAGS := -O extglob -eo pipefail -c
|
||||
.DEFAULT_GOAL := help
|
||||
.SUFFIXES:
|
||||
|
||||
-include makefile.config.make
|
||||
|
||||
PROJECT_DIR := $(notdir $(abspath .))
|
||||
|
||||
ifndef MODULE_SRC_PATH
|
||||
MODULE_SRC_PATH := $(notdir $(abspath .))
|
||||
endif
|
||||
|
||||
ifndef DEVELOPMENT_PYTHON_VERSION
|
||||
DEVELOPMENT_PYTHON_VERSION := python=3.6
|
||||
endif
|
||||
|
||||
ifndef SUPPORTED_PYTHON_VERSIONS
|
||||
SUPPORTED_PYTHON_VERSIONS := $(DEVELOPMENT_PYTHON_VERSION)
|
||||
endif
|
||||
|
||||
PKG_NAME := $(PACKAGE_NAME)
|
||||
MODULE_SRC_PATH = src/$(PKG_NAME)/
|
||||
|
||||
# TODO (mb 2018-09-23): Support for bash on windows
|
||||
# perhaps we need to install conda using this
|
||||
# https://repo.continuum.io/miniconda/Miniconda3-latest-Windows-x86_64.exe
|
||||
PLATFORM = $(shell uname -s)
|
||||
|
||||
# miniconda is shared between projects
|
||||
CONDA_ROOT := $(shell if [[ -d /opt/conda ]]; then echo "/opt/conda"; else echo "$$HOME/miniconda3"; fi;)
|
||||
CONDA_BIN := $(CONDA_ROOT)/bin/conda
|
||||
|
||||
ENV_PREFIX := $(CONDA_ROOT)/envs
|
||||
|
||||
DEV_ENV_NAME := \
|
||||
$(subst py,$(PKG_NAME)_py,$(subst .,,$(subst =,,$(subst thon,,$(DEVELOPMENT_PYTHON_VERSION)))))
|
||||
|
||||
CONDA_ENV_NAMES := \
|
||||
$(subst py,$(PKG_NAME)_py,$(subst .,,$(subst =,,$(subst thon,,$(SUPPORTED_PYTHON_VERSIONS)))))
|
||||
|
||||
CONDA_ENV_PATHS := \
|
||||
$(subst py,${ENV_PREFIX}/$(PKG_NAME)_py,$(subst .,,$(subst =,,$(subst thon,,$(SUPPORTED_PYTHON_VERSIONS)))))
|
||||
|
||||
|
||||
# default version for development
|
||||
DEV_ENV := $(ENV_PREFIX)/$(DEV_ENV_NAME)
|
||||
DEV_ENV_PY := $(DEV_ENV)/bin/python
|
||||
|
||||
|
||||
build/envs.txt: requirements/conda.txt
|
||||
@mkdir -p build/
|
||||
|
||||
@if [[ ! -f $(CONDA_BIN) ]]; then \
|
||||
if [[ $(PLATFORM) == "Linux" ]]; then \
|
||||
echo "installing miniconda ..."; \
|
||||
curl "https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh" \
|
||||
-O build/miniconda3.sh; \
|
||||
fi
|
||||
if [[ $(PLATFORM) == "MINGW64_NT-10.0" ]]; then \
|
||||
curl "https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh" \
|
||||
-O build/miniconda3.sh; \
|
||||
fi
|
||||
if [[ $(PLATFORM) == "Darwin" ]]; then \
|
||||
curl "https://repo.continuum.io/miniconda/Miniconda3-latest-MacOSX-x86_64.sh" \
|
||||
-O build/miniconda3.sh; \
|
||||
fi
|
||||
bash build/miniconda3.sh -b -p $(CONDA_ROOT); \
|
||||
rm build/miniconda3.sh; \
|
||||
fi
|
||||
|
||||
rm -f build/envs.txt.tmp;
|
||||
|
||||
@SUPPORTED_PYTHON_VERSIONS="$(SUPPORTED_PYTHON_VERSIONS)" \
|
||||
CONDA_ENV_NAMES="$(CONDA_ENV_NAMES)" \
|
||||
CONDA_ENV_PATHS="$(CONDA_ENV_PATHS)" \
|
||||
CONDA_BIN="$(CONDA_BIN)" \
|
||||
bash scripts/setup_conda_envs.sh;
|
||||
|
||||
$(CONDA_BIN) env list \
|
||||
| grep $(PKG_NAME) \
|
||||
| rev | cut -d " " -f1 \
|
||||
| rev | sort >> build/envs.txt.tmp;
|
||||
|
||||
mv build/envs.txt.tmp build/envs.txt;
|
||||
|
||||
|
||||
build/deps.txt: build/envs.txt requirements/*.txt
|
||||
@mkdir -p build/
|
||||
|
||||
@SUPPORTED_PYTHON_VERSIONS="$(SUPPORTED_PYTHON_VERSIONS)" \
|
||||
CONDA_ENV_NAMES="$(CONDA_ENV_NAMES)" \
|
||||
CONDA_ENV_PATHS="$(CONDA_ENV_PATHS)" \
|
||||
CONDA_BIN="$(CONDA_BIN)" \
|
||||
bash scripts/update_conda_env_deps.sh;
|
||||
|
||||
@echo "updating $(DEV_ENV_NAME) development deps ...";
|
||||
|
||||
@$(DEV_ENV_PY) -m pip install \
|
||||
--disable-pip-version-check --upgrade \
|
||||
--requirement=requirements/integration.txt;
|
||||
|
||||
@$(DEV_ENV_PY) -m pip install \
|
||||
--disable-pip-version-check --upgrade \
|
||||
--requirement=requirements/development.txt;
|
||||
|
||||
@echo "updating local vendor dep copies ...";
|
||||
|
||||
@$(DEV_ENV_PY) -m pip install \
|
||||
--upgrade --disable-pip-version-check \
|
||||
--no-deps --target=./vendor \
|
||||
--requirement=requirements/vendor.txt;
|
||||
|
||||
@rm -f build/deps.txt.tmp;
|
||||
|
||||
@for env_name in $(CONDA_ENV_NAMES); do \
|
||||
env_py="${ENV_PREFIX}/$${env_name}/bin/python"; \
|
||||
printf "\npip freeze for $${env_name}:\n" >> build/deps.txt.tmp; \
|
||||
$${env_py} -m pip freeze >> build/deps.txt.tmp; \
|
||||
printf "\n\n" >> build/deps.txt.tmp; \
|
||||
done
|
||||
|
||||
@mv build/deps.txt.tmp build/deps.txt
|
||||
|
||||
|
||||
# Add the following 'help' target to your Makefile
|
||||
# And add help text after each target name starting with '\#\#'
|
||||
# A category can be added with @category
|
||||
|
||||
## This help message
|
||||
.PHONY: help
|
||||
help:
|
||||
@printf "Available make targets for \033[97m$(PKG_NAME)\033[0m:\n";
|
||||
|
||||
@awk '{ \
|
||||
if ($$0 ~ /^.PHONY: [a-zA-Z\-\_0-9]+$$/) { \
|
||||
helpCommand = substr($$0, index($$0, ":") + 2); \
|
||||
if (helpMessage) { \
|
||||
printf "\033[36m%-20s\033[0m %s\n", \
|
||||
helpCommand, helpMessage; \
|
||||
helpMessage = ""; \
|
||||
} \
|
||||
} else if ($$0 ~ /^##/) { \
|
||||
if (helpMessage) { \
|
||||
helpMessage = helpMessage"\n "substr($$0, 3); \
|
||||
} else { \
|
||||
helpMessage = substr($$0, 3); \
|
||||
} \
|
||||
} else { \
|
||||
if (helpMessage) { \
|
||||
print "\n "helpMessage"\n" \
|
||||
} \
|
||||
helpMessage = ""; \
|
||||
} \
|
||||
}' \
|
||||
$(MAKEFILE_LIST)
|
||||
|
||||
@if [[ ! -f $(DEV_ENV_PY) ]]; then \
|
||||
echo "Missing python interpreter at $(DEV_ENV_PY) !"; \
|
||||
echo "You problably want to install first:"; \
|
||||
echo ""; \
|
||||
echo " make install"; \
|
||||
echo ""; \
|
||||
exit 0; \
|
||||
fi
|
||||
|
||||
@if [[ ! -f $(CONDA_BIN) ]]; then \
|
||||
echo "No conda installation found!"; \
|
||||
echo "You problably want to install first:"; \
|
||||
echo ""; \
|
||||
echo " make install"; \
|
||||
echo ""; \
|
||||
exit 0; \
|
||||
fi
|
||||
|
||||
|
||||
## -- Project Setup --
|
||||
|
||||
|
||||
## Delete conda envs and cache 💩
|
||||
.PHONY: clean
|
||||
clean:
|
||||
@for env_name in $(CONDA_ENV_NAMES); do \
|
||||
env_py="${ENV_PREFIX}/$${env_name}/bin/python"; \
|
||||
if [[ -f $${env_py} ]]; then \
|
||||
$(CONDA_BIN) env remove --name $${env_name} --yes; \
|
||||
fi; \
|
||||
done
|
||||
|
||||
rm -f build/envs.txt
|
||||
rm -f build/deps.txt
|
||||
rm -rf vendor/
|
||||
rm -rf .mypy_cache/
|
||||
rm -rf .pytest_cache/
|
||||
rm -rf __pycache__/
|
||||
rm -rf src/__pycache__/
|
||||
rm -rf vendor/__pycache__/
|
||||
@printf "\n setup/update completed ✨ 🍰 ✨ \n\n"
|
||||
|
||||
|
||||
## Force update of dependencies
|
||||
## (this removes makefile markers)
|
||||
.PHONY: force
|
||||
force:
|
||||
rm -f build/envs.txt
|
||||
rm -f build/deps.txt
|
||||
rm -rf vendor/
|
||||
rm -rf .mypy_cache/
|
||||
rm -rf .pytest_cache/
|
||||
rm -rf __pycache__/
|
||||
rm -rf src/__pycache__/
|
||||
rm -rf vendor/__pycache__/
|
||||
|
||||
|
||||
## Setup python virtual environments
|
||||
.PHONY: install
|
||||
install: build/deps.txt
|
||||
|
||||
|
||||
## Update dependencies (pip install -U ...)
|
||||
.PHONY: update
|
||||
update: build/deps.txt
|
||||
|
||||
|
||||
## Install git pre-push hooks
|
||||
.PHONY: git_hooks
|
||||
git_hooks:
|
||||
@rm -f "${PWD}/.git/hooks/pre-push"
|
||||
ln -s "${PWD}/scripts/pre-push-hook.sh" "${PWD}/.git/hooks/pre-push"
|
||||
|
||||
|
||||
|
||||
# TODO make target to publish on pypi
|
||||
# .PHONY: publish
|
||||
# publish:
|
||||
# echo "Not Implemented"
|
||||
|
||||
|
||||
## -- Development --
|
||||
|
||||
|
||||
## Run code formatter on src/ and test/
|
||||
.PHONY: fmt
|
||||
fmt:
|
||||
@$(DEV_ENV)/bin/sjfmt --py36 --skip-string-normalization --line-length=100 \
|
||||
src/ test/
|
||||
|
||||
|
||||
## Run flake8 linter
|
||||
.PHONY: lint
|
||||
lint:
|
||||
@printf "flake8 ..\n"
|
||||
@$(DEV_ENV)/bin/flake8 src/
|
||||
@printf "\e[1F\e[9C ok\n"
|
||||
|
||||
|
||||
## Run mypy type checker
|
||||
.PHONY: mypy
|
||||
mypy:
|
||||
@rm -rf ".mypy_cache";
|
||||
|
||||
@printf "mypy ....\n"
|
||||
@MYPYPATH=stubs/:vendor/ $(DEV_ENV_PY) -m mypy src/
|
||||
@printf "\e[1F\e[9C ok\n"
|
||||
|
||||
|
||||
## Run pylint. Should not break the build yet
|
||||
.PHONY: pylint
|
||||
pylint:
|
||||
@printf "pylint ..\n";
|
||||
@$(DEV_ENV)/bin/pylint --jobs=4 --output-format=colorized --score=no \
|
||||
--disable=C0103,C0301,C0330,C0326,C0330,C0411,R0903,W1619,W1618,W1203 \
|
||||
--extension-pkg-whitelist=ujson,lxml,PIL,numpy,pandas,sklearn,pyblake2 \
|
||||
src/
|
||||
@$(DEV_ENV)/bin/pylint --jobs=4 --output-format=colorized --score=no \
|
||||
--disable=C0103,C0111,C0301,C0330,C0326,C0330,C0411,R0903,W1619,W1618,W1203 \
|
||||
--extension-pkg-whitelist=ujson,lxml,PIL,numpy,pandas,sklearn,pyblake2 \
|
||||
test/
|
||||
|
||||
@printf "\e[1F\e[9C ok\n"
|
||||
|
||||
|
||||
## Run pytest unit and integration tests
|
||||
.PHONY: test
|
||||
test:
|
||||
@rm -rf ".pytest_cache";
|
||||
@rm -rf "src/__pycache__";
|
||||
@rm -rf "test/__pycache__";
|
||||
|
||||
ENV=dev PYTHONPATH=src/:vendor/:$$PYTHONPATH \
|
||||
$(DEV_ENV_PY) -m pytest -v \
|
||||
--doctest-modules \
|
||||
--cov-report html \
|
||||
--cov-report term \
|
||||
--cov=$(PKG_NAME) \
|
||||
test/ src/;
|
||||
|
||||
@rm -rf ".pytest_cache";
|
||||
@rm -rf "src/__pycache__";
|
||||
@rm -rf "test/__pycache__";
|
||||
|
||||
|
||||
## -- Helpers --
|
||||
|
||||
|
||||
## Shortcut for make fmt lint pylint test
|
||||
.PHONY: check
|
||||
check: fmt lint mypy test
|
||||
|
||||
|
||||
## Start shell with environ variables set.
|
||||
.PHONY: env
|
||||
env:
|
||||
@bash -c '\
|
||||
ENV=dev \
|
||||
PYTHONPATH=\"src/:vendor/:$$PYTHONPATH\" \
|
||||
PATH=\"$(DEV_ENV)/bin/:$$PATH\"; \
|
||||
$$SHELL '
|
||||
|
||||
|
||||
## Drop into an ipython shell with correct env variables set
|
||||
.PHONY: ipy
|
||||
ipy:
|
||||
@PYTHONPATH=src/:vendor/:$$PYTHONPATH \
|
||||
$(DEV_ENV)/bin/ipython
|
||||
|
||||
|
||||
## Like `make test`, but with debug parameters
|
||||
.PHONY: devtest
|
||||
devtest:
|
||||
@rm -rf ".pytest_cache";
|
||||
@rm -rf "src/__pycache__";
|
||||
@rm -rf "test/__pycache__";
|
||||
|
||||
|
||||
ifndef FILTER
|
||||
ENV=dev PYTHONPATH=src/:vendor/:$$PYTHONPATH \
|
||||
$(DEV_ENV_PY) -m pytest -v \
|
||||
--doctest-modules \
|
||||
--no-cov \
|
||||
--verbose \
|
||||
--capture=no \
|
||||
--exitfirst \
|
||||
test/ src/;
|
||||
else
|
||||
ENV=dev PYTHONPATH=src/:vendor/:$$PYTHONPATH \
|
||||
$(DEV_ENV_PY) -m pytest -v \
|
||||
--doctest-modules \
|
||||
--no-cov \
|
||||
--verbose \
|
||||
--capture=no \
|
||||
--exitfirst \
|
||||
-k $(FILTER) \
|
||||
test/ src/;
|
||||
endif
|
||||
|
||||
@rm -rf ".pytest_cache";
|
||||
@rm -rf "src/__pycache__";
|
||||
@rm -rf "test/__pycache__";
|
||||
|
||||
|
||||
## -- Build/Deploy --
|
||||
|
||||
|
||||
## Generate Documentation
|
||||
.PHONY: doc
|
||||
doc:
|
||||
echo "Not Implemented"
|
||||
|
||||
|
||||
## Bump Version number in all files
|
||||
.PHONY: bump_version
|
||||
bump_version:
|
||||
echo "Not Implemented"
|
||||
|
||||
|
||||
## Freeze dependencies of the current development env
|
||||
## These dependencies are used for the docker image
|
||||
.PHONY: freeze
|
||||
freeze:
|
||||
echo "Not Implemented"
|
||||
|
||||
|
||||
## Create python sdist and bdist_wheel distributions
|
||||
.PHONY: build_dist
|
||||
build_dist:
|
||||
$(DEV_ENV_PY) setup.py sdist bdist_wheel
|
||||
twine check dist/*
|
||||
echo "To a PUBLIC release on pypi run:\n\t\$(DEV_ENV_PY) setup.py upload"
|
||||
|
||||
|
||||
## Build docker images. Must be run when dependencies are added
|
||||
## or updated. The main reasons this can fail are:
|
||||
## 1. No ssh key at $(HOME)/.ssh/${PKG_NAME}_gitlab_runner_id_rsa
|
||||
## (which is needed to install packages from private repos
|
||||
## and is copied into a temp container during the build).
|
||||
## 2. Your docker daemon is not running or configured to
|
||||
## expose on tcp://localhost:2375
|
||||
.PHONY: build_docker
|
||||
build_docker:
|
||||
@if [[ -f $$HOME/.ssh/${PKG_NAME}_gitlab_runner_id_rsa ]]; then \
|
||||
docker build \
|
||||
--build-arg SSH_PRIVATE_RSA_KEY="$$(cat ${HOME}/.ssh/${PKG_NAME}_gitlab_runner_id_rsa)" \
|
||||
--file docker_base.Dockerfile \
|
||||
--tag $(DOCKER_REGISTRY_URL)/base:latest \
|
||||
.
|
||||
else
|
||||
docker build \
|
||||
--file docker_base.Dockerfile \
|
||||
--tag $(DOCKER_REGISTRY_URL)/base:latest \
|
||||
.
|
||||
fi
|
||||
|
||||
docker push $(DOCKER_REGISTRY_URL)/base:latest
|
||||
|
||||
|
||||
-include makefile.extra.make
|
||||
Loading…
Add table
Add a link
Reference in a new issue