1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
|
"""Test script to check given paths for valid README.rst files."""
import argparse
import sys
from pathlib import Path
import readme_renderer.rst
def is_valid_rst(path):
"""Checks if RST can be rendered on PyPI."""
with open(path, encoding="utf-8") as readme_file:
markup = readme_file.read()
return readme_renderer.rst.render(markup, stream=sys.stderr) is not None
def parse_args():
parser = argparse.ArgumentParser(
description="Checks README.rst file in path for syntax errors."
)
parser.add_argument(
"paths", nargs="+", help="paths containing a README.rst to test"
)
parser.add_argument("-v", "--verbose", action="store_true")
return parser.parse_args()
def main():
args = parse_args()
error = False
for path in map(Path, args.paths):
readme = path / "README.rst"
try:
if not is_valid_rst(readme):
error = True
print("FAILED: RST syntax errors in", readme)
continue
except FileNotFoundError:
error = True
print("FAILED: README.rst not found in", path)
continue
if args.verbose:
print("PASSED:", readme)
if error:
sys.exit(1)
print("All clear.")
if __name__ == "__main__":
main()
|
