TOC.py

#!/usr/local/bin/python3
# File to generate the SUMMARY.md file for the gitbook
# - filter for gitignore
# - filter for system files
# - filter for images/ directories
#%%
import os
#%%
semesters = {
    "vwl1": "I. Semester",
    "vwl2": "II. Semester", 
    "vwl3": "III. Semester", 
    "vwl4": "IV. Semester",
    "vwl5": "V. Semester",
    "vwl6": "VI. Semester",
    }


dir_names = {
    "VL_Buchfuehrung": "Buchführung",
    "VL_BWL": "BWL",
    "VL_Mathe1": "Mathe",
    "VL_VWL": "VWL ",
    "VL_Statistik1": "Statistik ",
    "VL_Wirtschaftsinformatik": "Wirtschaftsinfo",

    "VL_Mathe2": "Mathematik II",
    "VL_Statistik2": "Statistik II",
    "VL_Mikro": "Mikroökonomik",
    "VL_WissArbeit": "Wissenschaftliches Arbeiten",
    "VL_Recht-WiWi": "Recht für WiWi",
    "VL_Stadt": "Stadtökonomie (Leipzig)",

    "VL_Ethik": "Ethik der Soz. Marktwirtschaft",
    "VL_Makro1": "Makroökonomik I",
    "VL_Mikro2": "Mikroökonomik II",
    "VL_Monetaer": "Monetäre Ökonomik",
    "VL_Wachstum": "Wachstum und Nachhaltigkeit",
    "VL_Soziologie": "Wirtschaftssoziologie",

    "VL_Angewandte": "Angewandte Ökonomik",
    "VL_Makro2": "Makroökonomik II",
    "VL_International": "International Economics",
    "VL_SoEco": "Sozial-Ökologische Systeme",
    "VL_WiPo": "Wirtschaftspolitik",

    "VL_EconHistory": "Economic History",
    "VL_Empirical": "Empirical Economics",
    "VL_Feminist": "Feminist Economics",
    "VL_PublicEcon": "Public Economics",
    "VL_Zivilrecht": "Zivilrecht",

    "VL_Econometrics": "Econometrics",
    "VL_Umwelt": "Umweltökonomie",
    "VL_Sozialismus": "Sozialismus",
    "VL_Macrometrics": "Macroeconometrics"
}

#%%

with open(".gitignore") as f:
    ignores = f.read().splitlines()

ignores.append([
    "SUMMARY.md",
    "TOC.py",
    "README.md",
    "images",
    "LICENSE.md",
    ])

#%%
# get all files in the directory and subdirectories with type {dirname : filenames}
result_list = ["root: index", "subtrees:"] # first two lines of the SUMMARY.md


result_list.append(f"""
- caption: "Inhaltsverzeichnis"    
  hidden: True
  maxdepth: 1
  titlesonly: True
  entries:
""")

# Add the files in /glossar

result_list.append(f"""
  - file: glossar/Allgemein
    title: "Glossar"
    entries:
""")


## Add the files in /glossar
for file in sorted(os.listdir("glossar")):
    if file[-3:] == ".md" and file != "Allgemein.md":
        filename = file[:-3]
        filename = filename.replace("_", " ")
        filename = filename.replace("-", " ")
        result_list.append(f"""
    - file: glossar/{file}
      title: "{filename}"
    """)

#%%

# count the files and directories
count_files = 0
count_dirs = 0


for semester, desc in semesters.items():

    # add the semester as a headline

    result_list.append(f"""
  - file: {semester}/README
    title: {desc}
    entries:
    """)

    for dir in os.listdir(semester):

        if dir in dir_names.keys():

            # add the directory name as a headline
            result_list.append(f"    - file: {semester}/{dir}/README")
            result_list.append(f"      title: {dir_names[dir]}")
            result_list.append(f"      entries:")

            count_dirs += 1 # count the directories

            for file in sorted(os.listdir(f"{semester}/{dir}")):
                # ignore README
                if file == "README.md":
                    # dont add the README to the list
                    pass

                elif file not in ignores:
                    if file[-3:] == ".md": # only add markdown files, not directories
                        filename = file[11:-3]
                        filename = filename.replace("_", " ")
                        filename = filename.replace("-", " ")

                        # add the file to the list

                        result_list.append(f"      - file: {semester}/{dir}/{file}")
                        result_list.append(f"        title: {filename}")

                        count_files += 1 # count the files
              


# add the number of files and directories to the end of the SUMMARY.md
#result_list.append(f"**{count_files}** Notizen in **{count_dirs}** Modulen")
print(f"**{count_files}** Notizen in **{count_dirs}** Modulen")

with open("_toc.yml", "w") as f:
    f.writelines(line + '\n' for line in result_list)
    print("TOC updated")

# %%