reuse.report module¶

Module that contains reports about files and projects for linting.

class reuse.report.FileReport(name, path, do_checksum=True)[source]¶

Object that holds a linting report about a single file. Importantly, it also contains SPDX File information in spdxfile.

classmethod generate(project, path, do_checksum=True)[source]¶

Generate a FileReport from a path in a Project.

class reuse.report.ProjectReport(do_checksum=True)[source]¶

Object that holds linting report about the project.

bill_of_materials()[source]¶

Generate a bill of materials from the project.

property files_without_copyright¶

Iterable of paths that have no copyright information.

property files_without_licenses¶

Iterable of paths that have no license information.

classmethod generate(project, do_checksum=True, multiprocessing=True)[source]¶

Generate a ProjectReport from a Project.

property unused_licenses¶

Set of license identifiers that are not found in any file report.

property used_licenses¶

Set of license identifiers that are found in file reports.