Skip to content

Commit

Permalink
Clarify "getting started" docs (#963)
Browse files Browse the repository at this point in the history
* 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 <[email protected]>
Co-authored-by: Eric Brown <[email protected]>
  • Loading branch information
3 people authored Jan 12, 2025
1 parent e4da0b3 commit e58379c
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions doc/source/start.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit e58379c

Please sign in to comment.