Skip to content

Commit 3400524

Browse files
committed
Add a doc describing various integrations
New doc to advise users of Bandit of the various integrations available to them. The list is probably missing some, but can be updated with time. It currently only includes subsections for IDEs, CI/CDs, Linters, and Packages. But that can also be expanded with time. Signed-off-by: Eric Brown <eric_wade_brown@yahoo.com>
1 parent 1ab0788 commit 3400524

File tree

2 files changed

+62
-0
lines changed

2 files changed

+62
-0
lines changed

doc/source/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ Using and Extending Bandit
1313

1414
start
1515
config
16+
integrations
1617
plugins/index
1718
blacklists/index
1819
formatters/index

doc/source/integrations.rst

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
Integrations
2+
============
3+
4+
Bandit can be integrated into a wide variety of developer tools, editors,
5+
CI/CD systems, and code quality pipelines. This page outlines popular
6+
integrations to help you seamlessly incorporate Bandit into your development
7+
workflow.
8+
9+
IDE Integrations
10+
----------------
11+
12+
.. list-table::
13+
:widths: 30 70
14+
15+
* - Visual Studio Code
16+
- `Bandit by PyCQA <https://marketplace.visualstudio.com/items?itemName=pycqa.bandit-pycqa>`_
17+
* - Sublime Text
18+
- `SublimeLinter-bandit <https://github.com/SublimeLinter/SublimeLinter-bandit>`_
19+
* - Vim/Neovim
20+
- `Asynchronous Lint Engine <https://github.com/dense-analysis/ale>`_
21+
* - Emacs
22+
- `flycheck-pycheckers <https://github.com/msherry/flycheck-pycheckers>`_
23+
24+
CI/CD Integrations
25+
------------------
26+
27+
.. list-table::
28+
:widths: 30 70
29+
30+
* - GitHub Action
31+
- `Bandit by PyCQA <https://github.com/marketplace/actions/bandit-by-pycqa>`_
32+
* - Hudson/Jenkins
33+
- `Bandit Plugin <https://github.com/mewz/bandit-plugin->`_
34+
35+
Linters
36+
-------
37+
38+
.. list-table::
39+
:widths: 30 70
40+
41+
* - Ruff
42+
- `flake8-bandit (S) <https://docs.astral.sh/ruff/rules/#flake8-bandit-s>`_
43+
* - Flake8
44+
- `flake8-bandit <https://github.com/tylerwince/flake8-bandit>`_
45+
46+
Packages
47+
--------
48+
49+
.. list-table::
50+
:widths: 30 70
51+
52+
* - Ubuntu
53+
- `bandit <https://packages.ubuntu.com/search?keywords=bandit&searchon=names&section=all>`_
54+
* - Homebrew
55+
- `bandit <https://formulae.brew.sh/formula/bandit>`_
56+
57+
58+
🙌 Contributions Welcome
59+
60+
If you’ve integrated Bandit into another platform or tool, feel free to open
61+
a PR and update this page!

0 commit comments

Comments
 (0)