Skip to content

project-report projectreport.license package

projectreport.license package¶

Submodules¶

projectreport.license.finder module¶

projectreport.license.finder.find_license_file(folder)[source]¶

Find a license file in a folder.

Parameters:: folder¶ (Path) – The folder to search in.
Return type:: Optional[Path]
Returns:: The path to the license file, or None if no license file was found.

projectreport.license.model module¶

class projectreport.license.model.License(license_type, text)[source]¶

Bases: object

__init__(license_type, text)[source]¶

class projectreport.license.model.LicenseType(value)[source]¶

Bases: str, Enum

An enumeration.

AGPL = 'AGPL'¶

APACHE = 'APACHE'¶

BSD = 'BSD'¶

GPL = 'GPL'¶

LGPL = 'LGPL'¶

MIT = 'MIT'¶

MPL = 'MPL'¶

projectreport.license.parsing module¶

projectreport.license.parsing.license_text_to_license(license_text)[source]¶

Convert a license text to a License object.

Return type:: Optional[License]