-
Notifications
You must be signed in to change notification settings - Fork 4
/
Makefile
103 lines (84 loc) · 4.88 KB
/
Makefile
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
SHELL := /bin/bash
this_makefile := $(lastword $(MAKEFILE_LIST)) # Used to automatically list targets
.DEFAULT_GOAL := list # If someone runs "make", run "make list"
# Source files to format, lint, and type check.
LOCATIONS=src tests
# Unless overridden, build conda environment using the package name.
PACKAGE_NAME = vivarium
SAFE_NAME = $(shell python -c "from pkg_resources import safe_name; print(safe_name(\"$(PACKAGE_NAME)\"))")
setup_file = $(shell find -name setup.py)
version_line = $(shell grep "version = " ${setup_file})
PACKAGE_VERSION = $(shell echo ${version_line} | cut -d "=" -f 2 | xargs)
# Use this URL to pull IHME Python packages and deploy this package to PyPi.
IHME_PYPI := https://artifactory.ihme.washington.edu/artifactory/api/pypi/pypi-shared/
# If CONDA_ENV_PATH is set (from a Jenkins build), use the -p flag when making Conda env in
# order to make env at specific path. Otherwise, make a named env at the default path using
# the -n flag.
PYTHON_VERSION ?= 3.11
CONDA_ENV_NAME ?= ${PACKAGE_NAME}_py${PYTHON_VERSION}
CONDA_ENV_CREATION_FLAG = $(if $(CONDA_ENV_PATH),-p ${CONDA_ENV_PATH},-n ${CONDA_ENV_NAME})
# These are the doc and source code files in this repo.
# When one of these files changes, it means that Make targets need to run again.
MAKE_SOURCES := $(shell find . -type d -name "*" ! -path "./.git*" ! -path "./.vscode" ! -path "./output" ! -path "./output/*" ! -path "./archive" ! -path "./dist" ! -path "./output/htmlcov*" ! -path "**/.pytest_cache*" ! -path "**/__pycache__" ! -path "./output/docs_build*" ! -path "./.pytype*" ! -path "." ! -path "./src/${PACKAGE_NAME}/legacy*" ! -path ./.history ! -path "./.history/*" ! -path "./src/${PACKAGE_NAME}.egg-info" ! -path ./.idea ! -path "./.idea/*" )
# Phony targets don't produce artifacts.
.PHONY: .list-targets build-env clean debug deploy-doc deploy-package full help install list quick
# List of Make targets is generated dynamically. To add description of target, use a # on the target definition.
list help: debug .list-targets
.list-targets: # Print available Make targets
@echo
@echo "Make targets:"
@grep -i "^[a-zA-Z][a-zA-Z0-9_ \.\-]*: .*[#].*" ${this_makefile} | sort | sed 's/:.*#/ : /g' | column -t -s:
@echo
debug: # Print debug information (environment variables)
@echo "'make' invoked with these environment variables:"
@echo "CONDA_ENV_NAME: ${CONDA_ENV_NAME}"
@echo "IHME_PYPI: ${IHME_PYPI}"
@echo "LOCATIONS: ${LOCATIONS}"
@echo "PACKAGE_NAME: ${PACKAGE_NAME}"
@echo "PACKAGE_VERSION: ${PACKAGE_VERSION}"
@echo "PYPI_ARTIFACTORY_CREDENTIALS_USR: ${PYPI_ARTIFACTORY_CREDENTIALS_USR} "
@echo "Make sources: ${MAKE_SOURCES}"
build-env: # Make a new conda environment
@[ "${CONDA_ENV_NAME}" ] && echo "" > /dev/null || ( echo "CONDA_ENV_NAME is not set"; exit 1 )
conda create ${CONDA_ENV_CREATION_FLAG} python=${PYTHON_VERSION} --yes
install: # Install setuptools, install this package in editable mode
pip install --upgrade pip setuptools
pip install -e .[DEV]
@cd ..
@echo "----------------------------------------"
@if [ ! -d "vivarium_build_utils" ]; then \
# Clone the build utils repo if it doesn't exist. \
git clone https://github.com/ihmeuw/vivarium_build_utils.git; \
else \
echo "vivarium_build_utils already exists. Skipping clone."; \
fi
@echo "Contents of install_dependency_branch.sh"
@echo "----------------------------------------"
@cat vivarium_build_utils/install_dependency_branch.sh
@echo ""
@echo "----------------------------------------"
@sh vivarium_build_utils/install_dependency_branch.sh vivarium ${GIT_BRANCH} jenkins
@sh vivarium_build_utils/install_dependency_branch.sh layered_config_tree ${GIT_BRANCH} jenkins
format: setup.py pyproject.toml $(MAKE_SOURCES) # Run the code formatter and import sorter
black $(LOCATIONS)
isort $(LOCATIONS)
@echo "Ignore, Created by Makefile, `date`" > $@
lint: .flake8 .bandit $(MAKE_SOURCES) # Run the code linter and package security vulnerability checker
-flake8 $(LOCATIONS)
-safety check
@echo "Ignore, Created by Makefile, `date`" > $@
integration: $(MAKE_SOURCES) # Run the end-to-end tests
export COVERAGE_FILE=./output/.coverage.integration
pytest --runslow tests --cov --cov-report term --cov-report html:./output/htmlcov_integration
@echo "Ignore, Created by Makefile, `date`" > $@
build-doc: $(MAKE_SOURCES) # Build the Sphinx docs
$(MAKE) -C docs/ html
@echo "Ignore, Created by Makefile, `date`" > $@
build-package: $(MAKE_SOURCES) # Build the package as a pip wheel
pip install build
python -m build
@echo "Ignore, Created by Makefile, `date`" > $@
clean: # Delete build artifacts and do any custom cleanup such as spinning down services
@rm -rf format lint build-doc build-package integration .pytest_cache
@rm -rf dist output
$(shell find . -type f -name '*py[co]' -delete -o -type d -name __pycache__ -delete)