reorganization

games/maintenance.py

@@ -0,0 +1,163 @@
+"""
+    Counts the number of records each subfolder and updates the overview. Sorts the entries in the contents files of
+    each subfolder alphabetically.
+
+    TODO check for external dead links (if desired, only now and then)
+    TODO remove "?source=navbar" from the end of links (sourceforge specific)
+    TODO check for "_{One line description}_" or "- Wikipedia: {URL}" in game files and print warning
+    TODO print all games without license or code information
+    TODO for those games with github repositories get activity, number of open issues, number of merge requests and display in a health monitor file
+    TODO get number of games with github or bitbucket repository and list those who have neither
+    TODO in readme put contents to the top, put all games folder into another folder and this script as well as the template too
+    TODO change Wikipedia to Media
+    TODO single player to SP, multi player to MP for keywords
+    TODO list those with exotic licenses (not GPL, zlib, MIT, BSD)
+    TODO Which C, C++ projects do not use CMake
+    TODO list those inactive (sort by year backwards)
+"""
+
+import os
+import re
+
+def read_first_line_from_file(file):
+    with open(file, 'r') as f:
+        line = f.readline()
+    return line
+
+def read_interesting_info_from_file(file):
+    """
+    Parses a file for some interesting fields and concatenates the content
+    """
+    with open(file, 'r') as f:
+        text = f.read()
+
+    output = [None, None, None]
+
+    # language
+    regex = re.compile(r"- Language\(s\): (.*)")
+    matches = regex.findall(text)
+    if matches:
+        output[0] = matches[0]
+
+    # license
+    regex = re.compile(r"- License: (.*)")
+    matches = regex.findall(text)
+    if matches:
+        output[1] = matches[0]
+
+    # state
+    regex = re.compile(r"- State: (.*)")
+    matches = regex.findall(text)
+    if matches:
+        output[2] = matches[0]
+
+    output = [x for x in output if x] # eliminate empty entries
+
+    output = ", ".join(output)
+
+    return output
+
+
+def update_readme():
+    """
+    Recounts entries in subcategories and writes them to the readme
+    """
+    print('update readme file')
+
+    # read readme
+    with open(readme_path) as f:
+        readme_text = f.read()
+
+    # compile regex for identifying the building blocks
+    regex = re.compile(r"(# Open Source Games\n\n)(.*)(\nA collection.*)", re.DOTALL)
+
+    # apply regex
+    matches = regex.findall(readme_text)
+    matches = matches[0]
+    start = matches[0]
+    end = matches[2]
+
+    # get sub folders
+    subfolders = [x for x in os.listdir(games_path) if x != '.git' and os.path.isdir(os.path.join(games_path, x))]
+
+    # get number of files (minus 1) in each sub folder
+    n = [len(os.listdir(os.path.join(games_path, folder))) - 1 for folder in subfolders]
+
+    # assemble paths
+    paths = [os.path.join(games_path, folder, '_toc.md') for folder in subfolders]
+
+    # get titles (discarding first two ("# ") and last ("\n") characters)
+    titles = [read_first_line_from_file(path)[2:-1] for path in paths]
+
+    # combine folder name, number, titles in one list
+    info = zip(titles, subfolders, n)
+
+    # sort according to title
+    info = sorted(info, key=lambda x:x[0])
+
+    # assemble output
+    update = ['- **[{}](games/{}/_toc.md)** ({})\n'.format(*entry) for entry in info]
+    update = "".join(update)
+
+    # insert new text in the middle
+    text = start + "[comment]: # (start of autogenerated content, do not edit)\n" + update + "\n[comment]: # (end of autogenerated content)" + end
+
+    # write to readme
+    with open(readme_path, 'w') as f:
+        f.write(text)
+
+def update_category_tocs():
+    """
+    Lists all entries in all sub folders and generates the list in the toc file
+    """
+    # get sub folders
+    subfolders = [x for x in os.listdir(games_path) if x != '.git' and os.path.isdir(os.path.join(games_path, x))]
+
+    # for each subfolder
+    for folder in subfolders:
+        print('generate toc for {}'.format(folder))
+
+        # read toc header line
+        toc_folder = os.path.join(games_path, folder)
+        toc_file = os.path.join(toc_folder, '_toc.md')
+        toc_header = read_first_line_from_file(toc_file)
+
+        # get all files
+        files = [x for x in os.listdir(toc_folder) if x != '_toc.md' and os.path.isfile(os.path.join(toc_folder, x))]
+        paths = [os.path.join(toc_folder, file) for file in files]
+
+        # get titles (discarding first two ("# ") and last ("\n") characters)
+        titles = [read_first_line_from_file(path)[2:-1] for path in paths]
+
+        # get more interesting info
+        more = [read_interesting_info_from_file(path) for path in paths]
+
+        # combine name and file name
+        info = zip(titles, files, more)
+
+        # sort according to title
+        info = sorted(info, key=lambda x:x[0])
+
+        # assemble output
+        update = ['- **[{}]({})** ({})\n'.format(*entry) for entry in info]
+        update = "".join(update)
+
+        # combine toc header
+        text = toc_header + '\n' + "[comment]: # (start of autogenerated content, do not edit)\n" + update + "\n[comment]: # (end of autogenerated content)"
+
+        # write to toc file
+        with open(toc_file, 'w') as f:
+            f.write(text)
+
+if __name__ == "__main__":
+
+    # paths
+    games_path = os.path.abspath(os.path.dirname(__file__))
+    readme_path = os.path.join(games_path, os.pardir, 'README.md')
+
+    # recount and write to readme
+    update_readme()
+
+    # generate list in toc files
+    update_category_tocs()
+