render-engine 2025.11.1a1__tar.gz → 2026.1.1a2__tar.gz

{render_engine-2025.11.1a1 → render_engine-2026.1.1a2}/.github/workflows/devcontainer-ci.yml

@@ -19,9 +19,9 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6.0.1
       - name: Use Node.js 20.x
-        uses: actions/setup-node@v4
+        uses: actions/setup-node@v6
         with:
           node-version: 20.x
       - run: npm install -g @devcontainers/cli

{render_engine-2025.11.1a1 → render_engine-2026.1.1a2}/.github/workflows/labeler.yml

@@ -12,5 +12,5 @@ jobs:
   labeler:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v5
+    - uses: actions/checkout@v6.0.1
     - uses: actions/labeler@v5

{render_engine-2025.11.1a1 → render_engine-2026.1.1a2}/.github/workflows/lint.yml

@@ -13,7 +13,7 @@ jobs:
     name: Format and Lint Python
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6.0.1
         with:
           fetch-depth: 0
       - name: Install Python
@@ -34,7 +34,7 @@ jobs:
     name: Lint Markdown
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6.0.1
       - name: Markdown Lint base-files
         uses: DavidAnson/markdownlint-cli2-action@v20
         with:

{render_engine-2025.11.1a1 → render_engine-2026.1.1a2}/.github/workflows/publish.yml

@@ -15,7 +15,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout source
-        uses: actions/checkout@v5
+        uses: actions/checkout@v6.0.1
 
       - name: Set up Python 3.11
         uses: actions/setup-python@v5

{render_engine-2025.11.1a1 → render_engine-2026.1.1a2}/.github/workflows/scorecard.yml

@@ -32,7 +32,7 @@ jobs:
 
     steps:
       - name: "Checkout code"
-        uses: actions/checkout@ff7abcd0c3c05ccf6adc123a8cd1fd4fb30fb493 # v4.1.1
+        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v4.1.1
         with:
           persist-credentials: false
 
@@ -59,7 +59,7 @@ jobs:
       # Upload the results as artifacts (optional). Commenting out will disable uploads of run results in SARIF
       # format to the repository Actions tab.
       - name: "Upload artifact"
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@v6
         with:
           name: SARIF
           path: results.sarif
@@ -68,6 +68,6 @@ jobs:
       # Upload the results to GitHub's code scanning dashboard (optional).
       # Commenting out will disable upload of results to your repo's Code Scanning dashboard
       - name: "Upload to code-scanning"
-        uses: github/codeql-action/upload-sarif@v3
+        uses: github/codeql-action/upload-sarif@v4
         with:
           sarif_file: results.sarif

{render_engine-2025.11.1a1 → render_engine-2026.1.1a2}/.github/workflows/test.yml

@@ -23,7 +23,7 @@ jobs:
         python-version: ["3.10", "3.11", "3.12", "3.13"]
       fail-fast: true
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6.0.1
       - uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
@@ -44,7 +44,7 @@ jobs:
       fail-fast: true
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6.0.1
       - uses: actions/setup-python@v5
         with:
           python-version: "3.12"
@@ -56,7 +56,7 @@ jobs:
         run: |
           python -m pytest
       - name: coverage
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@v6
         with:
           name: code-coverage-report-${{ matrix.os }}
           path: .coverage

{render_engine-2025.11.1a1 → render_engine-2026.1.1a2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: render_engine
-Version: 2025.11.1a1
+Version: 2026.1.1a2
 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.11.1a1 → render_engine-2026.1.1a2}/docs/docs/collection.md

@@ -46,7 +46,8 @@ sort_reverse: bool = False
 title: str
 template: str | None
 archive_template str | None: The template to use for the archive pages.
