Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update package level installation makefile #128

Merged
merged 7 commits into from
Aug 25, 2021
Merged

Update package level installation makefile #128

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
e4a554f
add descriptive constant vars to makefile that capture package and su…
Aug 24, 2021
b021a20
update makefile install rule
Aug 24, 2021
942e840
add uninstall and develop rules to makefile. develop installs subpack…
Aug 24, 2021
42e5345
add help rule to makefile. help is now default rule
Aug 24, 2021
6c8f8df
fix develop rule. pip does not allow editable mode with --use-feature…
Aug 24, 2021
87293fe
add --use-feature=in-tree-build to develop. requires pip > 21.1
aaraney Aug 25, 2021
4344e8d
add utility requirements section to Makefile help
aaraney Aug 25, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
41 changes: 34 additions & 7 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,32 @@
PYENV=env
PYTHON=$(PYENV)/bin/python3
NAMESPACE_DIR := ./python/

.PHONY: all-tests tests install clean
PACKAGE := hydrotools
SUBPACKAGES := _restclient[develop] nwis_client[develop] caches[develop] nwm_client[gcp,develop] events[develop] metrics[develop]

# discard `extras_require` qualifies from subpackage names (e.g. [develop])
SUBPACKAGES_WITHOUT_EXTRA_REQUIRE = $(shell echo $(SUBPACKAGES) | sed 's|\[[^][]*\]||g')

# relative path to subpackages (e.g. ./python/nwis_client)
SUBPACKAGES_PATHS := $(addprefix $(NAMESPACE_DIR), $(SUBPACKAGES))

.PHONY: help all-tests tests install uninstall develop clean

help:
@echo "HydroTools makefile commands:"
@echo " install : install all subpackages from local source code"
@echo " develop : install all subpackages in editable mode (pip -e) from local source code"
@echo " tests : run unit tests. exclude tests marked as slow"
@echo " all-tests : run all unit tests"
@echo " uninstall : uninstall all subpackages"
@echo " clean : delete python virtual environment"
@echo
@echo " utility requirements:"
@echo " pip > 21.1"
@echo " sed"

.DEFAULT_GOAL := help

tests: install
$(PYTHON) -m pytest -s -m "not slow"
Expand All @@ -10,12 +35,14 @@ all-tests: install
$(PYTHON) -m pytest -s

install: $(PYENV)/bin/activate
$(PYTHON) -m pip install --use-feature=in-tree-build ./python/_restclient[develop]
$(PYTHON) -m pip install --use-feature=in-tree-build ./python/nwis_client[develop]
$(PYTHON) -m pip install --use-feature=in-tree-build ./python/caches[develop]
$(PYTHON) -m pip install --use-feature=in-tree-build ./python/nwm_client[gcp,develop]
$(PYTHON) -m pip install --use-feature=in-tree-build ./python/events[develop]
$(PYTHON) -m pip install --use-feature=in-tree-build ./python/metrics[develop]
$(PYTHON) -m pip install --use-feature=in-tree-build $(SUBPACKAGES_PATHS)

uninstall: $(PYENV)/bin/activate
$(PYTHON) -m pip uninstall -y $(addprefix $(PACKAGE)., $(SUBPACKAGES_WITHOUT_EXTRA_REQUIRE))

develop: $(PYENV)/bin/activate
$(PYTHON) -m pip install --use-feature=in-tree-build --editable $(SUBPACKAGES_PATHS)


$(PYENV)/bin/activate:
test -d $(PYENV) || python3 -m venv $(PYENV)
Expand Down