1
0
mirror of https://github.com/yt-dlp/yt-dlp.git synced 2024-12-17 10:59:54 +01:00
yt-dlp/devscripts/make_readme.py

31 lines
815 B
Python
Raw Normal View History

#!/usr/bin/env python3
# yt-dlp --help | make_readme.py
# This must be run in a console of correct width
import re
import sys
2012-12-07 21:40:06 +01:00
README_FILE = 'README.md'
OPTIONS_START = 'General Options:'
OPTIONS_END = 'CONFIGURATION'
EPILOG_START = 'See full documentation'
helptext = sys.stdin.read()
2014-01-05 04:44:29 +01:00
if isinstance(helptext, bytes):
helptext = helptext.decode()
2014-01-05 04:44:29 +01:00
start, end = helptext.index(f'\n {OPTIONS_START}'), helptext.index(f'\n{EPILOG_START}')
options = re.sub(r'(?m)^ (\w.+)$', r'## \1', helptext[start + 1: end + 1])
with open(README_FILE, encoding='utf-8') as f:
readme = f.read()
header = readme[:readme.index(f'## {OPTIONS_START}')]
footer = readme[readme.index(f'# {OPTIONS_END}'):]
with open(README_FILE, 'w', encoding='utf-8') as f:
for part in (header, options, footer):
f.write(part)