Licensecheck Index / Licensecheck / Fmt
Auto-generated documentation for licensecheck.fmt module.
Output a license as plain text.
licenseEnumLicense - License
Type: str license of plain text
def _printLicense(licenseEnum: License) -> str: ...Format to ansi.
myLiceLicense - project license :param list[dict[str, Any]] packages: list of PackageCompats to format.
Type: str string to send to specified output in ansi format
def ansi(myLice: License, packages: list[dict[str, Any]]) -> str: ...Format to a given format by format_.
myLiceLicense - project license :param list[PackageInfo] packages: list of PackageCompats to format. :param list[ucstr] hide_parameters: list of parameters to ignore in the output.show_only_failingbool - output only failing packages, defaults to False.
Type: str string to send to specified output in ansi format
def fmt(
format_: str,
myLice: License,
packages: list[PackageInfo],
hide_parameters: list[ucstr] | None = None,
show_only_failing: bool = False,
) -> str: ...Format to html.
myLiceLicense - project license :param list[dict[str, Any]] packages: list of PackageCompats to format.
Type: str string to send to specified output in html format
def html(myLice: License, packages: list[dict[str, Any]]) -> str: ...Format to markdown.
myLiceLicense - project license :param list[dict[str, Any]] packages: list of PackageCompats to format.
Type: str string to send to specified output in markdown format
def markdown(myLice: License, packages: list[dict[str, Any]]) -> str: ...Format to plain text.
myLiceLicense - project license :param list[dict[str, Any]] packages: list of PackageCompats to format.
Type: str string to send to specified output in plain text format
def plainText(myLice: License, packages: list[dict[str, Any]]) -> str: ...Format to json.
myLiceLicense - project license :param list[dict[str, Any]] packages: list of PackageCompats to format.
Type: str string to send to specified output in json format
def raw(myLice: License, packages: list[dict[str, Any]]) -> str: ...Format to csv.
myLiceLicense - project license :param list[dict[str, Any]] packages: list of PackageCompats to format.
Type: str string to send to specified output in csv format
def rawCsv(myLice: License, packages: list[dict[str, Any]]) -> str: ...Strip ansi codes from a given string.
stringstr - string to strip codes from
str- plaintext, utf-8 string (safe for writing to files)
def stripAnsi(string: str) -> str: ...