Quick Start¶

Installation¶

To install the tool, download the tool’s folder and execute the following commands (replace /path/to/analyzer/ with the path to the downloaded folder).

How to install the tool¶

cd /path/to/analyzer
python3 -m pip install .

Usage¶

The Command Line Interface¶

Once installed you can use this tool from your terminal using the command analyzer.

The tool’s CLI¶

analyzer [-h] [--version] [-v] file users

Note

You can execute the tool as a Python module, without installing it first. Download the tool’s folder and execute the following commands (replace /path/to/analyzer/ with the path to the downloaded folder).

How to execute the tool as a Python module¶

cd /path/to/analyzer
python3 -m analyzer --help

Process the JSON file

Positional Arguments¶

file: The file
users: A JSON file containing the users

Optional Arguments¶

-h, --help: show this help message and exit
--version: output version information and exit
-v, --verbose: increase output verbosity

The Code API¶

Once installed you can use the tool as a Python module. Read the code documentation for more information on the API.