@@ -8,29 +8,34 @@ Bandit Settings
88Projects may include an INI file named `.bandit `, which specifies
99command line arguments that should be supplied for that project.
1010In addition or alternatively, you can use a YAML or TOML file, which
11- however needs to be explicitly specified using the `-c ` option.
11+ however needs to be explicitly specified using the `-c ` option, or the
12+ ``configfile `` argument in the INI file.
1213The currently supported arguments are:
1314
14- ``targets ``
15+ ``targets `` -- * INI only *
1516 comma separated list of target dirs/files to run bandit on
17+ ``recursive `` -- *INI only *
18+ boolean, to run bandit on subdirectories recursively
19+ ``configfile ``
20+ specify a YAML or TOML configuration file -- *INI only *
1621``exclude ``
17- comma separated list of excluded paths -- *INI only *
22+ comma separated list of excluded paths -- *INI only; use a leading slash from the project root *
1823``exclude_dirs ``
19- comma separated list of excluded paths (directories or files) -- *YAML and TOML only *
24+ comma separated list of excluded paths (directories or files) -- *YAML and TOML only; no leading slash required *
2025``skips ``
2126 comma separated list of tests to skip
2227``tests ``
2328 comma separated list of tests to run
2429
2530To use this, put an INI file named `.bandit ` in your project's directory.
26- Command line arguments must be in `[bandit] ` section.
31+ Command line arguments must be in a `[bandit] ` section.
2732For example:
2833
2934.. code-block :: ini
3035
3136 # FILE: .bandit
3237 [bandit]
33- exclude = tests,path/to/file
38+ exclude = / tests,/ path/to/file
3439 tests = B201,B301
3540 skips = B101,B601
3641
0 commit comments