reuse.lint module

All linting happens here. The linting here is nothing more than reading the reports and printing some conclusions.

reuse.lint.add_arguments(parser)

Add arguments to parser.

Return type:

None

reuse.lint.format_json(report)

Formats data dictionary as JSON string ready to be printed to sys.stdout

Parameters:

report (ProjectReport) – Dictionary containing formatted ProjectReport data

Return type:

str

Returns:

String (representing JSON) that can be output to sys.stdout

reuse.lint.format_plain(report)

Formats data dictionary as plaintext string to be printed to sys.stdout

Parameters:

report (ProjectReport) – ProjectReport data

Return type:

str

Returns:

String (in plaintext) that can be output to sys.stdout

reuse.lint.run(args, project, out=<_io.TextIOWrapper name='<stdout>' mode='w' encoding='utf-8'>)

List all non-compliant files.

Return type:

int