PyCQA / PyCQA/bandit

Add a nice Bandit banner

Open
#429 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
8.3k
Forks
835
Avg merge
5d 3h
Merged PRs (30d)
1

Description

Is your feature request related to a problem? Please describe.
When running Bandit in a build pipeline its runtime messages are boring and not distinctive:

[main]	INFO	profile include tests: None
[main]	INFO	profile exclude tests: None
[main]	INFO	cli include tests: None
[main]	INFO	cli exclude tests: B501,B322,B308,B703
[main]	INFO	running on Python 3.6.6
300 [0.. 50.. 100.. 150.. 200.. 250.. ]

Describe the solution you'd like
Display an exciting banner such as this one, generated with toilet -W -f bigascii12 Bandit:

                                            ##              
 ######:                             ##     ##              
 #######                             ##     ##       ##     
 ##   :##                            ##              ##     
 ##    ##   :####    ##.####    :###.##   ####     #######  
 ##   :##   ######   #######   :#######   ####     #######  
 #######.   #:  :##  ###  :##  ###  ###     ##       ##     
 #######.    :#####  ##    ##  ##.  .##     ##       ##     
 ##   :##  .#######  ##    ##  ##    ##     ##       ##     
 ##    ##  ## .  ##  ##    ##  ##.  .##     ##       ##     
 ##   :##  ##:  ###  ##    ##  ###  ###     ##       ##.    
 ########  ########  ##    ##  :#######  ########    #####  
 ######      ###.##  ##    ##   :###.##  ########    .####  
                                                            

Describe alternatives you've considered
I have considered submitting a patch myself but the current Bandit's command-line control flow is so elegant that I won't dare to mess with it.

Additional context
Other tools, such as safety are displaying really exciting and beautiful banners:

╒══════════════════════════════════════════════════════════════════════════════╕
│                                                                              │
│                               /$$$$$$            /$$                         │
│                              /$$__  $$          | $$                         │
│           /$$$$$$$  /$$$$$$ | $$  \__//$$$$$$  /$$$$$$   /$$   /$$           │
│          /$$_____/ |____  $$| $$$$   /$$__  $$|_  $$_/  | $$  | $$           │
│         |  $$$$$$   /$$$$$$$| $$_/  | $$$$$$$$  | $$    | $$  | $$           │
│          \____  $$ /$$__  $$| $$    | $$_____/  | $$ /$$| $$  | $$           │
│          /$$$$$$$/|  $$$$$$$| $$    |  $$$$$$$  |  $$$$/|  $$$$$$$           │
│         |_______/  \_______/|__/     \_______/   \___/   \____  $$           │
│                                                          /$$  | $$           │
│                                                         |  $$$$$$/           │
│  by pyup.io                                              \______/            │
│                                                                              │
╞══════════════════════════════════════════════════════════════════════════════╡
│ REPORT                                                                       │
│ checked 101 packages, using default DB                                       │
╞══════════════════════════════════════════════════════════════════════════════╡
│ No known security vulnerabilities found.                                     │
╘══════════════════════════════════════════════════════════════════════════════╛

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at Bandit's command-line control flow and the runtime message output shown in the issue. Check how the build-pipeline output is assembled, then add the requested Bandit banner without disrupting existing messages and verify the resulting CLI output.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.