Tools

The error-reporting-python library comes with a set of command-line tools to assist working with error definitions. The main entry point of these tools is the ec command.

How to get Help

$ ec --help

$ ec parse --help

$ ec generate --help

Example Usages

Parsing the error definitions in a python file(s)

ec parse some-python-file.py

ec parse < some-python-file.py

Generating an error-code data file

In order to generate a error-code-report compliant data file, you can use the subcommand generate:.

ec generate NAME VERSION PACKAGE_ROOT > error-codes.json