Technical Phishing Test Reports (TPT Reports)

This package is used to generate and deliver CISA Technical Phishing Test (TPT) Reports. Reports are delivered locally and include an encrypted PDF attachment. The package collects raw data and creates an encrypted PDF.

Requirements

Python Environment

Installation

These are the one time set up commands.

git clone https://github.com/cisagov/tpt-reports.git
cd tpt-reports
./setup-env
pip install -e .

Retrieve periodic project updates with these commands.

git pull
pip install -e .

Running the Project

The output of the command tpt-reports -h provides usage details.

Usage:
  tpt-reports ELECTION_NAME DOMAIN_TESTED JSON_FILE_PATH [--log-level=LEVEL] [--output-dir=OUTPUT_DIRECTORY]

Options:
  -h --help                         Show this message.
  -l --log-level=LEVEL              If specified, then the log level will be set to
                                    the specified value.  Valid values are "debug", "info",
                                    "warning", "error", and "critical". [default: info]
  -o --output-dir=OUTPUT_DIRECTORY  The directory where the final PDF reports
                                    should be saved. [default: ~/]

Arguments:
  ELECTION_NAME                     The name of the election being reported on.
  DOMAIN_TESTED                     The email domain used in the testing.
  JSON_FILE_PATH                    Path to the JSON file to act as a data source.

Below is a sample command to create a report.

tpt-reports "ABC Organization" domain.gov /filepath/data.json --output-dir=reports

Contributing

We welcome contributions! Please see CONTRIBUTING.md for details.

License

This project is in the worldwide public domain.

This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication.

All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.

cisagov / tpt-reports

readme