render-engine 2026.3.4a2__tar.gz → 2026.3.4a3__tar.gz

render_engine-2026.3.4a3/.github/workflows/todos.yml

@@ -0,0 +1,89 @@
+name: "TODO to Issue"
+
+on:
+  pull_request:
+    types: [opened, synchronize, labeled]
+    branches: [main]
+
+jobs:
+  detect-todos:
+    if: github.event.action == 'opened' || github.event.action == 'synchronize'
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+
+      - name: Check diff for TODOs
+        id: check
+        run: |
+          if git diff origin/main...HEAD | grep -q '^\+.*# *TODO'; then
+            echo "found=true" >> "$GITHUB_OUTPUT"
+          else
+            echo "found=false" >> "$GITHUB_OUTPUT"
+          fi
+
+      - name: Comment on PR
+        if: steps.check.outputs.found == 'true'
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const { data: comments } = await github.rest.issues.listComments({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              issue_number: context.payload.pull_request.number,
+            });
+            const marker = '<!-- todo-to-issue-bot -->';
+            if (comments.some(c => c.body.includes(marker))) return;
+
+            await github.rest.issues.createComment({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              issue_number: context.payload.pull_request.number,
+              body: `${marker}\nThis PR contains \`TODO\` comments. A maintainer can add the **todo-to-issue** label to automatically create GitHub issues and link them in the code.`
+            });
+
+  create-issues:
+    if: github.event.action == 'labeled' && github.event.label.name == 'todo-to-issue'
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      issues: write
+      pull-requests: write
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          ref: ${{ github.head_ref }}
+          fetch-depth: 0
+
+      - name: TODO to Issue
+        uses: alstr/todo-to-issue-action@v5
+        with:
+          INSERT_ISSUE_URLS: "true"
+          CLOSES_ISSUE: "true"
+
+      - name: Commit and push issue URLs
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git add -A
+          if [[ `git status --porcelain` ]]; then
+            git commit -m "Automatically added GitHub issue links to TODOs"
+            git push origin HEAD:${{ github.head_ref }}
+          else
+            echo "No changes to commit"
+          fi
+
+      - name: Remove label
+        if: always()
+        uses: actions/github-script@v7
+        with:
+          script: |
+            await github.rest.issues.removeLabel({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              issue_number: context.payload.pull_request.number,
+              name: 'todo-to-issue'
+            });

{render_engine-2026.3.4a2 → render_engine-2026.3.4a3}/.gitignore

@@ -168,3 +168,4 @@ untitled-site/
 .python-version
 
 __version__.py
+.worktress

{render_engine-2026.3.4a2 → render_engine-2026.3.4a3}/.pre-commit-config.yaml

@@ -26,6 +26,10 @@ repos:
   rev: v0.6.0
   hooks:
     - id: markdownlint-cli2
+- repo: https://github.com/kjaymiller/pin-versions
+  rev: 2026.3.6
+  hooks:
+    - id: pin-versions
 - repo: local
   hooks:
     - id: deptry

{render_engine-2026.3.4a2 → render_engine-2026.3.4a3}/PKG-INFO

@@ -1,24 +1,24 @@
 Metadata-Version: 2.4
 Name: render_engine
-Version: 2026.3.4a2
+Version: 2026.3.4a3
 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/
 Project-URL: documentation, https://render-engine.readthedocs.io/en/latest/
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
-Requires-Dist: jinja2
-Requires-Dist: more-itertools
-Requires-Dist: pluggy
-Requires-Dist: python-dateutil
-Requires-Dist: python-slugify
-Requires-Dist: render-engine-parser
-Requires-Dist: render-engine-markdown
-Requires-Dist: rich
+Requires-Dist: jinja2==3.1.6
+Requires-Dist: more-itertools==10.8.0
+Requires-Dist: pluggy==1.6.0
+Requires-Dist: python-dateutil==2.9.0.post0
+Requires-Dist: python-frontmatter==1.1.0
+Requires-Dist: python-slugify==8.0.4
+Requires-Dist: render-engine-markdown==2023.12.1
+Requires-Dist: rich==14.3.1
 Provides-Extra: cli
-Requires-Dist: render-engine-cli; extra == "cli"
+Requires-Dist: render-engine-cli==2025.11.1; extra == "cli"
 Provides-Extra: extras
-Requires-Dist: render-engine-sitemap; extra == "extras"
+Requires-Dist: render-engine-sitemap==2024.1.1a1; extra == "extras"
 
 <!-- markdownlint-disable -->
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
@@ -51,10 +51,10 @@ Requires-Dist: render-engine-sitemap; extra == "extras"
 
 ## Installing Render Engine
 
