From ff7d69fa0aef2ab4b1b251088e9c70463cfcf10e Mon Sep 17 00:00:00 2001 From: Pim van Pelt Date: Wed, 7 May 2025 23:26:31 +0200 Subject: [PATCH] Document how to use venv to build --- .gitignore | 7 +------ Makefile | 2 +- README.md | 8 ++++++++ 3 files changed, 10 insertions(+), 7 deletions(-) diff --git a/.gitignore b/.gitignore index b56e5ec..19706f3 100644 --- a/.gitignore +++ b/.gitignore @@ -6,11 +6,6 @@ __pycache__ dist vppcfg.egg-info .pybuild -debian/vppcfg -debian/vppcfg.*.log -debian/vppcfg.*.debhelper -debian/.debhelper -debian/files -debian/vppcfg.substvars .*.~undo-tree~ .eggs +.venv/ diff --git a/Makefile b/Makefile index 6b95d59..f408001 100644 --- a/Makefile +++ b/Makefile @@ -16,7 +16,7 @@ build: .PHONY: install-deps install-deps: - sudo $(PIP) install $(PIP_DEPENDS) + $(PIP) install $(PIP_DEPENDS) .PHONY: install install: diff --git a/README.md b/README.md index 1286e42..8f01e27 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,11 @@ This program expects Python3 and PIP to be installed. It's known to work on Debi Bookworm, as well as on Ubuntu Focal, Jammy and Noble. ``` + +## Start a Virtual Environment +python3 -m venv .venv +source .venv/bin/activate + ## Install python build dependencies $ make install-deps @@ -23,6 +28,9 @@ $ make test ## Build vppcfg $ make build +## Exit the virtual environment +$ deactivate + ## Install the tool with PIP $ make install ```