1. Installation - openphish/pyopdb GitHub Wiki

The OPDB API module works with Python 3.x and requires the following Python modules:

  • boto3
  • requests

To install the libraries manually using pip, run the following commands:

python3 -m pip install boto3

python3 -m pip install requests

To install the libraries using the requirements.txt file, run the following command:

python3 -m pip install -r requirements.txt

Configuration

Open the default configuration (opdb.ini) and update these values with your account details.

[license]
access_key    = <YOUR_ACCESS_KEY>
secret_key    = <YOUR_SECRET_KEY>
type          = <YOUR_SUBSCRIPTION_TYPE>

[settings]
local_db_path = <LOCAL_PATH_TO_STORE_DB>

The default configuration file must be located in the same directory as the Python module. If the configuration file is located in a different path, you must specify its path using the --config option when running from the command line or set the cfg_file argument when using the module programmatically.