[docs] Improve manpage format (#2003)

[yt-dlp.git] / devscripts / make_supportedsites.py

#!/usr/bin/env python3
from __future__ import unicode_literals

import io
import optparse
import os
import sys


# Import yt_dlp
ROOT_DIR = os.path.join(os.path.dirname(__file__), '..')
sys.path.insert(0, ROOT_DIR)
import yt_dlp


def main():
    parser = optparse.OptionParser(usage='%prog OUTFILE.md')
    options, args = parser.parse_args()
    if len(args) != 1:
        parser.error('Expected an output filename')

    outfile, = args

    def gen_ies_md(ies):
        for ie in ies:
            ie_md = '**{0}**'.format(ie.IE_NAME)
            ie_desc = getattr(ie, 'IE_DESC', None)
            if ie_desc is False:
                continue
            if ie_desc is not None:
                ie_md += ': {0}'.format(ie.IE_DESC)
            search_key = getattr(ie, 'SEARCH_KEY', None)
            if search_key is not None:
                ie_md += f'; "{ie.SEARCH_KEY}:" prefix'
            if not ie.working():
                ie_md += ' (Currently broken)'
            yield ie_md

    ies = sorted(yt_dlp.gen_extractors(), key=lambda i: i.IE_NAME.lower())
    out = '# Supported sites\n' + ''.join(
        ' - ' + md + '\n'
        for md in gen_ies_md(ies))

    with io.open(outfile, 'w', encoding='utf-8') as outf:
        outf.write(out)


if __name__ == '__main__':
    main()