Automatically check the licenses of package dependencies.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
licheck/docs/api.rst

1.5 KiB

Developer Interface

licheck

Main Interface

Examples for the most relevant api functions can be viewed in the test file. licheck's API uses type hints instead of assertions to check input and output types.

build_command

check_cache_structure

check_configuration_structure

check_data_object_structure

check_dependencies_files_data_structure

check_licenses

create_cache_output

create_data_object

create_dependencies_files_data_structure

get_binary_and_program

get_data

is_sha512_checksum

pipeline

prepare_print

print_errors

read_cache_file

read_configuration_file

read_remote_files

read_yaml_file

save_cache

transform_cache_to_data_object

write_cache

Exceptions

BinaryDoesNotExist

IncoherentData

IncoherentProgrammingLanguageValue

InvalidCache

InvalidCommonDataStructure

InvalidConfiguration

InvalidOutput

NotAChecksum