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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (123) hide show
  1. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/PKG-INFO +1 -1
  2. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/docs/docs/collection.md +1 -2
  3. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/docs/mkdocs.yml +0 -1
  4. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/src/render_engine/__version__.py +3 -3
  5. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/src/render_engine.egg-info/PKG-INFO +1 -1
  6. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/src/render_engine.egg-info/SOURCES.txt +0 -1
  7. render_engine-2025.11.1/docs/docs/content_manager.md +0 -67
  8. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/.all-contributorsrc +0 -0
  9. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/.devcontainer/Dockerfile +0 -0
  10. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/.devcontainer/devcontainer.json +0 -0
  11. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/.devcontainer/setup.sh +0 -0
  12. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/.github/FUNDING.yml +0 -0
  13. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/.github/ISSUE_TEMPLATE/config.yaml +0 -0
  14. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/.github/ISSUE_TEMPLATE/form_issue_template.yml +0 -0
  15. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/.github/PULL_REQUEST_TEMPLATE.md +0 -0
  16. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/.github/dependabot-bot.yml +0 -0
  17. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/.github/dependabot.yml +0 -0
  18. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/.github/labeler.yml +0 -0
  19. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/.github/release.yml +0 -0
  20. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/.github/workflows/devcontainer-ci.yml +0 -0
  21. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/.github/workflows/labeler.yml +0 -0
  22. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/.github/workflows/lint.yml +0 -0
  23. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/.github/workflows/publish.yml +0 -0
  24. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/.github/workflows/scorecard.yml +0 -0
  25. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/.github/workflows/test.yml +0 -0
  26. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/.gitignore +0 -0
  27. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/.markdownlint.json +0 -0
  28. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/.pre-commit-config.yaml +0 -0
  29. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/.readthedocs.yml +0 -0
  30. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/.vscode/tasks.json +0 -0
  31. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/CONTRIBUTING.md +0 -0
  32. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/README.md +0 -0
  33. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/SECURITY.md +0 -0
  34. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/docs/.markdownlint.json +0 -0
  35. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/docs/docs/archive.md +0 -0
  36. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/docs/docs/assets/create environment vs code.gif +0 -0
  37. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/docs/docs/assets/create-app-help.png +0 -0
  38. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/docs/docs/assets/create-codespace.gif +0 -0
  39. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/docs/docs/assets/launching a dev container.gif +0 -0
  40. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/docs/docs/assets/render-engine-init-help.png +0 -0
  41. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/docs/docs/assets/render-engine-init.png +0 -0
  42. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/docs/docs/cli.md +0 -0
  43. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/docs/docs/contributing/CODE_OF_CONDUCT.md +0 -0
  44. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/docs/docs/contributing/CONTRIBUTING.md +0 -0
  45. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/docs/docs/contributing/environment_setup.md +0 -0
  46. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/docs/docs/custom_collections.md +0 -0
  47. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/docs/docs/feeds.md +0 -0
  48. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/docs/docs/getting-started/building-your-site.md +0 -0
  49. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/docs/docs/getting-started/creating-a-collection.md +0 -0
  50. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/docs/docs/getting-started/creating-a-page.md +0 -0
  51. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/docs/docs/getting-started/creating-your-app.md +0 -0
  52. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/docs/docs/getting-started/getting-started.md +0 -0
  53. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/docs/docs/getting-started/installation.md +0 -0
  54. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/docs/docs/getting-started/layout.md +0 -0
  55. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/docs/docs/index.md +0 -0
  56. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/docs/docs/page.md +0 -0
  57. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/docs/docs/parsers.md +0 -0
  58. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/docs/docs/plugins.md +0 -0
  59. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/docs/docs/site.md +0 -0
  60. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/docs/docs/site_map.md +0 -0
  61. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/docs/docs/templates.md +0 -0
  62. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/docs/docs/theme_management.md +0 -0
  63. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/docs/requirements.txt +0 -0
  64. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/noxfile.py +0 -0
  65. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/pyproject.toml +0 -0
  66. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/requirements.txt +0 -0
  67. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/setup.cfg +0 -0
  68. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/src/render_engine/.gitignore +0 -0
  69. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/src/render_engine/__init__.py +0 -0
  70. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/src/render_engine/__main__.py +0 -0
  71. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/src/render_engine/_base_object.py +0 -0
  72. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/src/render_engine/archive.py +0 -0
  73. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/src/render_engine/blog.py +0 -0
  74. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/src/render_engine/collection.py +0 -0
  75. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/src/render_engine/content_managers/__init__.py +0 -0
  76. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/src/render_engine/content_managers/base_content_manager.py +0 -0
  77. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/src/render_engine/content_managers/file_content_manager.py +0 -0
  78. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/src/render_engine/engine.py +0 -0
  79. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/src/render_engine/extras/__init__.py +0 -0
  80. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/src/render_engine/feeds.py +0 -0
  81. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/src/render_engine/hookspecs.py +0 -0
  82. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/src/render_engine/links.py +0 -0
  83. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/src/render_engine/page.py +0 -0
  84. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/src/render_engine/parsers/markdown.py +0 -0
  85. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/src/render_engine/plugins.py +0 -0
  86. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/src/render_engine/py.typed +0 -0
  87. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/src/render_engine/render_engine_templates/__init__.py +0 -0
  88. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/src/render_engine/render_engine_templates/archive.html +0 -0
  89. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/src/render_engine/render_engine_templates/base.html +0 -0
  90. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/src/render_engine/render_engine_templates/base_collection_path.md +0 -0
  91. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/src/render_engine/render_engine_templates/base_templates/_archive.html +0 -0
  92. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/src/render_engine/render_engine_templates/base_templates/_base.html +0 -0
  93. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/src/render_engine/render_engine_templates/base_templates/_page.html +0 -0
  94. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/src/render_engine/render_engine_templates/components/footer.html +0 -0
  95. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/src/render_engine/render_engine_templates/components/page_title.html +0 -0
  96. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/src/render_engine/render_engine_templates/page.html +0 -0
  97. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/src/render_engine/render_engine_templates/rss2.0.xml +0 -0
  98. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/src/render_engine/render_engine_templates/rss2.0_items.xml +0 -0
  99. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/src/render_engine/render_engine_templates/sitemap.xml +0 -0
  100. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/src/render_engine/render_engine_templates/sitemap_item.xml +0 -0
  101. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/src/render_engine/site.py +0 -0
  102. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/src/render_engine/site_map.py +0 -0
  103. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/src/render_engine/themes.py +0 -0
  104. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/src/render_engine/utils/__init__.py +0 -0
  105. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/src/render_engine.egg-info/dependency_links.txt +0 -0
  106. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/src/render_engine.egg-info/requires.txt +0 -0
  107. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/src/render_engine.egg-info/top_level.txt +0 -0
  108. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/tests/conftest.py +0 -0
  109. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/tests/test_archive.py +0 -0
  110. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/tests/test_base_object.py +0 -0
  111. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/tests/test_blog.py +0 -0
  112. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/tests/test_collections.py +0 -0
  113. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/tests/test_engine.py +0 -0
  114. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/tests/test_feeds/conftest_feed.py +0 -0
  115. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/tests/test_feeds/test_feeds.py +0 -0
  116. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/tests/test_page.py +0 -0
  117. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/tests/test_parsers_remove_2024_3_1.py +0 -0
  118. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/tests/test_plugins.py +0 -0
  119. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/tests/test_site.py +0 -0
  120. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/tests/test_site_map.py +0 -0
  121. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/tests/test_templates/test_base_html.py +0 -0
  122. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/tests/test_theme_manager.py +0 -0
  123. {render_engine-2025.11.1 → render_engine-2025.11.1a1}/uv.lock +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: render_engine
