Module containing the logic for
- twine.commands.check._check_file(filename: str, render_warning_stream: twine.commands.check._WarningStream) Tuple[List[str], bool] ¶
Check given distribution.
- twine.commands.check.check(dists: List[str], output_stream: IO[str] = sys.stdout, strict: bool = False) bool ¶
Check that a distribution will render correctly on PyPI and display the results.
This is currently only validates
long_description, but more checks could be added; see https://github.com/pypa/twine/projects/2.
dists – The distribution files to check.
output_stream – The destination of the resulting output.
strict – If
True, treat warnings as errors.
Trueif there are rendering errors, otherwise