blob: 628f166388b462e0c99887759bc9f9616e6eba8c [file] [log] [blame]
Joey Armstrong28eddda2023-01-10 03:09:34 -05001# -*- makefile -*-
2## -----------------------------------------------------------------------
Joey Armstrongbeef4cd2023-01-18 09:59:58 -05003# Copyright 2017-2023 Open Networking Foundation
Joey Armstrong28eddda2023-01-10 03:09:34 -05004#
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
Joey Armstrong3f575f72023-01-15 23:49:19 -050018$(if $(DEBUG),$(warning ENTER))
Joey Armstrong28eddda2023-01-10 03:09:34 -050019
Joey Armstrong8384f8b2023-02-06 12:46:08 -050020##-------------------##
21##---] GLOBALS [---##
22##-------------------##
23.PHONY: venv
24
25##------------------##
26##---] LOCALS [---##
27##------------------##
Joey Armstrong3f575f72023-01-15 23:49:19 -050028venv-name ?= .venv
29venv-abs-path := $(PWD)/$(venv-name)
30
31venv-activate-script := $(venv-name)/bin/activate# # dependency
32activate ?= source $(venv-activate-script)# # cmd invocation
33
34## -----------------------------------------------------------------------
35## Intent: Activate script path dependency
36## Usage:
37## o place on the right side of colon as a target dependency
38## o When the script does not exist install the virtual env and display.
39## -----------------------------------------------------------------------
40$(venv-activate-script):
41 virtualenv -p python3 $(venv-name)\
42 && source $(venv-name)/bin/activate\
43 && python -m pip install --upgrade pip\
44 && pip install --upgrade setuptools\
45 && { [[ -r requirements.txt ]] && python -m pip install -r requirements.txt; }\
46 && python --version
47
48## -----------------------------------------------------------------------
49## Intent: Explicit named installer target w/o dependencies.
50## Makefile targets should depend on venv-activate-script.
51## -----------------------------------------------------------------------
52venv: $(venv-activate-script)
53
54## -----------------------------------------------------------------------
55## Intent: Revert installation to a clean checkout
56## -----------------------------------------------------------------------
57sterile :: clean
58 $(RM) -r "$(venv-abs-path)"
59
60## -----------------------------------------------------------------------
61## -----------------------------------------------------------------------
62help ::
63 @echo
64 @echo '[VIRTUAL ENV]'
Joey Armstrong068d6452023-02-01 11:09:18 -050065 @echo ' venv Create a python virtual environment'
66 @echo ' venv-name= Subdir name for virtualenv install'
Joey Armstronga516c322023-01-25 17:40:42 -050067 @echo ' venv-activate-script make macro name'
68 @echo ' $$(target) dependency install python virtualenv'
69 @echo ' source $$(macro) && cmd configure env and run cmd'
Joey Armstrong3f575f72023-01-15 23:49:19 -050070
71$(if $(DEBUG),$(warning LEAVE))
Joey Armstrong28eddda2023-01-10 03:09:34 -050072
73# [EOF]