qud-mods/.readme_generator.py

#!/usr/bin/env python
from json import loads
from os import path, sep, scandir

OUT_FILE = "README.md"
TITLE = "Celediel's Cave's of Qud Mods"
STEAM_WORKSHOP = "https://steamcommunity.com/sharedfiles/filedetails/?id="


def main():
    manifest = "workshop.json"

    doc = f"# {TITLE}\n\n"

    for dir in scandir():
        found_manifest = dir.path + sep + manifest
        if path.exists(found_manifest):
            with open(found_manifest) as file:
                mod = loads(file.read())

            doc += f"## {mod['Title']}\n"
            doc += str(
                f'<img src="{dir.name}{sep}{mod["ImagePath"]}" '
                + 'alt="mod preview" '
                + 'width="48" height="48" /><br/>\n\n',
            )
            doc += f"{mod['Description']}\n\n"
            doc += "[Link to the Steam Workshop page]"
            doc += f"({STEAM_WORKSHOP}{mod['WorkshopId']})\n\n"

    with open(OUT_FILE, "w") as file:
        file.write(doc)


if __name__ == "__main__":
    main()