3
- Version: 2025.11.1
3
+ Version: 2025.11.1a1
4
4
  Summary: A Flexible Static Site Generator for Python
5
5
  Project-URL: homepage, https://github.com/render-engine/render-engine/
6
6
  Project-URL: repository, https://github.com/render-engine/render-engine/
@@ -46,8 +46,7 @@ sort_reverse: bool = False
46
46
  title: str
47
47
  template: str | None
48
48
  archive_template str | None: The template to use for the archive pages.
49
- ContentManager: type[ContentManager] | None = FileContentManager: The `ContentManager` to use.
50
- content_manager_extras: dict[str, Any]: Configuration options to send to the `ContentManager` during instantiation.
49
+ skip_site_map: bool = False: Flag to indicate whether this Collection should not be included in the SiteMap.
51
50
  ```
52
51
 
53
52
  ## Attributes
@@ -26,7 +26,6 @@ nav:
26
26
  - Site Objects: site.md
27
27
  - Extending Render Engine:
28
28
  - Plugins: plugins.md
29
- - Content Managers: content_manager.md
30
29
  - Parsers: parsers.md
31
30
  - CLI: cli.md
32
31
  - Templates and Themes:
@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
28
28
  commit_id: COMMIT_ID
29
29
  __commit_id__: COMMIT_ID
30
30
 
31
- __version__ = version = '2025.11.1'
32
- __version_tuple__ = version_tuple = (2025, 11, 1)
31
+ __version__ = version = '2025.11.1a1'
32
+ __version_tuple__ = version_tuple = (2025, 11, 1, 'a1')
33
33
 
34
- __commit_id__ = commit_id = 'g3ef9c0acb'
34
+ __commit_id__ = commit_id = 'g5ed5705d6'
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: render_engine
3
- Version: 2025.11.1
3
+ Version: 2025.11.1a1
4
4
  Summary: A Flexible Static Site Generator for Python
5
5
  Project-URL: homepage, https://github.com/render-engine/render-engine/
6
6
  Project-URL: repository, https://github.com/render-engine/render-engine/
@@ -34,7 +34,6 @@ docs/requirements.txt
34
34
  docs/docs/archive.md
35
35
  docs/docs/cli.md
36
36
  docs/docs/collection.md
37
- docs/docs/content_manager.md
38
37
  docs/docs/custom_collections.md
39
38
  docs/docs/feeds.md
40
39
  docs/docs/index.md
@@ -1,67 +0,0 @@
1
- ---
2
- title: "Enhancing Functionality with Content Managers"
3
- description: "Guide to using creating Content Managers to use alternate content storage systems."
4
- date: August 22, 2024
5
- tags: ["content_manager", "render-engine", "customization"]
6
- ---
7
-
8
- Content Managers are a way to control how and where your content is stored.
9
-
10
- ## Introduction
11
-
12
- Render Engine `Collection` uses a `ContentManager` to manage the storage of content for site generation. By default
13
- content is stored in the file system with each piece of content existing in a discrete file. With an alternate
14
- `ContentManager` the content can be stored in a database, JSON file, or other alternate data store.
15
-
16
- ## Selecting a `ContentManager`
17
-
18
- The `ContentManager` for a given [`Collection`](collection.md) is controlled by the `ContentManager` attribute. When
19
- the class is instantiated the `ContentManager` is also instantiated with any `content_manager_extras` being passed
20
- as arguments. To access the `ContentManager` of a given `Collection` use the `content_manager` attribute.
21
-
22
- ## Creating a `ContentManager`
23
-
24
- To create a `ContentManager` create a sub-class of `ContentManager` that implements the following methods:
25
-
26
- ```python
27
- @property
28
- @abstractmethod
29
- def pages(self) -> Iterable:
30
- """The Page objects managed by the content manager"""
31
- ...
32
-
33
- @abstractmethod
34
- def create_entry(self, filepath: Path = None, editor: str = None, metadata: dict = None, content: str = None):
35
- """Create a new entry"""
36
- ...
37
- ```
38
-
39
- ### `pages`
40
-
41
- The `pages` property is how the `Collection` accesses its content. It is a method that _must_ be implemented by
42
- every `ContentManager`. An example `pages` implementation (from the
43
- [`FileContentManger`](https://github.com/render-engine/render-engine/blob/main/src/render_engine/content_managers/file_content_manager.py)) is:
44
-
45
- ```python
46
- @property
47
- def pages(self) -> Iterable:
48
- if self._pages is None:
49
- self._pages = [self.collection.get_page(page) for page in self.iter_content_path()]
50
- yield from self._pages
51
- ```
52
-
53
- ### `create_entry`
54
-
55
- The `create_entry` method is used by the Render Engine CLI tool to add new entries. It is responsible for adding
56
- the new entry to the datastore and, if an `editor` is specified, giving the user the ability to edit the new entry
57
- prior to committing the entry to the datastore.
58
-
59
- #### Arguments
60
-
61
- - `filepath: Path`: The path on the filesystem to store the new entry.
62
- - `editor: str`: The text editor to open for editing the new entry.
63
- - `content: str`: The initial content for the new entry.
64
- - `metadata: dict`: The metadata for the new entry.
65
-
66
- !!! Note
67
- Not every `ContentManager` actually needs all the arguments that are passed.