Scripts

This is the API documentation for the scripts package. For instructions on how to use the scripts as an end user, visit the Usage documentation.

cli

Command line interface for DCC jp2 Converter.

dcc_jp2_converter.scripts.cli.get_args()

Parses the command line arguments.

Returns:Parsed command line arguments.

clean

dcc_jp2_converter.scripts.clean.cleanup_path(path: str)

Command for removing access tiffs that have a matching access jp2. :param path: Path to clean.

Note

The command, cleanup_path(), scans the path recursively.

convert

dcc_jp2_converter.scripts.convert.convert_path(path: str, **kwargs)

High level. Run conversion.

Parameters:path – Path to find items to search for directories and convert them

logging_settings

Any thing to do with logging

class dcc_jp2_converter.scripts.logging_settings.InfoFilter(name='')

Filter anything higher than Info level

validation

dcc_jp2_converter.scripts.validation.find_arg_errors(args)

Perform error check on command line arguments passed in in args to see if they are logically valid and return any errors if any are found.

dcc_jp2_converter.scripts.validation.find_settings_errors()

Looks for any configuration errors to make sure that the script can operate properly with the given settings by the default path lookup or any changes provided by a command_paths.ini file.

Returns:Returns a list of error messages if any. Returns an empty list if found no errors.