Installation

Currently CredSweeper requires the following prerequisites:

• Python version 3.7, 3.8, 3.9

Note

We recommend to use credsweeper in a separate virtual enviroment. Some heave dependencies as Tensorflow might create a conflict with other dependencies othervise

Via pip

With ML validation feature (recommended)

pip install credsweeper[ml]

Note

Allows to use ML model classifier to validate credential candidates, but requires setup of additional packages: numpy, scikit-learn and tensorflow.

Without ML validation feature

pip install credsweeper

Via git clone (dev install)

git clone https://github.com/Samsung/CredSweeper.git
cd CredSweeper
# Annotate "numpy", "scikit-learn" and "tensorflow" if you don't want to use the ML validation feature.
pip install -qr requirements.txt