bholagabbar / trufflehog-python-api

truffleHog Python API

Building a Python API over the truffleHog library.

Setup

• virtualenv -p python3 venv if you do not have a venv for the project.
• source venv/bin/activate activates the virtual env.
• pip install -r requirements.txt installs dependencies required for API, including truffleHog itself.

Tests

Runs all tests - python3 -m unittest discover -v

Documentation

• pdoc is installed when you run pip install -r requirements-dev.txt
• Generate docs with PYTHONPATH=. pdoc trufflehog_api --all-submodules --html --html-dir=docs/ --overwrite && 'cp' -rf docs/trufflehog_api/* docs/ && rm -rf docs/trufflehog_api

Docs are visible in the /docs/ folder.

Usage examples

Sample client code being applied to usecases can be found in the /examples folder

Requirements

API Iteration Versions

Issues list

Rationale