Provide pyhf debug utility that prints debugging information for user issues

[kratsg]

During this portion, I wonder if we should provide a pyhf debug or similar CLI so users can copy/paste that output entirely.

Originally posted by @kratsg in #1576 (comment)

[matthewfeickert]

@kratsg while I know this is quite old, are you able to elaborate more on what you envision the scope of this being? Can you give an example use case?

[matthewfeickert]

Ah looking at this more from the context of PR #1576, I think the idea was to give people a CLI to get all the information from the "OS / Environment" section of the bug report template:

OS / Environment

Provide information on your operating system. Something like the output of cat /etc/os-release on Linux or system_profiler -detailLevel mini SPSoftwareDataType on macOS.

# Linux
$ cat /etc/os-release
NAME="Ubuntu"
VERSION="20.04.2 LTS (Focal Fossa)"
ID=ubuntu
ID_LIKE=debian
PRETTY_NAME="Ubuntu 20.04.2 LTS"
VERSION_ID="20.04"
HOME_URL="https://www.ubuntu.com/"
SUPPORT_URL="https://help.ubuntu.com/"
BUG_REPORT_URL="https://bugs.launchpad.net/ubuntu/"
PRIVACY_POLICY_URL="https://www.ubuntu.com/legal/terms-and-policies/privacy-policy"
VERSION_CODENAME=focal
UBUNTU_CODENAME=focal

# macOS
$ system_profiler -detailLevel mini SPSoftwareDataType | head -n 6
Software:

    System Software Overview:

      System Version: macOS 10.15.7 (19H1323)
      Kernel Version: Darwin 19.6.0

So that using

$ pyhf debug

would produce something like the above without the user needing to know what commands to run (also producing consistent output).

Though maybe it might make more sense to have a

$ pyhf utils debug

CLI API.