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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: render_engine
-Version: 2025.10.1a2
+Version: 2025.10.3a1
 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.10.1a2 → render_engine-2025.10.3a1}/docs/docs/cli.md

@@ -7,6 +7,12 @@ tags: ["render-engine", "cli", "site-setup", "build", "serve"]
 
 Render Engine comes with a CLI that can be used to create, build, and serve your site.
 
+> !!! Note
+    The CLI is no longer a part of the Render Engine package and must be installed
+    separately. To install run `pip install render-engine-cli`. Render Engine can be
+    installed together with the CLI as well using
+    `pip install render-engine[cli]`.
+
 ## pyproject.toml Configuration
 
 The Render Engine CLI can be configured through your `pyproject.toml` file to set default values and avoid repetitive command-line arguments.

{render_engine-2025.10.1a2 → render_engine-2025.10.3a1}/docs/docs/parsers.md

@@ -51,7 +51,7 @@ my_page._render_content()
 In many cases, you will want to create rich content. The `MarkdownPageParser`. You can also pass in attributes to the page via frontmatter at the top of the markdown file.
 
 ```python
-from render_engine.parsers.base_parsers import BasePageParser
+from render_engine_markdown import MarkdownPageParser
 from render_engine.page import Page
 
 base_markdown = """
@@ -63,8 +63,8 @@ This is **dynamic** content
 """
 
 class MyPage(Page):
-    parser = BasePageParser
-    content = base_text
+    parser = MarkdownPageParser
+    content = base_markdown
 
 my_page = MyPage()
 my_page.title
@@ -78,6 +78,10 @@ my_page._render_content()
 
 ```
 
+> !!! Note
+    `MarkdownPageParser` is found in the `render_engine_markdown` package.
+    To install run `pip install render_engine_markdown`.
+
 ## Creating Custom Parsers
 
 You can create custom parsers.

{render_engine-2025.10.1a2 → render_engine-2025.10.3a1}/docs/docs/templates.md

