bandit icon indicating copy to clipboard operation
bandit copied to clipboard

Add Installation Guidelines in README.md

Open nakul-krishnakumar opened this issue 2 months ago • 4 comments

Describe the bug

I found it inconvenient to go to documentation every time I wanted to install bandit. Most of the open source projects do have their installation info mentioned in their README.md.

Reproduction steps

None.

Expected behavior

Well documented installation guidelines in the README.md.

Bandit version

1.8.3 (Default)

Python version

3.13 (Default)

Additional context

Additional context Similar open soource projects do have their installation guidelines in their README.md Image

Image

nakul-krishnakumar avatar Oct 27 '25 09:10 nakul-krishnakumar

If possible, I am ready to take up this issue. Thanks :)

nakul-krishnakumar avatar Oct 27 '25 19:10 nakul-krishnakumar

Why not just: % pipx run bandit --version

bandit 1.8.6
  python version = 3.14.0 (main, Oct  7 2025, 16:07:00) [Clang 20.1.4 ]

Or % uvx bandit --version

Installed 7 packages in 43ms
bandit 1.8.6
  python version = 3.14.0 (main, Oct  7 2025, 16:07:00) [Clang 20.1.4 ]

I did not mean to see bandit version, but rather update the README to include bandit local installation guidelines for newcomers. Even though it is mentioned in the bandit documentation website, newcomers might not notice it.

nakul-krishnakumar avatar Oct 30 '25 11:10 nakul-krishnakumar

--version was just an example. A multitude of uses are equally possible.

cclauss avatar Oct 30 '25 11:10 cclauss

--version was just an example. A multitude of uses are equally possible.

Oh I see, I never knew we could install packages using pipx or uvx, thank you for that. But there may be newcomers like me who do not know about that, so why not add something like:

Installation Guidelines

uvx bandit
pipx run bandit

nakul-krishnakumar avatar Oct 30 '25 19:10 nakul-krishnakumar