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
   6 from __future__ import unicode_literals
   7
   8 import io
   9 import sys
  10 import re
  11
  12 README_FILE = 'README.md'
  13 helptext = sys.stdin.read()
  14
  15 if isinstance(helptext, bytes):
  16     helptext = helptext.decode('utf-8')
  17
  18 with io.open(README_FILE, encoding='utf-8') as f:
  19     oldreadme = f.read()
  20
  21 header = oldreadme[:oldreadme.index('## General Options:')]
  22 footer = oldreadme[oldreadme.index('# CONFIGURATION'):]
  23
  24 options = helptext[helptext.index('  General Options:'):]
  25 options = re.sub(r'(?m)^  (\w.+)$', r'## \1', options)
  26 options = options + '\n'
  27
  28 with io.open(README_FILE, 'w', encoding='utf-8') as f:
  29     f.write(header)
  30     f.write(options)
  31     f.write(footer)