generate_readme_md.py

#!/usr/bin/env python

import collections
import os.path as osp
import string

import tabulate
import yaml


def get_section(title, data, h=2):
    if not isinstance(data, list):
        content = "<h{0:d}>{1:s}</h{0:d}>\n\n".format(h, title.capitalize())
        for sub_title, sub_data in data.items():
            content += get_section(sub_title, sub_data, h=h + 1)
        return content

    headers = ["Numpy", "PyTorch"]
    keys = ["numpy", "pytorch"]
    rows = []
    for d in data:
        row = []
        for key in keys:
            if isinstance(d[key], dict):
                content = d[key]["content"]
                is_code = d[key].get("is_code", True)
            elif d[key] is None:
                content = ""
                is_code = False
            else:
                content = d[key]
                is_code = True
            if is_code and content:
                content = "<pre>\n{:s}</pre>".format(content)
            row.append(content)
        rows.append(row)

    contents = []
    contents.append("<h{0:d}>{1:s}</h{0:d}>".format(h, title.capitalize()))
    contents.append(
        tabulate.tabulate(rows, headers=headers, tablefmt="unsafehtml")
    )
    return "\n".join(contents)


def get_contents():
    # keep order in yaml file
    yaml.add_constructor(
        yaml.resolver.BaseResolver.DEFAULT_MAPPING_TAG,
        lambda loader, node: collections.OrderedDict(
            loader.construct_pairs(node)
        ),
    )

    yaml_file = osp.join(here, "conversions.yaml")
    with open(yaml_file) as f:
        data = yaml.safe_load(f)
    contents = []
    for title, data in data.items():
        section = get_section(title, data)
        contents.append(section)
    return "\n".join(contents)


here = osp.dirname(osp.abspath(__file__))


def main():
    with open(osp.join(here, "README.md.in")) as f:
        template = f.read()
    template = string.Template(template)
    readme = template.substitute(CONTENTS=get_contents())
    print(readme)


if __name__ == "__main__":
    main()