From 2d262aefeefd457ec4fe85d5cdc12d22b046c4fa Mon Sep 17 00:00:00 2001 From: Bill Brower Date: Sun, 28 Oct 2018 09:09:15 -0400 Subject: [PATCH] 394 Describe baseline and it's usage in README --- README.rst | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.rst b/README.rst index ed15d923c..fea1842f8 100644 --- a/README.rst +++ b/README.rst @@ -248,6 +248,20 @@ Usage:: B702 use_of_mako_templates B703 django_mark_safe +Baseline +-------- +Bandit allows specifying the path of a baseline report to compare against using the base line argument (i.e. ``-b BASELINE`` or ``--baseline BASELINE``). + +:: + + bandit -b BASELINE + +This is useful for ignoring known vulnerabilities that you believe are non-issues (e.g. a cleartext password in a unit test). To generate a baseline report simply run Bandit with the output format set to ``json`` (only JSON-formatted files are accepted as a baseline) an output file path specified: + +:: + + bandit -f json -o PATH_TO_OUTPUT_FILE + Configuration -------------