bee-san / bee-san/pyWhat

No output until the searching is complete

Open
#189 5 comments 0 reactions 0 assignees View on GitHub
good first issue hacktoberfest help wanted
Dominant language
Python
Stars
7.3k
Forks
391
PR merge metrics
No merged PRs in 30d

Description

**Is your feature request related to a problem? Please describe.**
It feels a tad strange to run a pyWhat command and get no output at all until it's complete. With a really large file, pyWhat can understandably take a long time; it's hard to tell if it's crashed or just working silently.

**Describe the solution you'd like**
Ideally, progress bars would be awesome. But not too complex; counting each individual regex as a full "unit" would work fine. By this I mean, with 100 regexes to run on a file, one regex = 1%. This translates to multiple files too if a second progress bar was used - with 8 files, 1 file is worth 12.5%.

**Describe alternatives you've considered**
Maybe pyWhat could output each regex as it completes it along with an initial summary of what it's going to do.
For example:
```
Starting pyWhat...
Regexes: 150
Amazon AWS access key ✅
```

**Additional context**
Discussed on [Discord](http://discord.skerritt.blog) 😄

Contributor guide

Open the contributing guide

Research direction

The issue names no files or tests; start by locating the CLI search flow that processes regexes and input files. Compare progress bars with per-regex or per-file status output, and consider the requested initial summary. Done means long searches visibly report progress or completed checks instead of remaining silent.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli, security
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.