-To use the render engine, you must have Python 3.10 or greater installed. You can download Python from [python.org][python].
+To use the render engine, you must have Python 3.10 or greater installed. You can download Python from [python.org].
 
-- Linux/MacOS: [python.org][python]
-- Windows: [Microsoft Store][ms-store]
+- Linux/MacOS: [python.org]
+- Windows: Install Python using [pymanager on Microsoft Store][ms-store], which manages Python installations.
 
 Render Engine is available in PyPI and can be installed using pip:
 
@@ -131,13 +131,13 @@ Thank you to them and all of those who continue to support this project!
 
 [pytest-badge]: https://github.com/kjaymiller/render_engine/actions/workflows/test.yml/badge.svg
 [pytest-action]: https://github.com/kjaymiller/render_engine/actions/workflows/test.yml
-[coverage-badge]: ./coverage-badge.svg
+[coverage-badge]: https://raw.githubusercontent.com/render-engine/render-engine/refs/heads/main/coverage-badge.svg
 [discord-badge]: https://img.shields.io/discord/1174377880118104156?label=Discord&color=purple
 [discord-link]: https://discord.gg/2xMQ4j4d8m
 [docs]: https://render-engine.readthedocs.io/en/latest/
 [wiki]: https://github.com/render-engine/render-engine/wiki
-[python]: https://python.org
-[ms-store]: https://apps.microsoft.com/store/detail/python-311/9NRWMJP3717K
+[python.org]: https://python.org
+[ms-store]: https://apps.microsoft.com/detail/9NQ7512CXL7T
 [getting-started]: https://render-engine.readthedocs.io/en/latest/page/
 [bdougie]: https://github.com/bdougie
 [contributing]: https://render-engine.readthedocs.io/en/latest/contributing/CONTRIBUTING/

{render_engine-2026.3.4a2 → render_engine-2026.3.4a3}/README.md

@@ -29,10 +29,10 @@
 
 ## Installing Render Engine
 
-To use the render engine, you must have Python 3.10 or greater installed. You can download Python from [python.org][python].
+To use the render engine, you must have Python 3.10 or greater installed. You can download Python from [python.org].
 
-- Linux/MacOS: [python.org][python]
-- Windows: [Microsoft Store][ms-store]
+- Linux/MacOS: [python.org]
+- Windows: Install Python using [pymanager on Microsoft Store][ms-store], which manages Python installations.
 
 Render Engine is available in PyPI and can be installed using pip:
 
@@ -109,13 +109,13 @@ Thank you to them and all of those who continue to support this project!
 
 [pytest-badge]: https://github.com/kjaymiller/render_engine/actions/workflows/test.yml/badge.svg
 [pytest-action]: https://github.com/kjaymiller/render_engine/actions/workflows/test.yml
-[coverage-badge]: ./coverage-badge.svg
+[coverage-badge]: https://raw.githubusercontent.com/render-engine/render-engine/refs/heads/main/coverage-badge.svg
 [discord-badge]: https://img.shields.io/discord/1174377880118104156?label=Discord&color=purple
 [discord-link]: https://discord.gg/2xMQ4j4d8m
 [docs]: https://render-engine.readthedocs.io/en/latest/
 [wiki]: https://github.com/render-engine/render-engine/wiki
-[python]: https://python.org
-[ms-store]: https://apps.microsoft.com/store/detail/python-311/9NRWMJP3717K
+[python.org]: https://python.org
+[ms-store]: https://apps.microsoft.com/detail/9NQ7512CXL7T
 [getting-started]: https://render-engine.readthedocs.io/en/latest/page/
 [bdougie]: https://github.com/bdougie
 [contributing]: https://render-engine.readthedocs.io/en/latest/contributing/CONTRIBUTING/

{render_engine-2026.3.4a2 → render_engine-2026.3.4a3}/docs/docs/contributing/CONTRIBUTING.md

@@ -77,9 +77,17 @@ all supported versions.
 
 ## TODOs
 
-Todos are not encouraged all the time but if necessary please indicate any todos with the `# TODO Prefix`.
-We use [todo-to-issue] as a github action that will create issues for any TODOs that are created.
-This will modify your code with the issue number and link to the TODO in the comments.
+Todos are not encouraged all the time but if necessary please indicate any todos with the `# TODO` prefix.
+We use [todo-to-issue] as a GitHub Action to create issues from TODOs.
+
+When a PR containing `# TODO` comments is opened, a bot will comment suggesting a maintainer
+add the **todo-to-issue** label. Once a maintainer adds the label, the action will:
+
+1. Create GitHub issues for each TODO
+2. Update the TODO comments in your code with the issue number and link
+3. Commit the changes back to your PR branch
+
+The label is removed automatically afterward and can be re-applied if new TODOs are added.
 
 ## Contributing to Documentation
 

{render_engine-2026.3.4a2 → render_engine-2026.3.4a3}/docs/docs/contributing/testing.md

@@ -60,6 +60,14 @@ To run the lint and format together:
 just ruff
 ```
 
+#### Using just for linting Markdown
+
+```bash
+just lint-md
+```
+
+**NOTE** running the markdown lint requires [bun].
+
 #### Using uvx for linting and formatting
 
 ```bash
@@ -69,3 +77,4 @@ uvx ruff check .
 ```
 
 [typechecking]: /contributing/typechecking/
+[bun]: https://bun.com/docs

{render_engine-2026.3.4a2 → render_engine-2026.3.4a3}/docs/docs/getting-started/building-your-site.md

@@ -38,6 +38,5 @@ render-engine build app:app
 
 Your site will be generated in the `output` folder.
 
-[cli-build]: ../cli.md#building-your-site-with-render-engine-build
-
+[cli-build]: ../cli/docs/cli.md#building-your-site-with-render-engine-build
 [layout]: layout.md

{render_engine-2026.3.4a2 → render_engine-2026.3.4a3}/docs/docs/getting-started/creating-your-app.md

@@ -30,6 +30,6 @@ Visit the [CLI - init] page for more information.
 
 ### Continue to [Simple Site Layout]
 
-[cli - init]: ../cli.md
+[cli - init]: ../cli/docs/cli.md
 [render-engine init --help]: ../assets/render-engine-init-help.png
 [simple site layout]: layout.md

{render_engine-2026.3.4a2 → render_engine-2026.3.4a3}/docs/docs/getting-started/installation.md

@@ -5,10 +5,10 @@ date: August 22, 2024
 tags: ["installation", "render-engine"]
 ---
 
-In order to use render engine, you must have python 3.10 installed. You can download python from [python.org].
+To use the render engine, you must have Python 3.10 or greater installed. You can download Python from [python.org].
 
 - Linux/MacOS: [python.org]
-- Windows: [Microsoft Store]
+- Windows: Install Python using [pymanager on Microsoft Store][ms-store], which manages Python installations.
 
 Render Engine is available in PyPI and can be installed using pip:
 
@@ -35,5 +35,5 @@ pip install render-engine render-engine-rss
 [render-engine-rss]: https://pypi.org/project/render-engine-rss/
 
 [creating your app]: creating-your-app.md
-[microsoft store]: https://apps.microsoft.com/store/detail/python-311/9NRWMJP3717K
+[ms-store]: https://apps.microsoft.com/detail/9NQ7512CXL7T
 [python.org]: https://python.org

{render_engine-2026.3.4a2 → render_engine-2026.3.4a3}/docs/docs/index.md

@@ -16,10 +16,10 @@ tags:
 
 ### Installing Render Engine
 
-In order to use render engine, you must have python 3.10 installed. You can download python from [python.org].
+To use the render engine, you must have Python 3.10 or greater installed. You can download Python from [python.org].
 
 - Linux/MacOS: [python.org]
-- Windows: [Microsoft Store]
+- Windows: Install Python using [pymanager on Microsoft Store][ms-store], which manages Python installations.
 
 Render Engine is available in PyPI and can be installed using pip:
 
@@ -39,7 +39,7 @@ Check out the [Getting Started].
 
 [collection]: collection.md
 [getting started]: ./getting-started/getting-started.md
-[microsoft store]: https://apps.microsoft.com/store/detail/python-311/9NRWMJP3717K
+[ms-store]: https://apps.microsoft.com/detail/9NQ7512CXL7T
 [page]: page.md
 [python.org]: https://python.org
 [site]: site.md

{render_engine-2026.3.4a2 → render_engine-2026.3.4a3}/docs/mkdocs.yml

@@ -35,7 +35,7 @@ nav:
     - Plugins: plugins.md
     - Content Managers: content_manager.md
   - Parsers: parsers.md
-  - CLI: cli.md
+  - CLI: cli/docs/cli.md
   - Templates and Themes:
     - Templates: templates.md
     - ThemeManager: theme_management.md
@@ -62,3 +62,10 @@ plugins:
           show_source: false
           show_root_full_path: false
           show_category_heading: true
+- multirepo:
+    # (optional) tells multirepo to cleanup the temporary directory after site is built.
+    cleanup: true
+    nav_repos:
+      - name: CLI
+        import_url: https://github.com/render-engine/render-engine-cli?branch=main
+        imports: [/docs/cli.md]

{render_engine-2026.3.4a2 → render_engine-2026.3.4a3}/justfile

@@ -27,6 +27,18 @@ test-cov-report REPORT='xml':
 nox:
     uvx nox
 
+# Run markdown linter (requires bun or npm)
+lint-md DIRECTORY=".":
+    #!/usr/bin/env sh
+    if command -v bun > /dev/null 2>&1; then
+        bunx markdownlint-cli2 {{ DIRECTORY }}
+    elif command -v npm > /dev/null 2>&1; then
+        npx markdownlint-cli2 {{ DIRECTORY }}
+    else
+        echo "Error: neither bun nor npm found. Install one of them to run markdown linting." >&2
+        exit 1
+    fi
+
 # Run ruff linter without fixing
 lint DIRECTORY='.':
     uvx ruff check {{ DIRECTORY }}

{render_engine-2026.3.4a2 → render_engine-2026.3.4a3}/pyproject.toml

@@ -9,37 +9,40 @@ description = "A Flexible Static Site Generator for Python"
 readme = "README.md"
 requires-python = ">=3.10"
 dependencies = [
-  "jinja2",
-  "more-itertools",
-  "pluggy",
-  "python-dateutil",
-  "python-slugify",
-  "render-engine-parser",
-  "render-engine-markdown",
-  "rich",
+  "jinja2==3.1.6",
+  "more-itertools==10.8.0",
+  "pluggy==1.6.0",
+  "python-dateutil==2.9.0.post0",
+  "python-frontmatter==1.1.0",
+  "python-slugify==8.0.4",
+  "render-engine-markdown==2023.12.1",
+  "rich==14.3.1",
 ]
 
 [project.optional-dependencies]
-cli = ["render-engine-cli"]
-extras = ["render-engine-sitemap"]
+cli = ["render-engine-cli==2025.11.1"]
+extras = ["render-engine-sitemap==2024.1.1a1"]
 
 [dependency-groups]
 dev = [
-  "ephemeral-port-reserve",
+  "ephemeral-port-reserve==1.1.4",
   "deptry>=0.24.0",
-  "httpx",
-  "ty",
-  "pre-commit",
-  "pytest",
-  "pytest-cov",
-  "pytest-mock",
-  "toml",
+  "httpx==0.28.1",
+  # TODO: Update typing with new versions in 0.0.24
+  # Issue URL: https://github.com/render-engine/render-engine/issues/1142
+  "ty==0.0.14",
+  "pre-commit==4.5.1",
+  "pytest==9.0.2",
+  "pytest-cov==7.0.0",
+  "pytest-mock==3.15.1",
+  "toml==0.10.2",
 ]
 docs = [
-  "mkdocs",
-  "mkdocs-material",
-  "mkdocstrings[python]",
-  "pymdown-extensions",
+  "mkdocs==1.6.1",
+  "mkdocs-material==9.7.6",
+  "mkdocs-multirepo-plugin==0.8.3",
+  "mkdocstrings[python]==1.0.3",
+  "pymdown-extensions==10.21",
 ]
 
 [tool.setuptools_scm]

{render_engine-2026.3.4a2 → render_engine-2026.3.4a3}/src/render_engine/__init__.py

@@ -2,6 +2,7 @@ from .blog import Blog
 from .collection import Collection
 from .data_object import DataObject
 from .page import Page
+from .parsers import BasePageParser
 from .site import Site
 
-__all__ = ["Blog", "Collection", "Page", "Site", "DataObject"]
+__all__ = ["Blog", "Collection", "Page", "Site", "DataObject", "BasePageParser"]

{render_engine-2026.3.4a2 → render_engine-2026.3.4a3}/src/render_engine/__version__.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '2026.3.4a2'
-__version_tuple__ = version_tuple = (2026, 3, 4, 'a2')
+__version__ = version = '2026.3.4a3'
+__version_tuple__ = version_tuple = (2026, 3, 4, 'a3')
 
-__commit_id__ = commit_id = 'g3cd8897ad'
+__commit_id__ = commit_id = 'gbcfaed3c8'

{render_engine-2026.3.4a2 → render_engine-2026.3.4a3}/src/render_engine/collection.py

@@ -9,7 +9,6 @@ from typing import Any, cast
 
 import dateutil.parser as dateparse
 from more_itertools import batched
-from render_engine_parser import BasePageParser
 from slugify import slugify
 
 from ._base_object import BaseObject
@@ -17,6 +16,7 @@ from .archive import Archive
 from .content_managers import ContentManager, FileContentManager
 from .feeds import RSSFeed
 from .page import Page
+from .parsers import BasePageParser
 from .plugins import PluginManager
 
 

{render_engine-2026.3.4a2 → render_engine-2026.3.4a3}/src/render_engine/feeds.py

@@ -2,9 +2,8 @@
 Feed Objects for Generating RSS Feeds
 """
 
-from render_engine_parser import BasePageParser
-
 from .page import BasePage
+from .parsers import BasePageParser
 
 
 class RSSFeed(BasePage):

{render_engine-2026.3.4a2 → render_engine-2026.3.4a3}/src/render_engine/page.py

@@ -4,11 +4,11 @@ from pathlib import Path
 from typing import Any, cast
 
 from jinja2 import Environment, Template
-from render_engine_parser.base_parsers import BasePageParser
 
 from render_engine.themes import ThemeManager
 
 from ._base_object import BaseObject
+from .parsers import BasePageParser
 from .plugins import PluginManager
 
 logger = logging.getLogger("Page")
@@ -85,9 +85,11 @@ class BasePage(BaseObject):
         :param **kwargs: Data to pass into the template for rendering.
         :return: The rendered page
         """
+
         template_data = {"data": self._data, "content": self._content}
         if site := getattr(self, "site", None):
             template_data["site_map"] = site.site_map
+
         if not self.no_prerender and isinstance(self._content, str) and re.search(r"{{.*?site_map.*?}}", self._content):
             # If the content looks like a template, try to render it.
             try:
@@ -237,14 +239,14 @@ class Page(BasePage):
 
         # Parse Content from the Content Path or the Content
         if content_path := (content_path or getattr(self, "content_path", None)):
-            self.metadata, self.content = self.Parser.parse_content_path(str(content_path))
+            self.metadata, self.content = self.Parser.parse_content_path(content_path)
 
         elif content := (content or getattr(self, "content", None)):
             self.metadata, self.content = self.Parser.parse_content(content)
 
         else:
             self.metadata = {}
-            self.content = None
+            self.content = ""
 
         # Set the attributes
         for key, val in self.metadata.items():
@@ -260,4 +262,7 @@ class Page(BasePage):
         Returns:
             Any: The parsed content of the page.
         """
-        return self.Parser.parse(self.content, extras=getattr(self, "parser_extras", {}))
+        content = getattr(self, "content", None)
+        if content:
+            return self.Parser.parse(content, extras=getattr(self, "parser_extras", {}))
+        return content

render_engine-2026.3.4a3/src/render_engine/parsers/__init__.py

@@ -0,0 +1,3 @@
+from .base_parsers import BasePageParser
+
+__all__ = ["BasePageParser"]

render_engine-2026.3.4a3/src/render_engine/parsers/base_parsers.py

@@ -0,0 +1,76 @@
+import pathlib
+from typing import Any
+
+import frontmatter
+
+
+def parse_content(content: str) -> tuple[dict, str]:
+    """Fetching content and atttributes from a content_path"""
+    p = frontmatter.parse(content)
+    return p
+
+
+class BasePageParser:
+    """
+    The default Parser for Page objects.
+    This yields attributes and content using frontmatter.
+    The content is not modified.
+    """
+
+    @staticmethod
+    def parse_content_path(content_path: str | pathlib.Path) -> tuple[dict, str]:
+        """
+        Fetches content from `Page.content_path` and sets attributes.
+
+        This is a separate method so that it can be overridden by subclasses.
+
+        params:
+            content_path:
+                The path to the file that will be used to generate the Page's `content`.
+                Should be a valid path to a file or a url.
+        """
+        return parse_content(pathlib.Path(content_path).read_text())
+
+    @staticmethod
+    def parse_content(content: str) -> tuple[dict, str]:
+        """
+        Fetches content from `Page.content` and returns attributes and content.
+
+        This is a separate method so that it can be overridden by subclasses.
+
+        params:
+            content:
+                The path to the file that will be used to generate the Page's `content`.
+                Should be a valid path to a file or a url.
+        """
+
+        return parse_content(content)
+
+    @staticmethod
+    def parse(
+        content: str,
+        extras: dict[str, Any] | None = None,
+    ) -> str:
+        """
+        Parses content to be rendered into HTML
+
+        In the base parser, this returns the content as is.
+
+        params:
+            content: content to be rendered into HTML
+            extras: dictionary with extras to augment attributes
+        """
+        return content
+
+    @staticmethod
+    def create_entry(*, content: str = "Hello World", **kwargs) -> str:
+        """
+        Writes the content type that would be parsed to the content_path.
+        """
+
+        post = frontmatter.Post(content)
+
+        for key, val in kwargs.items():
+            post[key] = val
+
+        return frontmatter.dumps(post)