twine.commands.check module#
Module containing the logic for twine check
.
- twine.commands.check._parse_content_type(value: str) Tuple[str, Dict[str, str]] [source]#
Implement logic of deprecated cgi.parse_header().
From https://docs.python.org/3.11/library/cgi.html#cgi.parse_header.
- twine.commands.check._check_file(filename: str, render_warning_stream: _WarningStream) Tuple[List[str], bool] [source]#
Check given distribution.
- twine.commands.check.check(dists: List[str], strict: bool = False) bool [source]#
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.- Parameters:
dists – The distribution files to check.
output_stream – The destination of the resulting output.
strict – If
True
, treat warnings as errors.
- Returns:
True
if there are rendering errors, otherwiseFalse
.