devscripts/make_readme.py

   1 #!/usr/bin/env python3
   2
   3 # yt-dlp --help | make_readme.py
   4 # This must be run in a console of correct width
   5 import re
   6 import sys
   7
   8 README_FILE = 'README.md'
   9 helptext = sys.stdin.read()
  10
  11 if isinstance(helptext, bytes):
  12     helptext = helptext.decode('utf-8')
  13
  14 with open(README_FILE, encoding='utf-8') as f:
  15     oldreadme = f.read()
  16
  17 header = oldreadme[:oldreadme.index('## General Options:')]
  18 footer = oldreadme[oldreadme.index('# CONFIGURATION'):]
  19
  20 options = helptext[helptext.index('  General Options:'):]
  21 options = re.sub(r'(?m)^  (\w.+)$', r'## \1', options)
  22 options = options + '\n'
  23
  24 with open(README_FILE, 'w', encoding='utf-8') as f:
  25     f.write(header)
  26     f.write(options)
  27     f.write(footer)