Reducto Command Line Interface

The code is expected to be executed from the terminal, using the reducto command. Only the target argument is mandatory (otherwise it will try to execute on the current working directory, and raise an error if it’s not a python package or source code file).

Arguments and Options

reducto <TARGET>

Target path to execute the program. Must be either a python package (a directory containing an __init__.py file) or a python source file <SRC.py>. If a directory is not a python package or a file is not a python source file, a reducto.package.PackageError or reducto.src.SourceFileError would be raised respectively.

-v, --version

Prints the version of the current program installed.

-f, --format <format>

Format for the reports. If tabulate is installed, the formats include json and those allowed for tabulate, i.e. github, rst, simple, grid…

--grouped, --ungrouped

Whether to report the data for the whole package (–grouped) or splitted by source file (–ungrouped). Defaults to –grouped. These are mutually exclusive arguments, only one can be chosen.

An example for the –ungrouped option is as follows:

{
 "reducto": {
     "reducto/__init__.py": {
         "lines": 5,
         "number_of_functions": 0,
         "average_function_length": 0,
         "docstring_lines": 1,
         "comment_lines": 0,
         "blank_lines": 2,
         "source_lines": 2
     },
     "reducto/reducto.py": {
         "lines": 209,
         ...
     },
     ...
}

-p, --percentage

Report the number of lines as percentage (keep in mind if the results are written to a json file, when reporting as percentage, the numbers are parsed as strings to be properly printed).

-o, --output <OUTPUT_FILE>

Full path for the report to be written. Defaults to the current working directory, and the file would be named reducto_report.json

-h, --help

Show help on the command-line interface.