API for python scripts Issue #713

issabayevmk commented 1 month ago

Please check if the PR fulfills these requirements
[x] Tests for the changes have been added
[x] Docs have been added / updated
[x] All CI checks are green
What kind of change does this PR introduce?

New API to import detect-secrets into other python scripts
What is the current behavior?

Currently detect-secrets does not provide easy options to import and scan strings/files/repos
What is the new behavior (if this is a feature change)? API for usage of detect-secrets from other python scripts. Supports:
- Get list of supported plugins
Scan a string with all plugins or specified plugins
Scan a file with all plugins or specified plugins
Scan a git repository with all plugins or specified plugins. There is an options to specify to scan only git tracked files or all files
Does this PR introduce a breaking change?
NO
Other information:
- New dependencies added to improve check, is folder a git repo or not
- Solves issue #713

lorenzodb1 commented 3 weeks ago

@issabayevmk I'll find some time to review this properly. In the meantime, could you please take a look at the tests?

issabayevmk commented 3 weeks ago

Hi @lorenzodb1. Thanks for your reply, I will review tests.

lorenzodb1 commented 3 weeks ago

Hi @issabayevmk, looks like you're missing some coverage now!

issabayevmk commented 2 weeks ago

@lorenzodb1 , I have improved coverage, now it is 98% for api.py.

lorenzodb1 commented 2 weeks ago

@issabayevmk it looks like pre-commit checks are still failing

issabayevmk commented 1 week ago

@lorenzodb1 windows tests now fixed and all tests are green on my fork

Yelp / detect-secrets