tinyssg 1.1.0__py3-none-any.whl → 1.2.1__py3-none-any.whl

tinyssg/__init__.py

@@ -7,6 +7,7 @@ import re
 import shutil
 import subprocess
 import sys
+import textwrap
 import time
 import webbrowser
 from http.server import HTTPServer, SimpleHTTPRequestHandler
@@ -40,6 +41,12 @@ class TinySSGPage:
         """
         raise TinySSGException(f"The Page class corresponding to {self.__class__.__name__} does not appear to be implemented correctly.")
 
+    def indent(self, src: str, indent: int = 0) -> str:
+        """
+        Indentation process
+        """
+        return TinySSGUtility.set_indent(src, indent)
+
 
 class TinySSGException(Exception):
     """
@@ -62,6 +69,95 @@ class TinySSGUtility:
             result = re.sub(start_delimiter + re.escape(key) + end_delimiter, str(value), result)
         return result
 
+    @classmethod
+    def set_indent(cls, src: str, indent: int = 0) -> str:
+        """
+        Set the indent level of the text
+        """
+        return textwrap.indent(textwrap.dedent(src).strip(), (' ' * indent)) + '\n'
+
+    @classmethod
+    def merge_dict(cls, base: dict, add: dict, overwrite: bool = True, extend: bool = True, reverse: bool = False) -> dict:
+        """
+        Merge dictionaries
+        """
+        if not isinstance(base, dict) or not isinstance(add, dict):
+            raise ValueError('Both base and add must be dictionary type.')
+
+        result = base.copy()
+
+        for key, value in add.items():
+            TinySSGUtility.merge_dict_value(result, key, value, overwrite, extend, reverse)
+
+        return result
+
+    @classmethod
+    def extend_list(cls, base: any, add: any) -> list:
+        """
+        List Expansion
+        """
+        if base is None:
+            return add if isinstance(add, list) else [add]
+
+        result = base.copy() if isinstance(base, list) else [base]
+
+        if isinstance(add, list):
+            result.extend(add)
+        else:
+            result.append(add)
+
+        return result
+
+    @classmethod
+    def merge_dict_value(cls, base: any, key: str, value: any, overwrite: bool = True, extend: bool = True, reverse: bool = False) -> None:
+        """
+        Merge dictionary values (type-based merging process)
+        """
+        if not isinstance(base, dict):
+            raise ValueError('Base must be dictionary type.')
+
+        if key not in base:
+            base[key] = value
+        elif isinstance(base[key], dict) and isinstance(value, dict):
+            base[key] = TinySSGUtility.merge_dict(base[key], value, overwrite, extend, reverse)
+        elif extend and (isinstance(base[key], list) or isinstance(value, list)):
+            if reverse:
+                base[key] = TinySSGUtility.extend_list(value, base[key])
+            else:
+                base[key] = TinySSGUtility.extend_list(base[key], value)
+        elif overwrite:
+            base[key] = value
+
+    @classmethod
+    def filter_json_serializable(cls, data):
+        """
+        Filter only JSON-able objects
+        """
+        if isinstance(data, (dict, list, str, int, float, bool, type(None))):
+            if isinstance(data, dict):
+                return {k: TinySSGUtility.filter_json_serializable(v) for k, v in data.items()}
+            elif isinstance(data, list):
+                return [TinySSGUtility.filter_json_serializable(v) for v in data]
+            else:
+                return data
+        return None
+
+    @classmethod
+    def get_serialize_json(cls, data: dict, jsonindent: any = 4) -> str:
+        """
+        Only JSON-able objects from the dictionary are converted to JSON.
+        """
+        if not isinstance(data, dict):
+            raise ValueError('The specified variable is not a dictionary type.')
+        return json.dumps(TinySSGUtility.filter_json_serializable(data), indent=jsonindent)
+
+    @classmethod
+    def exclude_double_underscore(cls, data: dict) -> dict:
+        """
+        Exclude keys beginning with __
+        """
+        return {k: v for k, v in data.items() if not k.startswith('__')}
+
     @classmethod
     def get_fullpath(cls, args: dict, pathkey: str = '') -> str:
         """

{tinyssg-1.1.0.dist-info → tinyssg-1.2.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: tinyssg
-Version: 1.1.0
+Version: 1.2.1
 Summary: A simple static site generator
 Author: Uniras
 Author-email: tkappeng@gmail.com
@@ -50,7 +50,7 @@ Configure the directory as follows.The directory name can be changed with an opt
   |-- static        Place static files that are not subject to SSG (css, images, etc.)
   |-- dist          This is the directory where SSG results will be output.The contents of this directory can be published as a web site by placing it on a web server.
         |-- static  The static directory is copied to this directory.
-````
+```
 
 ### Creating pages
 
@@ -60,25 +60,26 @@ Create a Python file in the `pages` directory and create a class that extends th
 from tinyssg import TinySSGPage
 
 class IndexPage(TinySSGPage):.
-    def query(self):.
+    def query(self) -> any:
         return {
             'title': 'Index', 'content': 'Hello, World!
             'content': 'Hello, World!'
         }
 
-    def template(self): return
-        return '''
-<!DOCTYPE html>
-<html>
-<head>
-  <meta charset="utf-8" />
-  <title>{{ title }}</title>
-</head>
-<body>
-  <h1>{{ title }}</h1>
-  <p>{{ content }}</p>
-</body>
-</html>'''
+    def template(self) -> str:
+        return self.indent("""
+            <!DOCTYPE html>
+            <html>
+            <head>
+              <meta charset="utf-8" />
+              <title>{{ title }}</title>
+            </head>
+            <body>
+              <h1>{{ title }}</h1>
+              <p>{{ content }}</p>
+            </body>
+            </html>
+        """, 0)
 ```
 
 Building it will generate an HTML file with the same name as the Python file.
@@ -105,7 +106,7 @@ Each page must be defined individually, but since this is a simple Python class,
 python -m tinyssg dev
 ```
 
-The local server for development will be started.You can see the generated HTML by accessing ``http://localhost:8000``.
+The local server for development will be started.You can see the generated HTML by accessing `http://localhost:8000`.
 
 If you change files in the `pages`, `libs`, or `static` directories, the server will automatically restart to reflect the changes.
 
@@ -120,7 +121,6 @@ HTML files will be generated in the `dist` directory.
 ### options (excerpt)
 
 ```text
-
 usage: python -m tinyssg [--page PAGE] [--static STATIC] [--lib LIB] [--input INPUT] [--output OUTPUT] [--port PORT] [--wait WAIT] [--nolog] [--noreloadnoreload] [--noopen] [--curdir CURDIR] [mode]
 
 MODE:
@@ -140,3 +140,86 @@ Options:
   --noopen, -N                Do not open browser when starting development server
   --curdir CURDIR, -C CURDIR  Specify current directory.
 ```
+
+## FAQ
+
+### **Q.** How can I use jinja2 as a template engine?
+
+**A.** Override the `render` method to use jinja2 to render templates.
+
+lib/jinja2_page.py
+
+```python
+from tinyssg import TinySSGPage
+from jinja2 import Template
+
+class Jinja2Page(TinySSGPage):
+    def render(self, src: str, data: dict) -> str:
+        template = Template(src)
+        return template.render(data)
+```
+
+pages/index.py
+
+```python
+from tinyssg import TinySSGPage
+from lib.jinja2_page import Jinja2Page
+
+class IndexPage(Jinja2Page):
+    def query(self) -> any:
+        return {
+            'title': 'Index', 'content': 'Hello, World!'
+        }
+
+    def template(self) -> str:
+        return self.indent("""
+            <!DOCTYPE html>
+            <html>
+            <head>
+              <meta charset="utf-8" />
+              <title>{{ title }}</title>
+            </head>
+            <body>
+              <h1>{{ title }}</h1>
+              <p>{{ content }}</p>
+            </body>
+            </html>
+        """, 0)
+```
+
+### **Q.** How do I use Markdown to write in my templates?
+
+**A.** Override the `translate` method and use the Markdown library to convert it to HTML.
+
+lib/markdown_page.py
+
+```python
+from tinyssg import TinySSGPage
+import markdown
+
+class MarkdownPage(TinySSGPage):
+    def translate(self, basestr: str) -> str:
+        return markdown.markdown(basestr)
+```
+
+pages/index.py
+
+```python
+from tinyssg import TinySSGPage
+from lib.markdown_page import MarkdownPage
+
+class IndexPage(MarkdownPage):
+    def query(self) -> any:
+        return {
+            'title': 'Index', 'content': 'Hello, World!'
+        }
+
+    def template(self) -> str:
+        return self.indent("""
+            # {{ title }}
+
+            {{ content }}
+
+            This is **Markdown** template.
+        """, 0)
+```

tinyssg-1.2.1.dist-info/RECORD

@@ -0,0 +1,6 @@
+tinyssg/__init__.py,sha256=5dn_SPH78JJStnQCxz_7YMflRHQRFusF-hJAdGWQ8X4,30677
+tinyssg/__main__.py,sha256=E8PEZ-wWYae76H_iWbY1Xu9VYGb6sfsWMN-hzqTMoBc,83
+tinyssg-1.2.1.dist-info/METADATA,sha256=Cqzs0_ltiMxVu038tRVFsYh01HscpBmaC9FQoPjes-c,8100
+tinyssg-1.2.1.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+tinyssg-1.2.1.dist-info/top_level.txt,sha256=8u1XtPYCatbklb6u3NbJbFUbwA8nDKZ6cY3FScGwJDQ,8
+tinyssg-1.2.1.dist-info/RECORD,,

tinyssg-1.1.0.dist-info/RECORD

@@ -1,6 +0,0 @@
-tinyssg/__init__.py,sha256=puqhv4_E1ZG7c9NYUBhIn8ZtWRhPWcy0JspdWKmX9hU,27214
-tinyssg/__main__.py,sha256=E8PEZ-wWYae76H_iWbY1Xu9VYGb6sfsWMN-hzqTMoBc,83
-tinyssg-1.1.0.dist-info/METADATA,sha256=i0XNcAf4B3pS3CeA0cgnIWYnixswGHPpPm8tNbwFN_0,6072
-tinyssg-1.1.0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-tinyssg-1.1.0.dist-info/top_level.txt,sha256=8u1XtPYCatbklb6u3NbJbFUbwA8nDKZ6cY3FScGwJDQ,8
-tinyssg-1.1.0.dist-info/RECORD,,