render-engine 2025.10.3a1__tar.gz → 2025.11.1__tar.gz

{render_engine-2025.10.3a1 → render_engine-2025.11.1}/.gitignore

@@ -166,3 +166,5 @@ untitled-site/
 
 .DS_Store
 .python-version
+
+__version__.py

{render_engine-2025.10.3a1 → render_engine-2025.11.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: render_engine
-Version: 2025.10.3a1
+Version: 2025.11.1
 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.3a1 → render_engine-2025.11.1}/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-2025.11.1/docs/docs/content_manager.md

@@ -0,0 +1,67 @@
+---
+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.

{render_engine-2025.10.3a1 → render_engine-2025.11.1}/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.10.3a1 → render_engine-2025.11.1}/pyproject.toml

@@ -42,9 +42,9 @@ dev = [
   "watchfiles",
 ]
 
-
 [tool.setuptools_scm]
 local_scheme = "no-local-version"
+version_file = "src/render_engine/__version__.py"
 # version_scheme = "python-simplified-semver"
 
 [project.urls]

render_engine-2025.11.1/src/render_engine/__version__.py

@@ -0,0 +1,34 @@
+# file generated by setuptools-scm
+# don't change, don't track in version control
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple
+    from typing import Union
+
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+    COMMIT_ID = Union[str, None]
+else:
+    VERSION_TUPLE = object
+    COMMIT_ID = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+commit_id: COMMIT_ID
+__commit_id__: COMMIT_ID
+
+__version__ = version = '2025.11.1'
+__version_tuple__ = version_tuple = (2025, 11, 1)
+
+__commit_id__ = commit_id = 'g3ef9c0acb'

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

@@ -288,6 +288,24 @@ class Collection(BaseObject):
             feed.site = self.site
             feed.render(route="./", theme_manager=self.site.theme_manager)
 
+    def create_entry(
+        self, filepath: Path = None, editor: str = None, content: str = None, metadata: dict = None
+    ) -> str:
+        """
+        Create a new entry for the Collection
+
+        :param filepath: Path object for the new entry
+        :param editor: Editor to open to edit the entry.
+        :param content: Content for the new entry
+        :param metadata: Metadata for the new entry
+        """
+        context = copy.deepcopy(self._metadata_attrs())
+        if metadata:
+            context.update(metadata)
+        return self.content_manager.create_entry(
+            filepath=filepath, editor=editor, metadata=context, content=content or "Hello, world!"
+        )
+
 
 def render_archives(archive, **kwargs) -> list[Archive]:
     return [archive.render(pages=archive.pages, **kwargs) for archive in archive]

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

@@ -1,5 +1,6 @@
 from abc import ABC, abstractmethod
 from collections.abc import Generator, Iterable
+from pathlib import Path
 
 
 class ContentManager(ABC):
@@ -14,3 +15,8 @@ class ContentManager(ABC):
     def __iter__(self) -> Generator:
         """Iterator for the ContentManager"""
         yield from self.pages
+
+    @abstractmethod
+    def create_entry(self, filepath: Path = None, editor: str = None, metadata: dict = None, content: str = None):
+        """Create a new entry"""
+        ...

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

@@ -1,3 +1,4 @@
+import subprocess
 from collections.abc import Iterable
 from pathlib import Path
 
@@ -34,3 +35,23 @@ class FileContentManager(ContentManager):
     @pages.setter
     def pages(self, value: Iterable):
         self._pages = value
+
+    def create_entry(
+        self, filepath: Path = None, editor: str = None, metadata: dict = None, content: str = None
+    ) -> str:
+        """
+        Create a new entry for the Collection
+
+        :param filepath: Path object for the new entry
+        :param editor: Editor to open to edit the entry.
+        :param content: The content for the entry
+        :param metadata: Metadata for the new entry
+        """
+        if not filepath:
+            raise ValueError("filepath needs to be specified.")
+
+        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} ."

{render_engine-2025.10.3a1 → render_engine-2025.11.1}/src/render_engine/site.py

@@ -3,6 +3,7 @@ import logging
 from collections import defaultdict
 from pathlib import Path
 
+import rich
 from jinja2 import FileSystemLoader, PrefixLoader
 from rich.progress import Progress
 
@@ -13,6 +14,12 @@ from .plugins import PluginManager, handle_plugin_registration
 from .site_map import SiteMap
 from .themes import Theme, ThemeManager
 
+try:
+    # Get the RE version for display. If it's not set it means we're working locally.
+    from render_engine.__version__ import __version__ as re_version
+except ImportError:
+    re_version = "development"
+
 
 class Site:
     """
@@ -251,7 +258,10 @@ class Site:
         You can choose to call it manually in your file or
         use the CLI command [`render-engine build`][src.render_engine.cli.build]
         """
-
+        rich.print(
+            f"[green]Building {repr(self.site_vars.get('SITE_TITLE', 'your site'))} "
+            f"with Render Engine version {re_version}"
+        )
         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", ""))

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

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

@@ -34,6 +34,7 @@ docs/requirements.txt
 docs/docs/archive.md
 docs/docs/cli.md
 docs/docs/collection.md
+docs/docs/content_manager.md
 docs/docs/custom_collections.md
 docs/docs/feeds.md
 docs/docs/index.md
@@ -63,6 +64,7 @@ docs/docs/getting-started/layout.md
 src/render_engine/.gitignore
 src/render_engine/__init__.py
 src/render_engine/__main__.py
+src/render_engine/__version__.py
 src/render_engine/_base_object.py
 src/render_engine/archive.py
 src/render_engine/blog.py

{render_engine-2025.10.3a1 → render_engine-2025.11.1}/tests/test_collections.py

@@ -1,4 +1,5 @@
 import pathlib
+import textwrap
 
 import pluggy
 import pytest
@@ -360,3 +361,58 @@ def test_collection_custom_sort_by_list_with_date():
 
     # Verify the sorted order by checking custom_sort_content values
     assert [page.custom_sort_content for page in sorted_pages] == [page.custom_sort_content for page in expected_pages]
+
+
+@pytest.mark.parametrize(
+    "content, context, expected",
+    [
+        (
+            "",
+            {"title": "title"},
+            textwrap.dedent("""---
+title: title
+---
+
+Hello, world!"""),
+        ),
+        (
+            "test",
+            {},
+            textwrap.dedent("""---
+title: Untitled Entry
+---
+
+test"""),
+        ),
+        (
+            "",
+            {},
+            textwrap.dedent("""---
+title: Untitled Entry
+---
+
+Hello, world!"""),
+        ),
+    ],
+)
+def test_create_entry(tmp_path: pathlib.Path, content, context, expected):
+    """Test the create_entry method"""
+    tmp_dir = tmp_path / "content"
+    tmp_dir.mkdir()
+
+    class BasicCollection(Collection):
+        content_path = tmp_dir.absolute()
+
+    filename = "test.md"
+    filepath = tmp_dir / filename
+    assert str(filepath) in BasicCollection().create_entry(
+        filepath=filepath, editor=None, content=content, metadata=context
+    )
+    assert filepath.read_text().strip() == expected
+
+
+def test_create_entry_no_filename():
+    """Test create_entry with no filename raises an exception"""
+    # Since the base Collection object uses a FileContentManager
+    with pytest.raises(ValueError):
+        Collection().create_entry()