Hi @Z-Fran!

Nice to meet you the other day, and thank you so much for your contribution.

First step, please configure pre-commit for local development. I realized this been documented anywhere so apologies (opened #606 for this). Just do this with usethis tool pre-commit and it will install the pre-commit hooks in your git repo. This is the reason the GitHub Actions pipeline is failing at the moment.

Also, I'm going to want to add some tests for this code. If you don't want to add them, I'd be happy to add them myself - just let me know.

One naming change I've flagged above and then regarding your points:

1. At the moment, the --show flag will not prevent the badge from be added. However, my preference is that the --show parameter, when used, would prevent both badge removal and badge addition.

2. That's fine for now. In the long run, I'd like the --quiet flag to always take effect, even when the --show command is used, i.e. no output should be displayed. There are a few reasons for this, but basically it boils down to the fact that you really want to be able to trust the --quiet flag. Arguably it also makes the architecture simpler. What I'd say is don't worry about this, we'll resolve it via Never use simple print #610.

3. Same as point 1 - I would like to change this behaviour so that if the --show parameter is used, then the --remove option is completely ignored.

Thanks for taking the time to work on this issue.

Hi @Z-Fran!

Nice to meet you the other day, and thank you so much for your contribution.

First step, please configure pre-commit for local development. I realized this been documented anywhere so apologies (opened #606 for this). Just do this with usethis tool pre-commit and it will install the pre-commit hooks in your git repo. This is the reason the GitHub Actions pipeline is failing at the moment.

Also, I'm going to want to add some tests for this code. If you don't want to add them, I'd be happy to add them myself - just let me know.

One naming change I've flagged above and then regarding your points:

1. At the moment, the --show flag will not prevent the badge from be added. However, my preference is that the --show parameter, when used, would prevent both badge removal and badge addition.
2. That's fine for now. In the long run, I'd like the --quiet flag to always take effect, even when the --show command is used, i.e. no output should be displayed. There are a few reasons for this, but basically it boils down to the fact that you really want to be able to trust the --quiet flag. Arguably it also makes the architecture simpler. What I'd say is don't worry about this, we'll resolve it via Never use simple print #610.
3. Same as point 1 - I would like to change this behaviour so that if the --show parameter is used, then the --remove option is completely ignored.

Thanks for taking the time to work on this issue.

Hi @nathanjmcdougall , I have made some changes:

1. rename _modify_badge to _badge_effect

2. ignore --remove and don't add badges when setting --show

3. add some simple tests
   I want to use assert result.output == get_pypi_badge().markdown to test, but an error occurred when I tried to import get_pypi_badge().
   If you have a better test, please modify it!

4. code has passed pre-commit hooks.

5. I don't resolve the --quiet flag.

CodSpeed Performance Report

Merging #605 will not alter performance

_{Comparing Z-Fran:424-add-show-for-badge (c311175) with main (6a77f3f)}

Summary

✅ 1 untouched benchmarks

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.54%. Comparing base (fd41170) to head (c311175).
Report is 5 commits behind head on main.

@@           Coverage Diff           @@
##             main     #605   +/-   ##
=======================================
  Coverage   97.54%   97.54%           
=======================================
  Files         102      102           
  Lines        4439     4444    +5     
=======================================
+ Hits         4330     4335    +5     
  Misses        109      109           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Thanks @Z-Fran !

@Z-Fran I've just released this new feature in v0.11.0. Thank you again.