From e58379c5089305c845bae6e816e5faa5680b8097 Mon Sep 17 00:00:00 2001 From: David D Lowe Date: Sun, 12 Jan 2025 04:21:45 +0100 Subject: [PATCH] Clarify "getting started" docs (#963) * Clarify "getting started" docs This makes it clearer that you don't need to use both virtualenv and venv at the same time * Update doc/source/start.rst --------- Co-authored-by: Luke Hinds <7058938+lukehinds@users.noreply.github.com> Co-authored-by: Eric Brown --- doc/source/start.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/source/start.rst b/doc/source/start.rst index cd8f3dad..928e45a6 100644 --- a/doc/source/start.rst +++ b/doc/source/start.rst @@ -6,17 +6,17 @@ Installation Bandit is distributed on PyPI. The best way to install it is with pip. -Create a virtual environment (optional): +Create a virtual environment and activate it using `virtualenv` (optional): .. code-block:: console virtualenv bandit-env - python3 -m venv bandit-env - -And activate it: + source bandit-env/bin/activate +Alternatively, use `venv` instead of `virtualenv` (optional): .. code-block:: console + python3 -m venv bandit-env source bandit-env/bin/activate Install Bandit: