Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Clarify "getting started" docs #963

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Clarify "getting started" docs #963

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
11bd7fe
Clarify "getting started" docs
Flimm Oct 26, 2022
a086ee8
Merge branch 'main' into patch-1
lukehinds Nov 13, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions doc/source/start.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,18 @@ 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