The definitive list of the best of (consumer facing) open source.
import json
from pathlib import Path
import sys
CORE_DIR = Path(__file__).resolve().parents[2]
if str(CORE_DIR) not in sys.path:
sys.path.insert(0, str(CORE_DIR))
from source.generation.contents_generator import app_matches_platform # noqa: E402
from source.utils.markdown_utils import slugify # noqa: E402
from source.utils.path_utils import DYNAMIC_DATA_DIR, STATIC_DATA_DIR # noqa: E402
def generate_table_of_contents(platform="all"):
with open(STATIC_DATA_DIR / "categories.json", "r", encoding="utf-8") as f:
cat_data = json.load(f)
with open(
DYNAMIC_DATA_DIR / "applications_generated.json", "r", encoding="utf-8"
) as f:
app_data = json.load(f)
categories = cat_data.get("categories", [])
subcategories = cat_data.get("subcategories", [])
applications = app_data.get("applications", [])
# Find all subcategory ids that have at least one application matching the platform
active_subcat_ids = {
app.get("category", "uncategorized")
for app in applications
if app_matches_platform(app, platform)
}
# Deduplicate subcategories and keep only those with matching applications
seen_subcat_ids = set()
active_subcategories = []
for sub in subcategories:
if sub["id"] in seen_subcat_ids:
continue
seen_subcat_ids.add(sub["id"])
if sub["id"] in active_subcat_ids:
active_subcategories.append(sub)
# Build the alphabetical list (ignoring parent categories)
subcat_names = [sub["name"] for sub in active_subcategories]
subcat_names.sort(key=lambda x: x.lower())
alphabetical_md = ""
for name in subcat_names:
alphabetical_md += f"- [{name}](#{slugify(name)})\n"
# Build the categorized list
parent_map = {cat["id"]: cat["name"] for cat in categories}
grouped = {}
for sub in active_subcategories:
parent = sub.get("parent", "other")
grouped.setdefault(parent, []).append(sub["name"])
for key in grouped:
grouped[key].sort(key=lambda x: x.lower())
parents = [(pid, parent_map.get(pid, "Other")) for pid in grouped if pid != "other"]
parents.sort(key=lambda x: x[1].lower())
if "other" in grouped:
parents.append(("other", "Other"))
categorized_md_lines = []
for pid, pname in parents:
categorized_md_lines.append(f"- {pname}")
for subname in grouped[pid]:
categorized_md_lines.append(f" - [{subname}](#{slugify(subname)})")
# Append fixed sections at the end of the categorized TOC
fixed_sections = [
"Removed Projects",
"FAQ",
"Honorable Mentions of Closed-Source Software",
]
for item in fixed_sections:
categorized_md_lines.append(f"- [{item}](#{slugify(item)})")
categorized_md = "\n".join(categorized_md_lines)
toc = f"""## Table of Contents
<details>
<summary><b>Alphabetical</b></summary> <br />
{alphabetical_md}
</details>
<details open>
<summary><b>Categorized</b></summary> <br />
{categorized_md}
</details>
"""
return toc
if __name__ == "__main__":
# For testing the TOC generator
print(generate_table_of_contents())