blob: d4b11c6f26eb91478199304dcf1a2690c206c135 [file] [log] [blame]
Joey Armstrong7f8436c2023-07-09 20:23:27 -04001# -*- makefile -*-
2## -----------------------------------------------------------------------
3# Copyright 2017-2023 Open Networking Foundation (ONF) and the ONF Contributors
4#
5# Licensed under the Apache License, Version 2.0 (the "License");
6# you may not use this file except in compliance with the License.
7# You may obtain a copy of the License at
8#
9# http://www.apache.org/licenses/LICENSE-2.0
10#
11# Unless required by applicable law or agreed to in writing, software
12# distributed under the License is distributed on an "AS IS" BASIS,
13# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14# See the License for the specific language governing permissions and
15# limitations under the License.
16# -----------------------------------------------------------------------
17# https://gerrit.opencord.org/plugins/gitiles/onf-make
18# ONF.makefile.version = 1.0
19# -----------------------------------------------------------------------
20
21$(if $(DEBUG),$(warning ENTER))
22
23##-------------------##
24##---] GLOBALS [---##
25##-------------------##
26.PHONY: venv
27
28##------------------##
29##---] LOCALS [---##
30##------------------##
31venv-name ?= .venv# # default install directory
32venv-abs-path := $(PWD)/$(venv-name)
33venv-activate-bin := $(venv-name)/bin
34venv-activate-script := $(venv-activate-bin)/activate# # dependency
35
36# Intent: activate= is a macro for accessing the virtualenv activation script#
37# Usage: $(activate) && python
38activate ?= set +u && source $(venv-activate-script) && set -u
39
40## -----------------------------------------------------------------------
41## Intent: Activate script path dependency
42## Usage:
43## o place on the right side of colon as a target dependency
44## o When the script does not exist install the virtual env and display.
45## -----------------------------------------------------------------------
46$(venv-activate-script):
47 @echo
48 @echo "============================="
49 @echo "Installing python virtual env"
50 @echo "============================="
51 virtualenv -p python3 $(venv-name)
52 $(activate) && python -m pip install --upgrade pip
53 $(activate) && pip install --upgrade setuptools
54 $(activate) && [[ -r requirements.txt ]] \
55 && { python -m pip install -r requirements.txt; } \
56 || { /bin/true; }
57 $(activate) && python --version
58
59## -----------------------------------------------------------------------
60## Intent: Explicit named installer target w/o dependencies.
61## Makefile targets should depend on venv-activate-script.
62## -----------------------------------------------------------------------
63venv: $(venv-activate-script)
64
65## -----------------------------------------------------------------------
66## Intent: Revert installation to a clean checkout
67## -----------------------------------------------------------------------
68sterile :: clean
69 $(RM) -r "$(venv-abs-path)"
70
71## -----------------------------------------------------------------------
72## -----------------------------------------------------------------------
73help ::
74 @echo
75 @echo '[VIRTUAL ENV]'
76 @echo ' venv Create a python virtual environment'
77 @echo ' venv-name= Subdir name for virtualenv install'
78 @echo ' venv-activate-script make macro name'
79 @echo ' $$(target) dependency install python virtualenv'
80 @echo ' source $$(macro) && cmd configure env and run cmd'
81
82$(if $(DEBUG),$(warning LEAVE))
83
84# [EOF]