render-engine-json 0.0.0__py3-none-any.whl

render_engine_json/__init__.py

@@ -0,0 +1,2 @@
+from .collection import JSONCollection
+from .parsers import JSONPageParser

render_engine_json/parsers.py

@@ -0,0 +1,64 @@
+import json
+
+from render_engine.parsers.base_parsers import BasePageParser
+
+
+def base_parse(body: dict[str, any]) -> tuple[dict[str, any], str]:
+    """
+    parse content and attributes from content
+    >>> base_parse({"title": "Hello", "content": "Hello World"})
+    >>> ({'title': 'Hello'}, 'Hello World')
+    """
+    content = body.pop("content", None)
+    return body, content
+
+
+def parse_from_slug_entry(
+    slug_entry: dict[str, dict[str, any]]
+) -> tuple[dict[str, any], str]:
+    """
+    Fething content and attributes from a slug entry.
+    >>> parse_from_slug_entry({"slug": {"content": "Hello World"}})
+    >>> ({'slug': 'slug'}, 'Hello World')
+
+    This function expects input to be a dictionary with a single key whose value is a dict.
+    """
+
+    attrs, content = base_parse(list(slug_entry.values())[0])
+    attrs["slug"] = list(slug_entry.keys())[0]
+    return attrs, content
+
+
+class JSONPageParser(BasePageParser):
+    """Parser for JSON content."""
+
+    @staticmethod
+    def parse_content_path(content_path: str) -> dict[str, Any]:
+        """
+        Fetches content from a content_path and set attributes.
+        """
+        with open(content_path, "rb") as json_file:
+            return json.load(json_file)
+
+    @staticmethod
+    def parse_content(content: str) -> tuple[dict[str, Any], str]:
+        """
+        Fetching content and atttributes from content.
+
+        If the parsed_content is a dictionary, then the attributes are fetched from the dictionary
+          and the content is fetched from the "content" key.
+        If the parsed_content is a list, each item is passed as a dictionary into the `data` attribute.
+        """
+
+        body = json.loads(content)
+
+        if isinstance(body, dict):
+            return parse_from_slug_entry(body)
+
+        if isinstance(body, list):
+            return {"data": body}, ""
+
+        raise TypeError(
+            "The content should be a stringified dictionary or list.\n \
+            Perhaps you meant to stringify the content?"
+        )

render_engine_json-0.0.0.dist-info/METADATA

@@ -0,0 +1,108 @@
+Metadata-Version: 2.1
+Name: render-engine-json
+Version: 0.0.0
+Summary: JSON Parser and Collection for Render Engine
+Project-URL: homepage, https://github.com/kjaymiller/render_engine_json/
+Project-URL: repository, https://github.com/kjaymiller/render_engine_json/
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: render-engine >=2023.12.1b3
+Requires-Dist: python-slugify
+Provides-Extra: dev
+Requires-Dist: pytest ; extra == 'dev'
+
+# Render Engine JSON
+
+JSON Parser and Collection Module for Render Engine
+
+## Installation
+
+```bash
+pip install render_engine_json
+```
+
+## Usage
+
+The `render-engine-json` extends render-engine to allow you to build pages and collections using JSON. 
+
+The `JSONPageParser` class can be used to parse a single JSON page and the `JSONCollection` class can be used to parse a single collection of JSON pages.
+
+> **NOTE**
+> The `JSONCollection` class is designed to work with a single JSON file that contains an array of JSON Objects or a JSON Hash where the keys are the slugs. If you want to work with multiple JSON files you can use a regular `Collection` and the `JSONPageParser` as the parser.
+
+### Single JSON Page Entry
+
+To create a json entry you will need the `JSONPageParser` class as the Parser for your `Page` Object.
+
+You can pass the page a json string or a json file path.
+
+#### As a string
+
+```python
+
+from render_engine import Page, Site
+from render_engine_json import JSONPageParser
+
+site = Site()
+
+json_page = """
+{
+    "title": "My JSON Page",
+    "content": "This is my json page"
+}
+"""
+
+@site.page
+class JSONStringPage(Page):
+    parser = JSONPageParser
+    content = json_page
+
+```
+
+#### As a file
+
+```python
+
+@site.page
+class JSONFilePage(Page):
+    parser = JSONPageParser
+    content_path = "path/to/json/file.json"
+
+```
+
+### JSON Collection
+
+To create a JSON collection you will need the `JSONCollection` Object.
+
+You can pass the collection a json string or a json file path.
+
+#### As a string
+
+```python
+from render_engine import Site, Collection
+from render_engine_json import JSONCollection, JSONPageParser
+
+site = Site()
+
+json_collection = """
+[
+    {
+        "title": "My JSON Page",
+        "content": "This is my json page"
+    },
+    {
+        "title": "My JSON Page 2",
+        "content": "This is my json page 2"
+    }
+]
+"""
+
+@site.collection
+class JSONStringCollection(Collection):
+    parser = JSONPageParser
+    content = json_collection
+
+```
+
+
+```

render_engine_json-0.0.0.dist-info/RECORD

@@ -0,0 +1,6 @@
+render_engine_json/__init__.py,sha256=wimtl1Qk3sdOGgbRKAFxFRtS7WzCNhYCJczZlExBqA0,75
+render_engine_json/parsers.py,sha256=gdPvXXBCXZCc2v307w1NTn7raIrj93dRKLtRD2YFdTY,2022
+render_engine_json-0.0.0.dist-info/METADATA,sha256=UQDkI9DkHst8cBbKT3HY11hwGbC90s7BjVGnkngn1VU,2446
+render_engine_json-0.0.0.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+render_engine_json-0.0.0.dist-info/top_level.txt,sha256=uy_rvUD5pKUt6k50tJdJ-h40GMtfTvzY1XDaJ3y0Jog,19
+render_engine_json-0.0.0.dist-info/RECORD,,

render_engine_json-0.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: bdist_wheel (0.42.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

render_engine_json-0.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+render_engine_json