blob: 6982af20b83c330970499c3bcb82e5f4ac3ecc0f [file] [log] [blame]
Joey Armstrong761579c2023-05-08 11:59:57 -04001# -*- makefile -*-
Joey Armstrong1ff23e92023-07-13 16:24:32 -04002# -----------------------------------------------------------------------
Joey Armstrong25589d82024-01-02 22:31:35 -05003# Copyright 2017-2024 Open Networking Foundation (ONF) and the ONF Contributors
Joey Armstrong761579c2023-05-08 11:59:57 -04004#
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.
Joey Armstrong1ff23e92023-07-13 16:24:32 -040016# -----------------------------------------------------------------------
Joey Armstrong761579c2023-05-08 11:59:57 -040017# 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)
33
34venv-activate-script := $(venv-name)/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 ]] && python -m pip install -r requirements.txt; }
55 $(activate) && python --version
56
57## -----------------------------------------------------------------------
58## Intent: Explicit named installer target w/o dependencies.
59## Makefile targets should depend on venv-activate-script.
60## -----------------------------------------------------------------------
61venv: $(venv-activate-script)
62
63## -----------------------------------------------------------------------
64## Intent: Revert installation to a clean checkout
65## -----------------------------------------------------------------------
66sterile :: clean
67 $(RM) -r "$(venv-abs-path)"
68
69## -----------------------------------------------------------------------
70## -----------------------------------------------------------------------
71help ::
72 @echo
73 @echo '[VIRTUAL ENV]'
74 @echo ' venv Create a python virtual environment'
75 @echo ' venv-name= Subdir name for virtualenv install'
76 @echo ' venv-activate-script make macro name'
77 @echo ' $$(target) dependency install python virtualenv'
78 @echo ' source $$(macro) && cmd configure env and run cmd'
79
80$(if $(DEBUG),$(warning LEAVE))
81
82# [EOF]