Setup and use a virtual env for Python in makefiles

Signed-off-by: hemildesai <[email protected]>

Author: hemildesai

Makefile

@@ -1,9 +1,15 @@
 ENVIRONMENT := development
+ROOTDIR=./
+VENV=$(ROOTDIR)venv/bin/
+
+.PHONY: venv
+venv:
+	test -d venv || python -m venv $(ROOTDIR)venv
 
 OS := $(shell uname -s)
 
 .PHONY: build
-build: verify-dev-env
+build: verify-dev-env venv
 	cd go && $(MAKE) build-all ENVIRONMENT=$(ENVIRONMENT)
 	cd python && $(MAKE) build
 
@@ -18,14 +24,16 @@ else
 endif
 
 .PHONY: develop
-develop: verify-dev-env
+develop: verify-dev-env venv
 	cd go && $(MAKE) build
 	cd go && $(MAKE) install
-	cd python && python setup.py develop
+	cd python && $(MAKE) develop
+	@printf "\nPython venv created at $(ROOTDIR)venv. Run `tput bold`source $(ROOTDIR)venv/bin/activate`tput sgr0` to activate the venv in your shell.\n"
+	@printf "If you're using vscode, select this venv as the Python interpretor in the bottom left.\n"
 
 .PHONY: install-test-dependencies
-install-test-dependencies:
-	pip install -r requirements-test.txt
+install-test-dependencies: venv
+	$(VENV)pip install -r requirements-test.txt
 
 .PHONY: test
 test: install-test-dependencies develop

end-to-end-test/Makefile

@@ -1,7 +1,10 @@
+ROOTDIR=../
+VENV=$(ROOTDIR)venv/bin/
+
 .PHONY: test
 test:
-	pytest -m "not external"
+	$(VENV)pytest -m "not external"
 
 .PHONY: test-external
 test-external:
-	pytest
+	$(VENV)pytest

python/Makefile

@@ -1,25 +1,32 @@
+ROOTDIR=../
+VENV=$(ROOTDIR)venv/bin/
+
 .PHONY: pre-commit
 pre-commit: lint
 
 .PHONY: fmt
 fmt:
-	black .
+	$(VENV)black .
+
+.PHONY: develop
+develop:
+	$(VENV)python setup.py develop
 
 # --import-mode makes pytest import from globally installed package by default instead of local replicate/ module.
 # This assumes you've run `make develop` before running tests
 # https://docs.pytest.org/en/stable/pythonpath.html#pythonpath
 .PHONY: test
 test: lint
-	pytest --import-mode=importlib -m "not external"
+	$(VENV)pytest --import-mode=importlib -m "not external"
 
 .PHONY: test-external
 test-external: lint
-	pytest --import-mode=importlib
+	$(VENV)pytest --import-mode=importlib
 
 .PHONY: lint
 lint:
-	mypy .
-	black --check .
+	$(VENV)mypy .
+	$(VENV)black --check .
 
 .PHONY: clean
 clean:
@@ -42,15 +49,15 @@ clean:
 # https://docs.python.org/3/distutils/apiref.html#distutils.util.get_platform
 .PHONY: build
 build: clean
-	pip install wheel
-	python setup.py bdist_wheel --plat-name manylinux1_x86_64
-	python setup.py bdist_wheel --plat-name macosx_10_9_x86_64
+	$(VENV)pip install wheel
+	$(VENV)python setup.py bdist_wheel --plat-name manylinux1_x86_64
+	$(VENV)python setup.py bdist_wheel --plat-name macosx_10_9_x86_64
 
 .PHONY: targets
 targets:
 	@$(MAKE) -pRrq -f $(lastword $(MAKEFILE_LIST)) : 2>/dev/null | awk -v RS= -F: '/^# File/,/^# Finished Make data base/ {if ($$1 !~ "^[#.]") {print $$1}}' | sort | egrep -v -e '^[^[:alnum:]]' -e '^$@$$'
 
 .PHONY: vendor
 vendor:
-	pip install vendoring
-	vendoring sync -v .
+	$(VENV)pip install vendoring
+	$(VENV)vendoring sync -v .