roadmap APIroadmap.sh ↗

"""Walkthrough: roadmap.sh SDK — discover learning paths, topics, and projects."""
from parse_apis.roadmap_sh_api import RoadmapSh, Slug, TopicContent, RoadmapNotFound

client = RoadmapSh()

# List all roadmaps and inspect the first few
for roadmap in client.roadmaps.list(limit=5):
    print(roadmap.title, roadmap.id, roadmap.updated_at)

# Search for resources by keyword across all content types
result = client.roadmaps.search(query="python", limit=3).first()
if result:
    print(result.title, result.group, result.url)

# Fetch a specific roadmap's full detail (nodes, edges, graph)
frontend = client.roadmaps.get(id=Slug.FRONTEND)
print(frontend.description, frontend.title)

# Navigate into a roadmap's topic tree via the sub-resource
rm = client.roadmap(id=Slug.FRONTEND)
for topic in rm.topics.list(limit=5):
    print(topic.node_id, topic.text, topic.is_optional)

# Fetch detailed content for a specific topic
detail = rm.topics.get(node_id="VlNNwIEDWqQXtqkHWJYzC", topic_slug="internet")
print(detail.description, detail.roadmap_slug)

# List guides and fetch one by id
guide = client.guides.list(limit=3).first()
if guide:
    full_guide = client.guides.get(id=guide.id)
    print(full_guide.title, full_guide.description)

# Typed error handling — catch a not-found roadmap
try:
    bad = client.roadmap(id="nonexistent-roadmap-xyz")
    for t in bad.topics.list(limit=1):
        print(t.text)
except RoadmapNotFound as exc:
    print(f"Roadmap not found: {exc.slug}")

# List beginner projects
for project in client.projects.list(limit=3):
    print(project.title, project.description)

print("exercised: roadmaps.list / roadmaps.search / roadmaps.get / topics.list / topics.get / guides.list / guides.get / projects.list")