Add sitemap using flask-sitemapper

Author: laike9m

app.py

@@ -2,6 +2,7 @@
 from typing import cast
 
 from views import views
+from views.sitemap import sitemapper
 
 app = Flask(
     __name__,
@@ -10,6 +11,7 @@
     static_url_path="/static",
 )
 app.register_blueprint(views.app_views)
+sitemapper.init_app(app)
 
 
 @app.errorhandler(404)
@@ -20,3 +22,8 @@ def page_not_found(e):
 @app.route("/robots.txt")
 def robots_txt():
     return send_from_directory(cast(str, app.static_folder), request.path[1:])
+
+
+@app.route("/sitemap.xml")
+def r_sitemap():
+    return sitemapper.generate()

pdm.lock

@@ -9,6 +9,7 @@ dependencies = [
     "flask>=3.0.0",
     "typing-extensions>=4.8.0",
     "pyright>=1.1.334",
+    "flask-sitemapper>=1.7.0",
 ]
 requires-python = ">=3.12"
 readme = "README.md"

pyproject.toml

@@ -21,7 +21,12 @@ class Level(StrEnum):
 
 
 ChallengeName: TypeAlias = str
-ChallengeKey: TypeAlias = tuple[Level, ChallengeName]
+
+
+@dataclass(frozen=True)
+class ChallengeKey:
+    level: Level
+    name: ChallengeName
 
 
 @dataclass
@@ -71,7 +76,7 @@ def _load_challenges() -> dict[ChallengeKey, Challenge]:
             level, challenge_name = dir_name.split("-", maxsplit=1)
             with open(filename, "r") as file:
                 code = file.read()
-            challenges[(level, challenge_name)] = Challenge(
+            challenges[ChallengeKey(Level(level), challenge_name)] = Challenge(
                 name=challenge_name,
                 level=Level(level),
                 code=code,

views/challenge.py

@@ -0,0 +1,3 @@
+from flask_sitemapper import Sitemapper
+
+sitemapper = Sitemapper()

views/sitemap.py

@@ -8,11 +8,13 @@
     request,
 )
 
-from .challenge import challenge_manager, Level
+from .challenge import challenge_manager, Level, ChallengeKey
+from .sitemap import sitemapper
 
 app_views = Blueprint("app_views", __name__)
 
 
+@sitemapper.include(changefreq="daily", priority=1.0)
 @app_views.route("/")
 def index():
     return render_template(
@@ -21,9 +23,18 @@ def index():
     )
 
 
+@sitemapper.include(
+    changefreq="daily",
+    priority=0.5,
+    # https://github.com/h-janes/flask-sitemapper/wiki/Usage#dynamic-routes
+    url_variables={
+        "level": [c.level for c in challenge_manager.challenges.keys()],
+        "name": [c.name for c in challenge_manager.challenges.keys()],
+    },
+)
 @app_views.route("/<level>/<name>", methods=["GET"])
 def get_challenge(level: str, name: str):
-    challenge_key = (Level(level), name)
+    challenge_key = ChallengeKey(Level(level), name)
     if not challenge_manager.has_challenge(challenge_key):
         return redirect("/")