@@ -95,3 +95,10 @@ By default this will format to the site's `DATETIME_FORMAT` (default: `"%d %b %Y
 {{ page.date | format_datetime("%B %d, %Y") }} --> January 01, 2000
 
 ```
+
+## Site Map
+
+Render builds a site map prior to rendering the content. The contents of this
+site map are available to be used in both Page objects (see
+[Page object documentation](/page/#accessing-urls-for-other-pages-in-the-site-from-within-the-page-content).)
+Please see the [site map documentation](/site_map.html) for more information.

{render_engine-2025.10.1a2 → render_engine-2025.10.3a1}/docs/mkdocs.yml

@@ -18,13 +18,12 @@ nav:
     - contributing/CONTRIBUTING.md
   - Components:
     - Page Objects: page.md
-    - Collection:
+    - Collection Objects:
       - Collection: collection.md
       - Custom Collection: custom_collections.md
       - Archive: archive.md
       - RSS Feed: feeds.md
-    - Site:
-      - Site: site.md
+    - Site Objects: site.md
   - Extending Render Engine:
     - Plugins: plugins.md
   - Parsers: parsers.md
@@ -32,6 +31,7 @@ nav:
   - Templates and Themes:
     - Templates: templates.md
     - ThemeManager: theme_management.md
+  - Site Map: site_map.md
 
 markdown_extensions:
   - toc

{render_engine-2025.10.1a2 → render_engine-2025.10.3a1}/src/render_engine/collection.py

@@ -6,10 +6,12 @@ from pathlib import Path
 from typing import Any
 
 import dateutil.parser as dateparse
-from more_itertools import batched, flatten
+from more_itertools import batched
 from render_engine_parser import BasePageParser
 from slugify import slugify
 
+from render_engine.content_managers import ContentManager, FileContentManager
+
 from ._base_object import BaseObject
 from .archive import Archive
 from .feeds import RSSFeed
@@ -56,6 +58,9 @@ class Collection(BaseObject):
         title: str
         template: str | None
         archive_template str | None: The template to use for the archive pages.
+        ContentManager: type[ContentManager] | None = FileContentManager
+        content_manager: ContentManager
+        content_manager_extras: dict[str, Any]: kwargs to pass to the ContentManager when instantiating
 
     Methods:
 
@@ -84,6 +89,8 @@ class Collection(BaseObject):
     template_vars: dict[str, Any]
     template: str | None
     plugin_manager: PluginManager | None
+    ContentManager: type[ContentManager] | None = FileContentManager
+    content_manager_extras: dict[str, Any]
 
     def __init__(
         self,
@@ -102,9 +109,16 @@ class Collection(BaseObject):
         self.title = self._title
         self.template_vars = getattr(self, "template_vars", {})
 
-    def iter_content_path(self):
-        """Iterate through in the collection's content path."""
-        return flatten([Path(self.content_path).glob(suffix) for suffix in self.include_suffixes])
+        cm_extras = {
+            "content_path": getattr(self, "content_path", None),
+            "include_suffixes": getattr(self, "include_suffixes", None),
+            "collection": self,
+        }
+        if hasattr(self, "content_manager_extras"):
+            cm_extras.update(self.content_manager_extras)
+        self.content_manager = self.ContentManager(**cm_extras)
+        if hasattr(self, "pages"):
+            self.content_manager.pages = self.pages
 
     def get_page(
         self,
@@ -116,8 +130,6 @@ class Collection(BaseObject):
             Parser=self.Parser,
         )
 
-        if getattr(self, "_pm", None):
-            _page.register_plugins(self.plugins, **self.plugin_settings)
         _page.parser_extras = getattr(self, "parser_extras", {})
         _page.routes = self.routes
         _page.template = getattr(self, "template", None)
@@ -162,7 +174,7 @@ class Collection(BaseObject):
         """
         try:
             return sorted(
-                (page for page in self.__iter__()),
+                (page for page in self),
                 key=self._sort_key(self.sort_by),
                 reverse=self.sort_reverse,
             )
@@ -231,10 +243,7 @@ class Collection(BaseObject):
         return f"{__name__}"
 
     def __iter__(self):
-        if not hasattr(self, "pages"):
-            self.pages = [self.get_page(page) for page in self.iter_content_path()]
-        for page in self.pages:  # noqa: UP028
-            yield page
+        yield from self.content_manager
 
     def _run_collection_plugins(self, site, hook_type: str):
         """

render_engine-2025.10.3a1/src/render_engine/content_managers/__init__.py

@@ -0,0 +1,7 @@
+from .base_content_manager import ContentManager
+from .file_content_manager import FileContentManager
+
+__all__ = [
+    ContentManager,
+    FileContentManager,
+]

render_engine-2025.10.3a1/src/render_engine/content_managers/base_content_manager.py

@@ -0,0 +1,16 @@
+from abc import ABC, abstractmethod
+from collections.abc import Generator, Iterable
+
+
+class ContentManager(ABC):
+    """Base ContentManager abstract class"""
+
+    @property
+    @abstractmethod
+    def pages(self) -> Iterable:
+        """The Page objects managed by the content manager"""
+        ...
+
+    def __iter__(self) -> Generator:
+        """Iterator for the ContentManager"""
+        yield from self.pages

render_engine-2025.10.3a1/src/render_engine/content_managers/file_content_manager.py

@@ -0,0 +1,36 @@
+from collections.abc import Iterable
+from pathlib import Path
+
+from more_itertools import flatten
+
+from render_engine.content_managers import ContentManager
+
+
+class FileContentManager(ContentManager):
+    """Content manager for content stored on the file system as individual files"""
+
+    def __init__(
+        self,
+        content_path: Path | str,
+        collection,
+        include_suffixes: Iterable[str] = ("*.md", "*.html"),
+        **kwargs,
+    ):
+        self.content_path = content_path
+        self.include_suffixes = include_suffixes
+        self.collection = collection
+        self._pages = None
+
+    def iter_content_path(self):
+        """Iterate through in the collection's content path."""
+        return flatten([Path(self.content_path).glob(suffix) for suffix in self.include_suffixes])
+
+    @property
+    def pages(self) -> Iterable:
+        if self._pages is None:
+            self._pages = [self.collection.get_page(page) for page in self.iter_content_path()]
+        yield from self._pages
+
+    @pages.setter
+    def pages(self, value: Iterable):
+        self._pages = value

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

@@ -22,7 +22,7 @@ class SiteMapEntry:
                 self._route = f"/{route.lstrip('/')}/{self.path_name}" if from_collection else f"/{self.path_name}"
                 self.entries = list()
             case Collection():
-                self._route = f"/{route.lstrip('/')}"
+                self._route = f"/{entry.routes[0].lstrip('/')}"
                 self.entries = [
                     SiteMapEntry(collection_entry, self._route, from_collection=True) for collection_entry in entry
                 ]

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: render_engine
-Version: 2025.10.1a2
+Version: 2025.10.3a1
 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.10.1a2 → render_engine-2025.10.3a1}/src/render_engine.egg-info/SOURCES.txt

@@ -82,6 +82,9 @@ src/render_engine.egg-info/SOURCES.txt
 src/render_engine.egg-info/dependency_links.txt
 src/render_engine.egg-info/requires.txt
 src/render_engine.egg-info/top_level.txt
+src/render_engine/content_managers/__init__.py
+src/render_engine/content_managers/base_content_manager.py
+src/render_engine/content_managers/file_content_manager.py
 src/render_engine/extras/__init__.py
 src/render_engine/parsers/markdown.py
 src/render_engine/render_engine_templates/__init__.py

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

@@ -60,7 +60,7 @@ def site(tmp_path_factory):
     for collection in ["coll1", "coll2"]:
 
         class MyColl(Collection):
-            routes = [collection]
+            routes = [f"{collection}-route"]
             pages = coll_pages[collection]
 
         collection_class = MyColl
@@ -82,19 +82,19 @@ def test_site_map_to_html(site):
     sm = SiteMap(site.route_list, "")
     assert sm.html == (
         "<ul>\n"
-        '\t<li><a href="/coll1">coll1</a></li>\n'
+        '\t<li><a href="/coll1-route">coll1</a></li>\n'
         "\t<ul>\n"
-        '\t\t<li><a href="/coll1/page0.html">coll1 -- Page 0</a></li>\n'
-        '\t\t<li><a href="/coll1/page1.html">coll1 -- Page 1</a></li>\n'
-        '\t\t<li><a href="/coll1/page2.html">coll1 -- Page 2</a></li>\n'
-        '\t\t<li><a href="/coll1/page3.html">coll1 -- Page 3</a></li>\n'
+        '\t\t<li><a href="/coll1-route/page0.html">coll1 -- Page 0</a></li>\n'
+        '\t\t<li><a href="/coll1-route/page1.html">coll1 -- Page 1</a></li>\n'
+        '\t\t<li><a href="/coll1-route/page2.html">coll1 -- Page 2</a></li>\n'
+        '\t\t<li><a href="/coll1-route/page3.html">coll1 -- Page 3</a></li>\n'
         "\t</ul>\n"
-        '\t<li><a href="/coll2">coll2</a></li>\n'
+        '\t<li><a href="/coll2-route">coll2</a></li>\n'
         "\t<ul>\n"
-        '\t\t<li><a href="/coll2/page0.html">coll2 -- Page 0</a></li>\n'
-        '\t\t<li><a href="/coll2/page1.html">coll2 -- Page 1</a></li>\n'
-        '\t\t<li><a href="/coll2/page2.html">coll2 -- Page 2</a></li>\n'
-        '\t\t<li><a href="/coll2/page3.html">coll2 -- Page 3</a></li>\n'
+        '\t\t<li><a href="/coll2-route/page0.html">coll2 -- Page 0</a></li>\n'
+        '\t\t<li><a href="/coll2-route/page1.html">coll2 -- Page 1</a></li>\n'
+        '\t\t<li><a href="/coll2-route/page2.html">coll2 -- Page 2</a></li>\n'
+        '\t\t<li><a href="/coll2-route/page3.html">coll2 -- Page 3</a></li>\n'
         "\t</ul>\n"
         '\t<li><a href="/page0.html">Page 0</a></li>\n'
         '\t<li><a href="/page1.html">Page 1</a></li>\n'
@@ -109,21 +109,21 @@ def test_site_map_to_html(site):
         ("page1", {}, "/page1.html"),
         ("page1", {"attr": "slug"}, "/page1.html"),
         ("page3", {"attr": "slug"}, None),
-        ("page3", {"attr": "slug", "full_search": True}, "/coll1/page3.html"),
-        ("page3", {"attr": "slug", "collection": "coll2"}, "/coll2/page3.html"),
+        ("page3", {"attr": "slug", "full_search": True}, "/coll1-route/page3.html"),
+        ("page3", {"attr": "slug", "collection": "coll2"}, "/coll2-route/page3.html"),
         ("page1.html", {"attr": "path_name"}, "/page1.html"),
         ("page3.html", {"attr": "path_name"}, None),
-        ("page3.html", {"attr": "path_name", "full_search": True}, "/coll1/page3.html"),
-        ("page3.html", {"attr": "path_name", "collection": "coll2"}, "/coll2/page3.html"),
+        ("page3.html", {"attr": "path_name", "full_search": True}, "/coll1-route/page3.html"),
+        ("page3.html", {"attr": "path_name", "collection": "coll2"}, "/coll2-route/page3.html"),
         ("page1", {"attr": "slug"}, "/page1.html"),
         ("page3", {"attr": "slug"}, None),
-        ("page3", {"attr": "slug", "full_search": True}, "/coll1/page3.html"),
-        ("page3", {"attr": "slug", "collection": "coll2"}, "/coll2/page3.html"),
+        ("page3", {"attr": "slug", "full_search": True}, "/coll1-route/page3.html"),
+        ("page3", {"attr": "slug", "collection": "coll2"}, "/coll2-route/page3.html"),
         ("Page 1", {"attr": "title"}, "/page1.html"),
         ("coll1 -- Page 3", {"attr": "title"}, None),
-        ("coll1 -- Page 3", {"attr": "title", "full_search": True}, "/coll1/page3.html"),
+        ("coll1 -- Page 3", {"attr": "title", "full_search": True}, "/coll1-route/page3.html"),
         ("coll1 -- Page 3", {"attr": "title", "collection": "coll2"}, None),
-        ("coll2 -- Page 3", {"attr": "title", "collection": "coll2"}, "/coll2/page3.html"),
+        ("coll2 -- Page 3", {"attr": "title", "collection": "coll2"}, "/coll2-route/page3.html"),
     ],
 )
 def test_site_map_search(site, value, params, expected):
@@ -137,7 +137,7 @@ 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"
+    assert (site.output_path / "page1.html").read_text() == "Page 1\n/coll1-route/page0.html"
 
 
 def test_site_map_to_xml(site):
@@ -148,34 +148,34 @@ def test_site_map_to_xml(site):
         == """<?xml version="1.0" encoding="UTF-8"?>
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
 <url>
-	<loc>http://localhost:8000/coll1</loc>
+	<loc>http://localhost:8000/coll1-route</loc>
 </url>
 <url>
-	<loc>http://localhost:8000/coll1/page0.html</loc>
+	<loc>http://localhost:8000/coll1-route/page0.html</loc>
 </url>
 <url>
-	<loc>http://localhost:8000/coll1/page1.html</loc>
+	<loc>http://localhost:8000/coll1-route/page1.html</loc>
 </url>
 <url>
-	<loc>http://localhost:8000/coll1/page2.html</loc>
+	<loc>http://localhost:8000/coll1-route/page2.html</loc>
 </url>
 <url>
-	<loc>http://localhost:8000/coll1/page3.html</loc>
+	<loc>http://localhost:8000/coll1-route/page3.html</loc>
 </url>
 <url>
-	<loc>http://localhost:8000/coll2</loc>
+	<loc>http://localhost:8000/coll2-route</loc>
 </url>
 <url>
-	<loc>http://localhost:8000/coll2/page0.html</loc>
+	<loc>http://localhost:8000/coll2-route/page0.html</loc>
 </url>
 <url>
-	<loc>http://localhost:8000/coll2/page1.html</loc>
+	<loc>http://localhost:8000/coll2-route/page1.html</loc>
 </url>
 <url>
-	<loc>http://localhost:8000/coll2/page2.html</loc>
+	<loc>http://localhost:8000/coll2-route/page2.html</loc>
 </url>
 <url>
-	<loc>http://localhost:8000/coll2/page3.html</loc>
+	<loc>http://localhost:8000/coll2-route/page3.html</loc>
 </url>
 <url>
 	<loc>http://localhost:8000/page0.html</loc>