-skip_site_map: bool = False: Flag to indicate whether this Collection should not be included in the SiteMap.
+ContentManager: type[ContentManager] | None = FileContentManager: The `ContentManager` to use.
+content_manager_extras: dict[str, Any]: Configuration options to send to the `ContentManager` during instantiation.
 ```
 
 ## Attributes

render_engine-2026.1.1a2/docs/docs/content_manager.md

@@ -0,0 +1,85 @@
+---
+title: "Enhancing Functionality with Content Managers"
+description: "Guide to using creating Content Managers to use alternate content storage systems."
+date: August 22, 2024
+tags: ["content_manager", "render-engine", "customization"]
+---
+
+Content Managers are a way to control how and where your content is stored.
+
+## Introduction
+
+Render Engine `Collection` uses a `ContentManager` to manage the storage of content for site generation. By default
+content is stored in the file system with each piece of content existing in a discrete file. With an alternate
+`ContentManager` the content can be stored in a database, JSON file, or other alternate data store.
+
+## Selecting a `ContentManager`
+
+The `ContentManager` for a given [`Collection`](collection.md) is controlled by the `ContentManager` attribute. When
+the class is instantiated the `ContentManager` is also instantiated with any `content_manager_extras` being passed
+as arguments. To access the `ContentManager` of a given `Collection` use the `content_manager` attribute.
+
+## Creating a `ContentManager`
+
+To create a `ContentManager` create a sub-class of `ContentManager` that implements the following methods:
+
+```python
+@property
+@abstractmethod
+def pages(self) -> Iterable:
+    """The Page objects managed by the content manager"""
+    ...
+
+@abstractmethod
+def create_entry(self, filepath: Path = None, editor: str = None, metadata: dict = None, content: str = None):
+    """Create a new entry"""
+    ...
+```
+
+### `pages`
+
+The `pages` property is how the `Collection` accesses its content. It is a method that _must_ be implemented by
+every `ContentManager`. An example `pages` implementation (from the
+[`FileContentManger`](https://github.com/render-engine/render-engine/blob/main/src/render_engine/content_managers/file_content_manager.py)) is:
+
+```python
+@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
+```
+
+### `create_entry`
+
+The `create_entry` method is used by the Render Engine CLI tool to add new entries. It is responsible for adding
+the new entry to the datastore and, if an `editor` is specified, giving the user the ability to edit the new entry
+prior to committing the entry to the datastore.
+
+#### Arguments
+
+- `filepath: Path`: The path on the filesystem to store the new entry.
+- `editor: str`: The text editor to open for editing the new entry.
+- `content: str`: The initial content for the new entry.
+- `metadata: dict`: The metadata for the new entry.
+
+!!! Note
+    Not every `ContentManager` actually needs all the arguments that are passed.
+
+### `find_entry`
+
+The `find_entry` method is used to find a specific page in a `Collection`. It will search through all the pages
+known to the `ContentManager` until it finds one that has all the attributes specified. Even if multiple entries
+would satisfy the criteria, only the first found will be returned.
+
+### `update_entry`
+
+The `update_entry` is used to update an existing entry in a `ContentManager`.
+
+Parameters:
+
+```python
+page: Page  # The Page to update
+content: str = None  # Updated content
+**kwargs: dict  # The other attributes for the updated page
+```

{render_engine-2025.11.1a1 → render_engine-2026.1.1a2}/docs/mkdocs.yml

@@ -26,6 +26,7 @@ nav:
     - Site Objects: site.md
   - Extending Render Engine:
     - Plugins: plugins.md
+    - Content Managers: content_manager.md
   - Parsers: parsers.md
   - CLI: cli.md
   - Templates and Themes:

{render_engine-2025.11.1a1 → render_engine-2026.1.1a2}/requirements.txt

@@ -4,30 +4,30 @@
 #
 #    pip-compile --extra=dev --output-file=requirements.txt pyproject.toml
 #
-anyio==4.10.0
+anyio==4.12.0
     # via
     #   httpx
     #   watchfiles
-arrow==1.3.0
+arrow==1.4.0
     # via cookiecutter
 babel==2.17.0
     # via mkdocs-material
-backrefs==6.0.1
+backrefs==6.1
     # via mkdocs-material
 binaryornot==0.4.4
     # via cookiecutter
-certifi==2025.8.3
+certifi==2025.11.12
     # via
     #   httpcore
     #   httpx
     #   requests
-cfgv==3.4.0
+cfgv==3.5.0
     # via pre-commit
 chardet==5.2.0
     # via binaryornot
-charset-normalizer==3.4.3
+charset-normalizer==3.4.4
     # via requests
-click==8.2.1
+click==8.3.1
     # via
     #   cookiecutter
     #   mkdocs
@@ -38,13 +38,13 @@ colorama==0.4.6
     #   mkdocs-material
 cookiecutter==2.6.0
     # via render_engine (pyproject.toml)
-coverage[toml]==7.10.6
+coverage[toml]==7.13.1
     # via pytest-cov
 distlib==0.4.0
     # via virtualenv
 ephemeral-port-reserve==1.1.4
     # via render_engine (pyproject.toml)
-filelock==3.19.1
+filelock==3.20.1
     # via virtualenv
 ghp-import==2.1.0
     # via mkdocs
@@ -52,7 +52,7 @@ gitdb==4.0.12
     # via gitpython
 gitpython==3.1.45
     # via render_engine (pyproject.toml)
-griffe==1.13.0
+griffe==1.15.0
     # via mkdocstrings-python
 h11==0.16.0
     # via httpcore
@@ -60,14 +60,14 @@ httpcore==1.0.9
     # via httpx
 httpx==0.28.1
     # via render_engine (pyproject.toml)
-identify==2.6.13
+identify==2.6.15
     # via pre-commit
-idna==3.10
+idna==3.11
     # via
     #   anyio
     #   httpx
     #   requests
-iniconfig==2.1.0
+iniconfig==2.3.0
     # via pytest
 jinja2==3.1.6
     # via
@@ -76,7 +76,7 @@ jinja2==3.1.6
     #   mkdocs-material
     #   mkdocstrings
     #   render_engine (pyproject.toml)
-markdown==3.8.2
+markdown==3.10
     # via
     #   mkdocs
     #   mkdocs-autorefs
@@ -89,7 +89,7 @@ markdown2==2.5.4
     # via
     #   render-engine-markdown
     #   render_engine (pyproject.toml)
-markupsafe==3.0.2
+markupsafe==3.0.3
     # via
     #   jinja2
     #   mkdocs
@@ -113,23 +113,23 @@ mkdocs-autorefs==1.4.3
     #   mkdocstrings-python
 mkdocs-get-deps==0.2.0
     # via mkdocs
-mkdocs-material==9.6.18
+mkdocs-material==9.7.1
     # via render_engine (pyproject.toml)
 mkdocs-material-extensions==1.3.1
     # via mkdocs-material
-mkdocstrings[python]==0.30.0
+mkdocstrings[python]==1.0.0
     # via
     #   mkdocstrings-python
     #   render_engine (pyproject.toml)
-mkdocstrings-python==1.18.2
+mkdocstrings-python==2.0.1
     # via mkdocstrings
 more-itertools==10.8.0
     # via render_engine (pyproject.toml)
-mypy==1.17.1
+mypy==1.19.1
     # via render_engine (pyproject.toml)
 mypy-extensions==1.1.0
     # via mypy
-nodeenv==1.9.1
+nodeenv==1.10.0
     # via pre-commit
 packaging==25.0
     # via
@@ -139,7 +139,7 @@ paginate==0.5.7
     # via mkdocs-material
 pathspec==0.12.1
     # via mkdocs
-platformdirs==4.4.0
+platformdirs==4.5.1
     # via
     #   mkdocs-get-deps
     #   virtualenv
@@ -147,25 +147,25 @@ pluggy==1.6.0
     # via
     #   pytest
     #   render_engine (pyproject.toml)
-pre-commit==4.3.0
+pre-commit==4.5.1
     # via render_engine (pyproject.toml)
 pygments==2.19.2
     # via
     #   mkdocs-material
     #   rich
-pymdown-extensions==10.16.1
+pymdown-extensions==10.20
     # via
     #   mkdocs-material
     #   mkdocstrings
     #   render_engine (pyproject.toml)
-pytest==8.4.2
+pytest==9.0.2
     # via
     #   pytest-cov
     #   pytest-mock
     #   render_engine (pyproject.toml)
-pytest-cov==6.2.1
+pytest-cov==7.0.0
     # via render_engine (pyproject.toml)
-pytest-mock==3.14.1
+pytest-mock==3.15.1
     # via render_engine (pyproject.toml)
 python-dateutil==2.9.0.post0
     # via
@@ -180,7 +180,7 @@ python-slugify==8.0.4
     # via
     #   cookiecutter
     #   render_engine (pyproject.toml)
-pyyaml==6.0.2
+pyyaml==6.0.3
     # via
     #   cookiecutter
     #   mkdocs
@@ -201,12 +201,12 @@ requests==2.32.5
     # via
     #   cookiecutter
     #   mkdocs-material
-rich==14.1.0
+rich==14.2.0
     # via
     #   cookiecutter
     #   render_engine (pyproject.toml)
     #   typer
-ruff==0.12.11
+ruff==0.14.10
     # via render_engine (pyproject.toml)
 shellingham==1.5.4
     # via typer
@@ -219,22 +219,22 @@ sniffio==1.3.1
 text-unidecode==1.3
     # via python-slugify
 toml==0.10.2
-typer==0.17.3
+typer==0.21.0
     # via render_engine (pyproject.toml)
-types-python-dateutil==2.9.0.20250822
+types-python-dateutil==2.9.0.20251115
     # via arrow
 typing-extensions==4.15.0
     # via
     #   anyio
     #   mypy
     #   typer
-tzdata==2025.2
+tzdata==2025.3
     # via render_engine (pyproject.toml)
-urllib3==2.5.0
+urllib3==2.6.3
     # via requests
-virtualenv==20.34.0
+virtualenv==20.35.4
     # via pre-commit
 watchdog==6.0.0
     # via mkdocs
-watchfiles==1.1.0
+watchfiles==1.1.1
     # via render_engine (pyproject.toml)

{render_engine-2025.11.1a1 → render_engine-2026.1.1a2}/src/render_engine/__version__.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '2025.11.1a1'
-__version_tuple__ = version_tuple = (2025, 11, 1, 'a1')
+__version__ = version = '2026.1.1a2'
+__version_tuple__ = version_tuple = (2026, 1, 1, 'a2')
 
-__commit_id__ = commit_id = 'g5ed5705d6'
+__commit_id__ = commit_id = 'g6c6c29a4d'

{render_engine-2025.11.1a1 → render_engine-2026.1.1a2}/src/render_engine/_base_object.py

@@ -27,6 +27,7 @@ class BaseObject:
     plugins: list[Callable] | None
     plugin_settings: dict = {"plugins": defaultdict(dict)}
     skip_site_map: bool = False
+    metadata: dict = dict()
 
     @property
     def _title(self) -> str:

{render_engine-2025.11.1a1 → render_engine-2026.1.1a2}/src/render_engine/collection.py

@@ -1,7 +1,9 @@
 import copy
 import datetime
 import logging
+import os
 from collections.abc import Callable, Generator
+from multiprocessing.pool import ThreadPool
 from pathlib import Path
 from typing import Any
 
@@ -10,10 +12,9 @@ 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 .content_managers import ContentManager, FileContentManager
 from .feeds import RSSFeed
 from .page import Page
 from .plugins import PluginManager
@@ -245,6 +246,28 @@ class Collection(BaseObject):
     def __iter__(self):
         yield from self.content_manager
 
+    def __len__(self):
+        return len(self.content_manager)
+
+    @property
+    def all_content(self) -> Generator:
+        """All of the content that is associated with the Collection including Pages, Feed, and Archives"""
+        yield from self
+
+        if getattr(self, "has_archive", False):
+            for archive in self.archives:
+                yield archive
+                if archive.is_index:
+                    # In order to avoid collision with parallel processing we need to do a copy.
+                    # A deepcopy is not necessary because we only care about not overwriting the
+                    # slug on the original.
+                    index = copy.copy(archive)
+                    index.slug = "index"
+                    yield index
+
+        if feed := getattr(self, "feed", None):
+            yield feed
+
     def _run_collection_plugins(self, site, hook_type: str):
         """
         Run plugins for a collection
@@ -261,32 +284,28 @@ class Collection(BaseObject):
             return
         method(collection=self, site=site, settings=self.plugin_manager.plugin_settings)
 
-    def render(self) -> None:
-        """Iterate through Pages and Check for Collections and Feeds"""
+    def _render(self, entry):
+        """
+        Renders 1 entry in the Collection
 
-        for entry in self:
+        :param entry: The entry to process
+        """
+        if not isinstance(entry, RSSFeed) and not isinstance(entry, Archive):
             entry.plugin_manager = copy.deepcopy(self.plugin_manager)
 
-            for route in entry.routes:
-                entry.site = self.site
-                entry.render(route, self.site.theme_manager)
+        entry.site = self.site
+        entry.render(self.site.theme_manager)
 
-        if getattr(self, "has_archive", False):
-            for archive in self.archives:
-                archive.site = self.site
-                logging.debug("Adding Archive: %s", archive.__class__.__name__)
-
-                for _ in self.routes:
-                    archive.render(self.routes[0], self.site.theme_manager)
-
-                if archive.is_index:
-                    archive.slug = "index"
-                    archive.render(self.routes[0], self.site.theme_manager)
-        feed: RSSFeed
-        if hasattr(self, "Feed"):
-            feed = self.feed
-            feed.site = self.site
-            feed.render(route="./", theme_manager=self.site.theme_manager)
+    def render(self) -> None:
+        """Iterate through Pages and Check for Archives and Feeds"""
+
+        # Use a ThreadPool to process all of the entries in the collection in parallel.
+        # This is limited to the number of CPUs available. The easiest way to implement
+        # this parallelization for a single task is to use the imap_unordered method of
+        # the ThreadPool. This is, effectively, a generator so we need to loop over it
+        # for them to run. Since there is no actual return value to look at we just `pass`.
+        for entry in ThreadPool(processes=os.cpu_count()).imap_unordered(self._render, self.all_content):
+            pass
 
     def create_entry(
         self, filepath: Path = None, editor: str = None, content: str = None, metadata: dict = None

{render_engine-2025.11.1a1 → render_engine-2026.1.1a2}/src/render_engine/content_managers/base_content_manager.py

@@ -19,4 +19,21 @@ class ContentManager(ABC):
     @abstractmethod
     def create_entry(self, filepath: Path = None, editor: str = None, metadata: dict = None, content: str = None):
         """Create a new entry"""
-        ...
+        pass
+
+    def find_entry(self, **kwargs):
+        """
+        Find an entry
+
+        :param kwargs: List of attributes to search by
+        :return: Page if it was found otherwise None
+        """
+        for page in self:
+            if all(getattr(page, attr, None) == value for attr, value in kwargs.items()):
+                return page
+        return None
+
+    @abstractmethod
+    def update_entry(self, *, page, **kwargs):
+        """Update an entry"""
+        pass

{render_engine-2025.11.1a1 → render_engine-2026.1.1a2}/src/render_engine/content_managers/file_content_manager.py

@@ -36,8 +36,16 @@ class FileContentManager(ContentManager):
     def pages(self, value: Iterable):
         self._pages = value
 
+    def __len__(self):
+        return len(list(self.pages))
+
     def create_entry(
-        self, filepath: Path = None, editor: str = None, metadata: dict = None, content: str = None
+        self,
+        filepath: Path = None,
+        editor: str = None,
+        metadata: dict = None,
+        content: str = None,
+        update: bool = False,
     ) -> str:
         """
         Create a new entry for the Collection
@@ -46,12 +54,33 @@ class FileContentManager(ContentManager):
         :param editor: Editor to open to edit the entry.
         :param content: The content for the entry
         :param metadata: Metadata for the new entry
+        :param update: Allow overwriting the existing file
         """
         if not filepath:
             raise ValueError("filepath needs to be specified.")
 
+        if not update and filepath.exists():
+            raise RuntimeError(f"File at {filepath} exists and update is disabled.")
+
         parsed_content = self.collection.Parser.create_entry(content=content, **metadata)
         filepath.write_text(parsed_content)
         if editor:
             subprocess.run([editor, filepath])
         return f"New entry created at {filepath} ."
+
+    def update_entry(self, page, *, content: str = None, **kwargs) -> str:
+        """
+        Update an entry
+
+        :param page: Page object to update
+        :param content: Content for the updated page
+        :param kwargs: Attributes to be included in the updated page
+        :return: String indicating that the page was updated.
+        """
+        self.create_entry(filepath=page.content_path, metadata=kwargs, content=content, update=True)
+        if self._pages:
+            self._pages = [
+                existing_page for existing_page in self._pages if page.content_path != existing_page.content_path
+            ]
+            self._pages.append(self.collection.get_page(page.content_path))
+        return f"Entry at {page.content_path} updated."