The ceda-cc file compliance checker: technical documentation

Usage (ccinit)

Calling options

Command line Description
ceda-cc -p <project> -D <directory> [..] check all data in directory tree under specified directory
ceda-cc -p <project> -d <directory> [..] check all data in specified directory
ceda-cc -p <project> -f <file> [..] check a single file
ceda-cc –sum <log file directory> [..] create an overview of results
ceda-cc –copy-config <target diectory> [..] copy configuration files to a new directory

c4

Entry point for command line usage – see ccinit for usage information.

c4.main_entry()[source]

Wrapper around main() for use with setuptools. This function will intercept arguments –sum, –unitTest, -v, otherwise pass the commandline to c4_run.main.

c4_run

config_c4

utils_c4

file_utils

xceptions

Some exceptions used in the code

exception xceptions.abortChecks[source]

Raised when checks are aborted following failure of a critical test (e.g. file name cannot be parsed).

exception xceptions.baseException(msg)[source]

Basic exception for general use in code.

exception xceptions.loggedException[source]

Raised after an exception has been caught and logged in a checking class, allowing execution to fall back to the loop over files.

Indices and tables