reuse.report module
Module that contains reports about files and projects for linting.
- class reuse.report.FileReport(name, path, do_checksum=True)[source]
Bases:
object
Object that holds a linting report about a single file. Importantly, it also contains SPDX File information in
spdxfile
.
- class reuse.report.ProjectReport(do_checksum=True)[source]
Bases:
object
Object that holds linting report about the project.
- bill_of_materials()[source]
Generate a bill of materials from the project.
See https://spdx.org/specifications.
- Return type
- property files_without_copyright: Iterable[os.PathLike]
Iterable of paths that have no copyright information.
- property files_without_licenses: Iterable[os.PathLike]
Iterable of paths that have no license information.
- classmethod generate(project, do_checksum=True, multiprocessing=True)[source]
Generate a ProjectReport from a Project.
- Return type