render-engine 2025.9.1a2__tar.gz → 2025.10.1a1__tar.gz

{render_engine-2025.9.1a2 → render_engine-2025.10.1a1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: render_engine
-Version: 2025.9.1a2
+Version: 2025.10.1a1
 Summary: A Flexible Static Site Generator for Python
 Project-URL: homepage, https://github.com/render-engine/render-engine/
 Project-URL: repository, https://github.com/render-engine/render-engine/

{render_engine-2025.9.1a2 → render_engine-2025.10.1a1}/docs/docs/site_map.md

@@ -41,7 +41,7 @@ one found.
 The `SiteMap` object has an `html` property that will return an HTML sitemap with _absolute_ URLs with the
 `Site`'s `SITE_URL`.
 
-As a convenience, Render Engine will generate a site map page if the `Site` property of `render_site_map`
+As a convenience, Render Engine will generate a site map page if the `Site` property of `render_html_site_map`
 is `True` (it defaults to `False`.) Please note that this will not be templated. Should you wish the generated
 site map to be on a template you can add the following to your app:
 
@@ -53,7 +53,13 @@ class SiteMapPage(Page):
     skip_site_map = True
 ```
 
-Please note the `skip_site_map = True` to avoid having a self referential link to the site map.
+Please note the `skip_site_map = True` to avoid having a self-referential link to the site map.
+
+## Generating an XML site map
+
+To have your site generate an XML site map set the `render_xml_site_map` property of your `Site` object
+to `True` (defaults to `False`.) This will create the `site_map.xml` file in the root output directory
+of your site.
 
 ## The `SiteMapEntry` object
 

{render_engine-2025.9.1a2 → render_engine-2025.10.1a1}/src/render_engine/render_engine_templates/sitemap.xml

@@ -1,6 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
-{% for item in items %}
+{% for item in site_map %}
 {% include 'sitemap_item.xml' %}
+
 {% endfor %}
 </urlset>

{render_engine-2025.9.1a2 → render_engine-2025.10.1a1}/src/render_engine/render_engine_templates/sitemap_item.xml

@@ -1,10 +1,10 @@
 <url>
-	<loc>{{SITE_URL}}/{{item}}</loc>
+	<loc>{{SITE_URL.rstrip("/")}}/{{item.url_for.lstrip("/")}}</loc>
 	{% if item.lastmod %}
 	<lastmod>{{item.lastmod}}</lastmod>
 	{% endif %}
 	{% if item.changefreq %}
-	<schangefreq>{{item.changefreq}}</changefreq>
+	<changefreq>{{item.changefreq}}</changefreq>
 	{% endif %}
 	{% if item.priority %}
 	<priority>{{item.priority}}</priority>

{render_engine-2025.9.1a2 → render_engine-2025.10.1a1}/src/render_engine/site.py

@@ -21,7 +21,8 @@ class Site:
     Attributes:
         site_vars (dict): A dictionary containing site-wide variables and their values.
         plugin_settings (dict): A dictionary containing plugin settings.
-        render_site_map (bool): Whether to render the generated site map as a page.
+        render_html_site_map (bool): Whether to render the generated site map as an HTML page.
+        render_xml_site_map (bool): Whether to render the generated site map as XML.
 
     Methods:
         update_site_vars(**kwargs): Updates the site-wide variables with the given key-value pairs.
@@ -51,7 +52,8 @@ class Site:
     _template_path: str | Path = "templates"
     _static_paths: set = {"static"}
     plugin_settings: dict = {"plugins": defaultdict(dict)}
-    render_site_map: bool = False
+    render_html_site_map: bool = False
+    render_xml_site_map: bool = False
 
     def __init__(
         self,
@@ -253,7 +255,7 @@ class Site:
         with Progress() as progress:
             task_site_map = progress.add_task("Generating site map", total=1)
             self._site_map = SiteMap(self.route_list, self.site_vars.get("SITE_URL", ""))
-            if self.render_site_map:
+            if self.render_html_site_map:
 
                 @self.page
                 class SiteMapPage(Page):
@@ -262,6 +264,13 @@ class Site:
                     content = self._site_map.html
                     template = "page.html"
 
+            if self.render_xml_site_map:
+
+                @self.page
+                class SiteMapXml(Page):
+                    path_name = "site_map.xml"
+                    template = "sitemap.xml"
+
             progress.update(task_site_map, advance=1)
 
             pre_build_task = progress.add_task("Loading Pre-Build Plugins and Themes", total=1)

{render_engine-2025.9.1a2 → render_engine-2025.10.1a1}/src/render_engine/site_map.py

@@ -34,6 +34,10 @@ class SiteMapEntry:
         """The URL for the given entry"""
         return str(self._route)
 
+    def __str__(self) -> str:
+        """String representation of the entry as its URL"""
+        return self.url_for
+
 
 class SiteMap:
     """Site map"""
@@ -58,6 +62,12 @@ class SiteMap:
                 self._collections[sm_entry.slug] = sm_entry
         self.site_url = site_url
 
+    def __iter__(self):
+        """Iterator for the site map object"""
+        for entry in self._route_map.values():
+            yield entry
+            yield from entry.entries
+
     def find(
         self,
         value: str,
@@ -121,6 +131,8 @@ class SiteMap:
     def html(self) -> str:
         """Build the site map as HTML"""
         html_string = "<ul>\n"
+        # We can't iterate over `self` because that will flatten out the site map and we do not want that for the HTML
+        # version.
         for entry in self._route_map.values():
             html_string += f'\t<li><a href="{urljoin(self.site_url, entry.url_for)}">{entry.title}</a></li>\n'
             if entry.entries:

{render_engine-2025.9.1a2 → render_engine-2025.10.1a1}/src/render_engine.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: render_engine
-Version: 2025.9.1a2
+Version: 2025.10.1a1
 Summary: A Flexible Static Site Generator for Python
 Project-URL: homepage, https://github.com/render-engine/render-engine/
 Project-URL: repository, https://github.com/render-engine/render-engine/

{render_engine-2025.9.1a2 → render_engine-2025.10.1a1}/tests/test_site_map.py

@@ -138,3 +138,53 @@ def test_site_map_search(site, value, params, expected):
 def test_find_in_template(site):
     site.render()
     assert (site.output_path / "page1.html").read_text() == "Page 1\n/coll1/page0.html"
+
+
+def test_site_map_to_xml(site):
+    site.render_xml_site_map = True
+    site.render()
+    assert (
+        (site.output_path / "site_map.xml").read_text()
+        == """<?xml version="1.0" encoding="UTF-8"?>
+<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+<url>
+	<loc>http://localhost:8000/coll1</loc>
+</url>
+<url>
+	<loc>http://localhost:8000/coll1/page0.html</loc>
+</url>
+<url>
+	<loc>http://localhost:8000/coll1/page1.html</loc>
+</url>
+<url>
+	<loc>http://localhost:8000/coll1/page2.html</loc>
+</url>
+<url>
+	<loc>http://localhost:8000/coll1/page3.html</loc>
+</url>
+<url>
+	<loc>http://localhost:8000/coll2</loc>
+</url>
+<url>
+	<loc>http://localhost:8000/coll2/page0.html</loc>
+</url>
+<url>
+	<loc>http://localhost:8000/coll2/page1.html</loc>
+</url>
+<url>
+	<loc>http://localhost:8000/coll2/page2.html</loc>
+</url>
+<url>
+	<loc>http://localhost:8000/coll2/page3.html</loc>
+</url>
+<url>
+	<loc>http://localhost:8000/page0.html</loc>
+</url>
+<url>
+	<loc>http://localhost:8000/page1.html</loc>
+</url>
+<url>
+	<loc>http://localhost:8000/page2.html</loc>
+</url>
+</urlset>"""
+    )