utkit 0.4.0__tar.gz → 0.5.0__tar.gz

utkit-0.5.0/PKG-INFO

@@ -0,0 +1,106 @@
+Metadata-Version: 2.3
+Name: utkit
+Version: 0.5.0
+Summary: core libraries for development
+Author: TINS PJ
+Author-email: TINS PJ <tinspj1997@gmail.com>
+Requires-Dist: cryptography>=47.0.0
+Requires-Dist: loguru>=0.7.3
+Requires-Dist: pwdlib[argon2]>=0.3.0
+Requires-Dist: pyjwt>=2.12.1
+Requires-Dist: typer>=0.20.0
+Requires-Dist: zensical>=0.0.37
+Requires-Dist: slowapi>=0.1.9 ; extra == 'all'
+Requires-Dist: pydantic>=2.13.3 ; extra == 'all'
+Requires-Dist: psutil>=7.2.2 ; extra == 'all'
+Requires-Dist: jinja2>=3.1.6 ; extra == 'all'
+Requires-Dist: redis>=7.4.0 ; extra == 'all'
+Requires-Dist: slowapi>=0.1.9 ; extra == 'api'
+Requires-Dist: pydantic>=2.13.3 ; extra == 'api'
+Requires-Dist: psutil>=7.2.2 ; extra == 'standard'
+Requires-Dist: jinja2>=3.1.6 ; extra == 'standard'
+Requires-Dist: redis>=7.4.0 ; extra == 'store'
+Requires-Python: >=3.12
+Provides-Extra: all
+Provides-Extra: api
+Provides-Extra: standard
+Provides-Extra: store
+Description-Content-Type: text/markdown
+
+# utkit
+
+<div style="text-align: center; margin: 1.5rem 0;">
+  <img src="src/utkit/documentation/docs/images/logo.png" alt="utkit" style="height: 100px; width: auto;" />
+</div>
+
+**utkit** is a collection of core libraries for Python development, providing ready-to-use utilities for common tasks such as authentication, email, encryption, caching, rate limiting, and more.
+
+- **Version:** `0.4.0`
+- **Author:** TINS PJ
+- **Requires:** Python `>=3.12`
+- **License:** MIT
+- **PyPI:** [pypi.org/project/utkit](https://pypi.org/project/utkit/)
+
+---
+
+## Installation
+
+```bash
+pip install utkit
+```
+
+Or with [uv](https://docs.astral.sh/uv/):
+
+```bash
+uv add utkit
+```
+
+### Optional extras
+
+| Extra | Included dependencies | Use for |
+|---|---|---|
+| `api` | `slowapi`, `pydantic` | Rate limiting and API schema for FastAPI |
+| `standard` | `psutil`, `jinja2` | Performance monitoring and HTML template rendering |
+| `store` | `redis` | Redis cache and key-value store |
+| `all` | all of the above | Install every optional dependency at once |
+
+```bash
+pip install "utkit[api]"
+pip install "utkit[standard]"
+pip install "utkit[store]"
+
+# All optional dependencies at once
+pip install "utkit[all]"
+```
+
+---
+
+## Modules
+
+### Core
+
+| Module | Description |
+|---|---|
+| `auth` | Password hashing and verification |
+| `communication.mail` | Send HTML emails via SMTP |
+| `privacy.mask` | Mask sensitive data (email, phone, card, string) |
+| `privacy.security` | Fernet & RSA encryption, secret key generation, JWT |
+
+### Optional
+
+| Module | Extra | Description |
+|---|---|---|
+| `api.rate_limit` | `api` | Rate limiting for FastAPI via SlowAPI |
+| `api.schema` | `api` | Reusable Pydantic query models (pagination) |
+| `utils.performance` | `standard` | Execution time decorator and memory usage |
+| `template.render` | `standard` | HTML rendering from Jinja2 files and strings |
+| `store.redis` | `store` | Singleton Redis client with JSON serialisation |
+
+---
+
+## CLI
+
+```bash
+utkit --version
+utkit docs
+```

utkit-0.5.0/README.md

@@ -0,0 +1,77 @@
+# utkit
+
+<div style="text-align: center; margin: 1.5rem 0;">
+  <img src="src/utkit/documentation/docs/images/logo.png" alt="utkit" style="height: 100px; width: auto;" />
+</div>
+
+**utkit** is a collection of core libraries for Python development, providing ready-to-use utilities for common tasks such as authentication, email, encryption, caching, rate limiting, and more.
+
+- **Version:** `0.4.0`
+- **Author:** TINS PJ
+- **Requires:** Python `>=3.12`
+- **License:** MIT
+- **PyPI:** [pypi.org/project/utkit](https://pypi.org/project/utkit/)
+
+---
+
+## Installation
+
+```bash
+pip install utkit
+```
+
+Or with [uv](https://docs.astral.sh/uv/):
+
+```bash
+uv add utkit
+```
+
+### Optional extras
+
+| Extra | Included dependencies | Use for |
+|---|---|---|
+| `api` | `slowapi`, `pydantic` | Rate limiting and API schema for FastAPI |
+| `standard` | `psutil`, `jinja2` | Performance monitoring and HTML template rendering |
+| `store` | `redis` | Redis cache and key-value store |
+| `all` | all of the above | Install every optional dependency at once |
+
+```bash
+pip install "utkit[api]"
+pip install "utkit[standard]"
+pip install "utkit[store]"
+
+# All optional dependencies at once
+pip install "utkit[all]"
+```
+
+---
+
+## Modules
+
+### Core
+
+| Module | Description |
+|---|---|
+| `auth` | Password hashing and verification |
+| `communication.mail` | Send HTML emails via SMTP |
+| `privacy.mask` | Mask sensitive data (email, phone, card, string) |
+| `privacy.security` | Fernet & RSA encryption, secret key generation, JWT |
+
+### Optional
+
+| Module | Extra | Description |
+|---|---|---|
+| `api.rate_limit` | `api` | Rate limiting for FastAPI via SlowAPI |
+| `api.schema` | `api` | Reusable Pydantic query models (pagination) |
+| `utils.performance` | `standard` | Execution time decorator and memory usage |
+| `template.render` | `standard` | HTML rendering from Jinja2 files and strings |
+| `store.redis` | `store` | Singleton Redis client with JSON serialisation |
+
+---
+
+## CLI
+
+```bash
+utkit --version
+utkit docs
+```

utkit-0.5.0/pyproject.toml

@@ -0,0 +1,44 @@
+[project]
+name = "utkit"
+version = "0.5.0"
+description = "core libraries for development"
+readme = "README.md"
+authors = [
+    { name = "TINS PJ", email = "tinspj1997@gmail.com" }
+]
+requires-python = ">=3.12"
+dependencies = [
+    "cryptography>=47.0.0",
+    "loguru>=0.7.3",
+    "pwdlib[argon2]>=0.3.0",
+    "pyjwt>=2.12.1",
+    "typer>=0.20.0",
+    "zensical>=0.0.37",
+]
+
+[project.optional-dependencies]
+api=[
+ "slowapi>=0.1.9",
+ "pydantic>=2.13.3",
+]
+standard=[
+    "psutil>=7.2.2",
+     "jinja2>=3.1.6",
+]
+store=[
+     "redis>=7.4.0",
+]
+all=[
+    "slowapi>=0.1.9",
+    "pydantic>=2.13.3",
+    "psutil>=7.2.2",
+    "jinja2>=3.1.6",
+    "redis>=7.4.0",
+]
+
+[project.scripts]
+utkit = "utkit.cli:main"
+
+[build-system]
+requires = ["uv_build >= 0.11.8, <0.12.0"]
+build-backend = "uv_build"

utkit-0.5.0/src/utkit/__init__.py

@@ -0,0 +1,6 @@
+def main() -> None:
+    print("Hello from utkit!")
+
+
+#TODO - Add more core utilities and libraries here as needed.   
+#TODO : redis, logging,passlib, fastapi utils,sqlalchemy utils, etc.

utkit-0.5.0/src/utkit/api/rate_limit/__init__.py

@@ -0,0 +1,9 @@
+from __future__ import annotations
+from slowapi import Limiter, _rate_limit_exceeded_handler as rate_limit_exceeded_handler
+from slowapi.util import get_remote_address
+
+__all__ = ["initialize_rate_limiter", "rate_limit_exceeded_handler"]
+
+
+def initialize_rate_limiter(rate_limit_default: str = "100/minute") -> Limiter:
+    return Limiter(key_func=get_remote_address, default_limits=[rate_limit_default])

utkit-0.5.0/src/utkit/api/rate_limit/error.py

@@ -0,0 +1,4 @@
+from __future__ import annotations
+from slowapi.errors import RateLimitExceeded as RateLimitExceededError
+
+__all__ = ["RateLimitExceededError"]

utkit-0.5.0/src/utkit/api/rate_limit/middleware.py

@@ -0,0 +1,4 @@
+from __future__ import annotations
+from slowapi.middleware import SlowAPIMiddleware as RateLimitMiddleware
+
+__all__ = ["RateLimitMiddleware"]

utkit-0.5.0/src/utkit/api/schema/query.py

@@ -0,0 +1,7 @@
+from pydantic import BaseModel, Field
+
+
+class PaginationParams(BaseModel):
+    page: int = Field(1, gt=0 ,description="Page number, starting from 1")
+    page_size: int = Field(10, ge=0, description="Number of items per page")
+   

utkit-0.5.0/src/utkit/auth/__init__.py

@@ -0,0 +1,16 @@
+from __future__ import annotations
+
+from pwdlib import PasswordHash
+
+password_hash = PasswordHash.recommended()
+
+__all__ = [
+    "verify_password","create_password_hash"
+]
+
+def verify_password(plain_password, hashed_password):
+    return password_hash.verify(plain_password, hashed_password)
+
+
+def create_password_hash(password):
+    return password_hash.hash(password)

utkit-0.5.0/src/utkit/core/logging.py

@@ -0,0 +1,88 @@
+import inspect
+import sys
+from pathlib import Path
+from typing import Callable, List
+from loguru import logger
+
+
+def _add_class_name(record):
+    """Patch logger records to include the caller's class name."""
+    if record["extra"].get("classname") is not None:
+        return
+    frame = inspect.currentframe()
+    try:
+        while frame:
+            frame = frame.f_back
+            if frame and frame.f_globals.get("__name__") not in (
+                "loguru._logger",
+                __name__,
+            ):
+                cls = frame.f_locals.get("self") or frame.f_locals.get("cls")
+                if cls is not None:
+                    record["extra"]["classname"] = (
+                        cls.__name__ if isinstance(cls, type) else type(cls).__name__
+                    )
+                else:
+                    record["extra"]["classname"] = "Global"
+                break
+        else:
+            record["extra"]["classname"] = "Global"
+    finally:
+        del frame
+
+
+def setup_logging(
+    log_base_path="logs",
+    patchers: List[Callable] = [],
+    rotation: str = "1 day",
+    compression: str = "zip",
+    level: str = "INFO",
+    app_retention: str = "7 days",
+    meter_retention: str = "30 days",
+    **kwargs,
+) -> None:
+    log_path = Path(log_base_path)
+    log_path.mkdir(exist_ok=True)
+
+    def default_patcher(record):
+        for patcher in patchers or []:
+            patcher(record)
+
+    patchers.append(_add_class_name)
+    logger.remove()
+    logger.configure(patcher=default_patcher)
+
+    # Common format string (DRY principle)
+    log_format = (
+        "<green>{time:YYYY-MM-DD HH:mm:ss}</green> | "
+        "<level>{level: <8}</level> | "
+        "<cyan>{name}</cyan>:<cyan>{extra[classname]}</cyan>:<cyan>{function}</cyan>:<cyan>{line}</cyan> | "
+        "{message} | <blue>Context: {extra}</blue>"
+    )
+
+    log_kwargs = {
+        "rotation": rotation,
+        "compression": compression,
+        "format": log_format,
+        "level": level,
+        **kwargs,
+    }
+
+    # 2. Console (Everything INFO+)
+    logger.add(sys.stderr, format=log_format, level="INFO", colorize=True)
+
+    # 3. Application Logs (Daily Rotation)
+    logger.add(
+        log_path / "application_{time:YYYY-MM-DD}.log",
+        filter=lambda r: r["extra"].get("type") == "app",
+        retention=app_retention,
+        **log_kwargs,
+    )
+
+    # 4. Metering Logs
+    logger.add(
+        log_path / "metering_{time:YYYY-MM-DD}.log",
+        filter=lambda r: r["extra"].get("type") == "meter",
+        retention=meter_retention,
+        **log_kwargs,
+    )

utkit-0.5.0/src/utkit/documentation/.cache/11038628458439117958

@@ -0,0 +1,4 @@
+{
+  "data": "\n<!doctype html>\n<html lang=\"en\" class=\"no-js\">\n  <head>\n    \n      <meta charset=\"utf-8\">\n      <meta name=\"viewport\" content=\"width=device-width,initial-scale=1\">\n      \n        <meta name=\"description\" content=\"Core libraries for development.\">\n      \n      \n        <meta name=\"author\" content=\"TINS PJ\">\n      \n      \n      \n        <link rel=\"prev\" href=\"../../store/redis/\">\n      \n      \n        <link rel=\"next\" href=\"../../utils/performance/\">\n      \n      \n        \n      \n      \n      <link rel=\"icon\" href=\"../../images/logo.png\">\n      <meta name=\"generator\" content=\"zensical-0.0.37\">\n    \n    \n      \n        <title>Template Rendering - Documentation</title>\n      \n    \n    \n      \n        \n      \n      <link rel=\"stylesheet\" href=\"../../assets/stylesheets/modern/main.1e981d71.min.css\">\n      \n        \n          \n        \n        <link rel=\"stylesheet\" href=\"../../assets/stylesheets/modern/palette.dfe2e883.min.css\">\n      \n      \n\n\n    \n    \n      \n    \n    \n      \n        \n        \n        <link rel=\"preconnect\" href=\"https://fonts.gstatic.com\" crossorigin>\n        <link rel=\"stylesheet\" href=\"https://fonts.googleapis.com/css?family=Inter:300,300i,400,400i,500,500i,700,700i%7CJetBrains+Mono:400,400i,700,700i&amp;display=fallback\">\n        <style>:root{--md-text-font:\"Inter\";--md-code-font:\"JetBrains Mono\"}</style>\n      \n    \n    \n      <link rel=\"stylesheet\" href=\"../../stylesheets/extra.css\">\n    \n    <script>__md_scope=new URL(\"../..\",location),__md_hash=e=>[...e].reduce(((e,t)=>(e<<5)-e+t.charCodeAt(0)),0),__md_get=(e,t=localStorage,a=__md_scope)=>JSON.parse(t.getItem(a.pathname+\".\"+e)),__md_set=(e,t,a=localStorage,_=__md_scope)=>{try{a.setItem(_.pathname+\".\"+e,JSON.stringify(t))}catch(e){}},document.documentElement.setAttribute(\"data-platform\",navigator.platform)</script>\n    \n      \n\n    \n    \n  </head>\n  \n  \n    \n    \n      \n    \n    \n    \n    \n    <body dir=\"ltr\" data-md-color-scheme=\"default\" data-md-color-primary=\"indigo\" data-md-color-accent=\"indigo\">\n  \n    \n    <input class=\"md-toggle\" data-md-toggle=\"drawer\" type=\"checkbox\" id=\"__drawer\" autocomplete=\"off\">\n    <input class=\"md-toggle\" data-md-toggle=\"search\" type=\"checkbox\" id=\"__search\" autocomplete=\"off\">\n    <label class=\"md-overlay\" for=\"__drawer\" aria-label=\"Navigation\"></label>\n    <div data-md-component=\"skip\">\n      \n        \n        <a href=\"#template-rendering\" class=\"md-skip\">\n          Skip to content\n        </a>\n      \n    </div>\n    <div data-md-component=\"announce\">\n      \n    </div>\n    \n    \n      \n\n  \n\n<header class=\"md-header md-header--shadow\" data-md-component=\"header\">\n  <nav class=\"md-header__inner md-grid\" aria-label=\"Header\">\n    <a href=\"../..\" title=\"Documentation\" class=\"md-header__button md-logo\" aria-label=\"Documentation\" data-md-component=\"logo\">\n      \n  <img src=\"../../images/logo.png\" alt=\"Documentation\">\n\n    </a>\n    <label class=\"md-header__button md-icon\" for=\"__drawer\" aria-label=\"Navigation\">\n      \n      <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-menu\" viewBox=\"0 0 24 24\"><path d=\"M4 5h16M4 12h16M4 19h16\"/></svg>\n    </label>\n    <div class=\"md-header__title\" data-md-component=\"header-title\">\n      <div class=\"md-header__ellipsis\">\n        <div class=\"md-header__topic\">\n          <span class=\"md-ellipsis\">\n            Documentation\n          </span>\n        </div>\n        <div class=\"md-header__topic\" data-md-component=\"header-topic\">\n          <span class=\"md-ellipsis\">\n            \n              Template Rendering\n            \n          </span>\n        </div>\n      </div>\n    </div>\n    \n      \n        <form class=\"md-header__option\" data-md-component=\"palette\">\n  \n    \n    \n    \n    <input class=\"md-option\" data-md-color-media=\"none\" data-md-color-scheme=\"default\" data-md-color-primary=\"indigo\" data-md-color-accent=\"indigo\"  aria-label=\"Switch to dark mode\"  type=\"radio\" name=\"__palette\" id=\"__palette_0\">\n    \n      <label class=\"md-header__button md-icon\" title=\"Switch to dark mode\" for=\"__palette_1\" hidden>\n        <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-sun\" viewBox=\"0 0 24 24\"><circle cx=\"12\" cy=\"12\" r=\"4\"/><path d=\"M12 2v2M12 20v2M4.93 4.93l1.41 1.41M17.66 17.66l1.41 1.41M2 12h2M20 12h2M6.34 17.66l-1.41 1.41M19.07 4.93l-1.41 1.41\"/></svg>\n      </label>\n    \n  \n    \n    \n    \n    <input class=\"md-option\" data-md-color-media=\"none\" data-md-color-scheme=\"slate\" data-md-color-primary=\"indigo\" data-md-color-accent=\"indigo\"  aria-label=\"Switch to light mode\"  type=\"radio\" name=\"__palette\" id=\"__palette_1\">\n    \n      <label class=\"md-header__button md-icon\" title=\"Switch to light mode\" for=\"__palette_0\" hidden>\n        <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-moon\" viewBox=\"0 0 24 24\"><path d=\"M20.985 12.486a9 9 0 1 1-9.473-9.472c.405-.022.617.46.402.803a6 6 0 0 0 8.268 8.268c.344-.215.825-.004.803.401\"/></svg>\n      </label>\n    \n  \n</form>\n      \n    \n    \n      <script>var palette=__md_get(\"__palette\");if(palette&&palette.color){if(\"(prefers-color-scheme)\"===palette.color.media){var media=matchMedia(\"(prefers-color-scheme: light)\"),input=document.querySelector(media.matches?\"[data-md-color-media='(prefers-color-scheme: light)']\":\"[data-md-color-media='(prefers-color-scheme: dark)']\");palette.color.media=input.getAttribute(\"data-md-color-media\"),palette.color.scheme=input.getAttribute(\"data-md-color-scheme\"),palette.color.primary=input.getAttribute(\"data-md-color-primary\"),palette.color.accent=input.getAttribute(\"data-md-color-accent\")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute(\"data-md-color-\"+key,value)}</script>\n    \n    \n    \n      \n      \n        <label class=\"md-header__button md-icon\" for=\"__search\" aria-label=\"Search\">\n          \n          <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-search\" viewBox=\"0 0 24 24\"><path d=\"m21 21-4.34-4.34\"/><circle cx=\"11\" cy=\"11\" r=\"8\"/></svg>\n        </label>\n        <div class=\"md-search\" data-md-component=\"search\" role=\"dialog\" aria-label=\"Search\">\n  <button type=\"button\" class=\"md-search__button\">\n    Search\n  </button>\n</div>\n      \n    \n    <div class=\"md-header__source\">\n      \n    </div>\n  </nav>\n  \n</header>\n    \n    <div class=\"md-container\" data-md-component=\"container\">\n      \n      \n        \n          \n        \n      \n      <main class=\"md-main\" data-md-component=\"main\">\n        <div class=\"md-main__inner md-grid\">\n          \n            \n              \n              <div class=\"md-sidebar md-sidebar--primary\" data-md-component=\"sidebar\" data-md-type=\"navigation\" >\n                <div class=\"md-sidebar__scrollwrap\">\n                  <div class=\"md-sidebar__inner\">\n                    \n\n\n\n<nav class=\"md-nav md-nav--primary\" aria-label=\"Navigation\" data-md-level=\"0\">\n  <label class=\"md-nav__title\" for=\"__drawer\">\n    <a href=\"../..\" title=\"Documentation\" class=\"md-nav__button md-logo\" aria-label=\"Documentation\" data-md-component=\"logo\">\n      \n  <img src=\"../../images/logo.png\" alt=\"Documentation\">\n\n    </a>\n    Documentation\n  </label>\n  \n  <ul class=\"md-nav__list\" data-md-scrollfix>\n    \n      \n      \n  \n  \n  \n  \n    <li class=\"md-nav__item\">\n      <a href=\"../..\" class=\"md-nav__link\">\n        \n  \n  \n    <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-rocket\" viewBox=\"0 0 24 24\"><path d=\"M12 15v5s3.03-.55 4-2c1.08-1.62 0-5 0-5M4.5 16.5c-1.5 1.26-2 5-2 5s3.74-.5 5-2c.71-.84.7-2.13-.09-2.91a2.18 2.18 0 0 0-2.91-.09\"/><path d=\"M9 12a22 22 0 0 1 2-3.95A12.88 12.88 0 0 1 22 2c0 2.72-.78 7.5-6 11a22.4 22.4 0 0 1-4 2z\"/><path d=\"M9 12H4s.55-3.03 2-4c1.62-1.08 5 .05 5 .05\"/></svg>\n  \n  <span class=\"md-ellipsis\">\n    \n  \n    Get started\n  \n\n    \n  </span>\n  \n  \n\n      </a>\n    </li>\n  \n\n    \n      \n      \n  \n  \n  \n  \n    <li class=\"md-nav__item\">\n      <a href=\"../../auth/\" class=\"md-nav__link\">\n        \n  \n  \n    <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-key-round\" viewBox=\"0 0 24 24\"><path d=\"M2.586 17.414A2 2 0 0 0 2 18.828V21a1 1 0 0 0 1 1h3a1 1 0 0 0 1-1v-1a1 1 0 0 1 1-1h1a1 1 0 0 0 1-1v-1a1 1 0 0 1 1-1h.172a2 2 0 0 0 1.414-.586l.814-.814a6.5 6.5 0 1 0-4-4z\"/><circle cx=\"16.5\" cy=\"7.5\" r=\".5\" fill=\"currentColor\"/></svg>\n  \n  <span class=\"md-ellipsis\">\n    \n  \n    Auth\n  \n\n    \n  </span>\n  \n  \n\n      </a>\n    </li>\n  \n\n    \n      \n      \n  \n  \n  \n  \n    \n    \n      \n        \n      \n    \n    \n    \n      \n        \n        \n      \n    \n    \n    <li class=\"md-nav__item md-nav__item--section md-nav__item--nested\">\n      \n        \n        \n        <input class=\"md-nav__toggle md-toggle \" type=\"checkbox\" id=\"__nav_3\" >\n        \n          \n          <label class=\"md-nav__link\" for=\"__nav_3\" id=\"__nav_3_label\" tabindex=\"\">\n            \n  \n  \n  <span class=\"md-ellipsis\">\n    \n  \n    Communication\n  \n\n    \n  </span>\n  \n  \n\n            <span class=\"md-nav__icon md-icon\"></span>\n          </label>\n        \n        <nav class=\"md-nav\" data-md-level=\"1\" aria-labelledby=\"__nav_3_label\" aria-expanded=\"false\">\n          <label class=\"md-nav__title\" for=\"__nav_3\">\n            <span class=\"md-nav__icon md-icon\"></span>\n            \n  \n    Communication\n  \n\n          </label>\n          <ul class=\"md-nav__list\" data-md-scrollfix>\n            \n              \n                \n  \n  \n  \n  \n    <li class=\"md-nav__item\">\n      <a href=\"../../communication/mail/\" class=\"md-nav__link\">\n        \n  \n  \n    <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-mail\" viewBox=\"0 0 24 24\"><path d=\"m22 7-8.991 5.727a2 2 0 0 1-2.009 0L2 7\"/><rect width=\"20\" height=\"16\" x=\"2\" y=\"4\" rx=\"2\"/></svg>\n  \n  <span class=\"md-ellipsis\">\n    \n  \n    Mail (SMTP)\n  \n\n    \n  </span>\n  \n  \n\n      </a>\n    </li>\n  \n\n              \n            \n          </ul>\n        </nav>\n      \n    </li>\n  \n\n    \n      \n      \n  \n  \n  \n  \n    \n    \n      \n        \n      \n        \n      \n    \n    \n    \n      \n        \n        \n      \n    \n    \n    <li class=\"md-nav__item md-nav__item--section md-nav__item--nested\">\n      \n        \n        \n        <input class=\"md-nav__toggle md-toggle \" type=\"checkbox\" id=\"__nav_4\" >\n        \n          \n          <label class=\"md-nav__link\" for=\"__nav_4\" id=\"__nav_4_label\" tabindex=\"\">\n            \n  \n  \n  <span class=\"md-ellipsis\">\n    \n  \n    API\n  \n\n    \n  </span>\n  \n  \n\n            <span class=\"md-nav__icon md-icon\"></span>\n          </label>\n        \n        <nav class=\"md-nav\" data-md-level=\"1\" aria-labelledby=\"__nav_4_label\" aria-expanded=\"false\">\n          <label class=\"md-nav__title\" for=\"__nav_4\">\n            <span class=\"md-nav__icon md-icon\"></span>\n            \n  \n    API\n  \n\n          </label>\n          <ul class=\"md-nav__list\" data-md-scrollfix>\n            \n              \n                \n  \n  \n  \n  \n    <li class=\"md-nav__item\">\n      <a href=\"../../api/rate-limit/\" class=\"md-nav__link\">\n        \n  \n  \n    <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-gauge\" viewBox=\"0 0 24 24\"><path d=\"m12 14 4-4M3.34 19a10 10 0 1 1 17.32 0\"/></svg>\n  \n  <span class=\"md-ellipsis\">\n    \n  \n    Rate Limiting\n  \n\n    \n  </span>\n  \n  \n\n      </a>\n    </li>\n  \n\n              \n            \n              \n                \n  \n  \n  \n  \n    <li class=\"md-nav__item\">\n      <a href=\"../../api/schema/\" class=\"md-nav__link\">\n        \n  \n  \n    <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-database\" viewBox=\"0 0 24 24\"><ellipse cx=\"12\" cy=\"5\" rx=\"9\" ry=\"3\"/><path d=\"M3 5v14a9 3 0 0 0 18 0V5\"/><path d=\"M3 12a9 3 0 0 0 18 0\"/></svg>\n  \n  <span class=\"md-ellipsis\">\n    \n  \n    Schema\n  \n\n    \n  </span>\n  \n  \n\n      </a>\n    </li>\n  \n\n              \n            \n          </ul>\n        </nav>\n      \n    </li>\n  \n\n    \n      \n      \n  \n  \n  \n  \n    \n    \n      \n        \n      \n        \n      \n    \n    \n    \n      \n        \n        \n      \n    \n    \n    <li class=\"md-nav__item md-nav__item--section md-nav__item--nested\">\n      \n        \n        \n        <input class=\"md-nav__toggle md-toggle \" type=\"checkbox\" id=\"__nav_5\" >\n        \n          \n          <label class=\"md-nav__link\" for=\"__nav_5\" id=\"__nav_5_label\" tabindex=\"\">\n            \n  \n  \n  <span class=\"md-ellipsis\">\n    \n  \n    Privacy\n  \n\n    \n  </span>\n  \n  \n\n            <span class=\"md-nav__icon md-icon\"></span>\n          </label>\n        \n        <nav class=\"md-nav\" data-md-level=\"1\" aria-labelledby=\"__nav_5_label\" aria-expanded=\"false\">\n          <label class=\"md-nav__title\" for=\"__nav_5\">\n            <span class=\"md-nav__icon md-icon\"></span>\n            \n  \n    Privacy\n  \n\n          </label>\n          <ul class=\"md-nav__list\" data-md-scrollfix>\n            \n              \n                \n  \n  \n  \n  \n    <li class=\"md-nav__item\">\n      <a href=\"../../privacy/mask/\" class=\"md-nav__link\">\n        \n  \n  \n    <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-eye-off\" viewBox=\"0 0 24 24\"><path d=\"M10.733 5.076a10.744 10.744 0 0 1 11.205 6.575 1 1 0 0 1 0 .696 10.8 10.8 0 0 1-1.444 2.49M14.084 14.158a3 3 0 0 1-4.242-4.242\"/><path d=\"M17.479 17.499a10.75 10.75 0 0 1-15.417-5.151 1 1 0 0 1 0-.696 10.75 10.75 0 0 1 4.446-5.143M2 2l20 20\"/></svg>\n  \n  <span class=\"md-ellipsis\">\n    \n  \n    Masking\n  \n\n    \n  </span>\n  \n  \n\n      </a>\n    </li>\n  \n\n              \n            \n              \n                \n  \n  \n  \n  \n    <li class=\"md-nav__item\">\n      <a href=\"../../privacy/security/\" class=\"md-nav__link\">\n        \n  \n  \n    <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-lock\" viewBox=\"0 0 24 24\"><rect width=\"18\" height=\"11\" x=\"3\" y=\"11\" rx=\"2\" ry=\"2\"/><path d=\"M7 11V7a5 5 0 0 1 10 0v4\"/></svg>\n  \n  <span class=\"md-ellipsis\">\n    \n  \n    Security\n  \n\n    \n  </span>\n  \n  \n\n      </a>\n    </li>\n  \n\n              \n            \n          </ul>\n        </nav>\n      \n    </li>\n  \n\n    \n      \n      \n  \n  \n  \n  \n    \n    \n      \n        \n      \n    \n    \n    \n      \n        \n        \n      \n    \n    \n    <li class=\"md-nav__item md-nav__item--section md-nav__item--nested\">\n      \n        \n        \n        <input class=\"md-nav__toggle md-toggle \" type=\"checkbox\" id=\"__nav_6\" >\n        \n          \n          <label class=\"md-nav__link\" for=\"__nav_6\" id=\"__nav_6_label\" tabindex=\"\">\n            \n  \n  \n  <span class=\"md-ellipsis\">\n    \n  \n    Core\n  \n\n    \n  </span>\n  \n  \n\n            <span class=\"md-nav__icon md-icon\"></span>\n          </label>\n        \n        <nav class=\"md-nav\" data-md-level=\"1\" aria-labelledby=\"__nav_6_label\" aria-expanded=\"false\">\n          <label class=\"md-nav__title\" for=\"__nav_6\">\n            <span class=\"md-nav__icon md-icon\"></span>\n            \n  \n    Core\n  \n\n          </label>\n          <ul class=\"md-nav__list\" data-md-scrollfix>\n            \n              \n                \n  \n  \n  \n  \n    <li class=\"md-nav__item\">\n      <a href=\"../../core/logging.md\" class=\"md-nav__link\">\n        \n  \n  \n  <span class=\"md-ellipsis\">\n    \n  \n    Logging\n  \n\n    \n  </span>\n  \n  \n\n      </a>\n    </li>\n  \n\n              \n            \n          </ul>\n        </nav>\n      \n    </li>\n  \n\n    \n      \n      \n  \n  \n  \n  \n    \n    \n      \n        \n      \n    \n    \n    \n      \n        \n        \n      \n    \n    \n    <li class=\"md-nav__item md-nav__item--section md-nav__item--nested\">\n      \n        \n        \n        <input class=\"md-nav__toggle md-toggle \" type=\"checkbox\" id=\"__nav_7\" >\n        \n          \n          <label class=\"md-nav__link\" for=\"__nav_7\" id=\"__nav_7_label\" tabindex=\"\">\n            \n  \n  \n  <span class=\"md-ellipsis\">\n    \n  \n    Store\n  \n\n    \n  </span>\n  \n  \n\n            <span class=\"md-nav__icon md-icon\"></span>\n          </label>\n        \n        <nav class=\"md-nav\" data-md-level=\"1\" aria-labelledby=\"__nav_7_label\" aria-expanded=\"false\">\n          <label class=\"md-nav__title\" for=\"__nav_7\">\n            <span class=\"md-nav__icon md-icon\"></span>\n            \n  \n    Store\n  \n\n          </label>\n          <ul class=\"md-nav__list\" data-md-scrollfix>\n            \n              \n                \n  \n  \n  \n  \n    <li class=\"md-nav__item\">\n      <a href=\"../../store/redis/\" class=\"md-nav__link\">\n        \n  \n  \n    <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-database\" viewBox=\"0 0 24 24\"><ellipse cx=\"12\" cy=\"5\" rx=\"9\" ry=\"3\"/><path d=\"M3 5v14a9 3 0 0 0 18 0V5\"/><path d=\"M3 12a9 3 0 0 0 18 0\"/></svg>\n  \n  <span class=\"md-ellipsis\">\n    \n  \n    Redis\n  \n\n    \n  </span>\n  \n  \n\n      </a>\n    </li>\n  \n\n              \n            \n          </ul>\n        </nav>\n      \n    </li>\n  \n\n    \n      \n      \n  \n  \n    \n  \n  \n  \n    \n    \n      \n        \n      \n    \n    \n    \n      \n        \n        \n      \n    \n    \n    <li class=\"md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested\">\n      \n        \n        \n        <input class=\"md-nav__toggle md-toggle \" type=\"checkbox\" id=\"__nav_8\" checked>\n        \n          \n          <label class=\"md-nav__link\" for=\"__nav_8\" id=\"__nav_8_label\" tabindex=\"\">\n            \n  \n  \n  <span class=\"md-ellipsis\">\n    \n  \n    Template\n  \n\n    \n  </span>\n  \n  \n\n            <span class=\"md-nav__icon md-icon\"></span>\n          </label>\n        \n        <nav class=\"md-nav\" data-md-level=\"1\" aria-labelledby=\"__nav_8_label\" aria-expanded=\"true\">\n          <label class=\"md-nav__title\" for=\"__nav_8\">\n            <span class=\"md-nav__icon md-icon\"></span>\n            \n  \n    Template\n  \n\n          </label>\n          <ul class=\"md-nav__list\" data-md-scrollfix>\n            \n              \n                \n  \n  \n    \n  \n  \n  \n    <li class=\"md-nav__item md-nav__item--active\">\n      \n      \n      \n      \n        \n      \n      \n        <label class=\"md-nav__link md-nav__link--active\" for=\"__toc\">\n          \n  \n  \n    <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-layout-template\" viewBox=\"0 0 24 24\"><rect width=\"18\" height=\"7\" x=\"3\" y=\"3\" rx=\"1\"/><rect width=\"9\" height=\"7\" x=\"3\" y=\"14\" rx=\"1\"/><rect width=\"5\" height=\"7\" x=\"16\" y=\"14\" rx=\"1\"/></svg>\n  \n  <span class=\"md-ellipsis\">\n    \n  \n    Rendering\n  \n\n    \n  </span>\n  \n  \n\n          <span class=\"md-nav__icon md-icon\"></span>\n        </label>\n      \n      <a href=\"././\" class=\"md-nav__link md-nav__link--active\">\n        \n  \n  \n    <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-layout-template\" viewBox=\"0 0 24 24\"><rect width=\"18\" height=\"7\" x=\"3\" y=\"3\" rx=\"1\"/><rect width=\"9\" height=\"7\" x=\"3\" y=\"14\" rx=\"1\"/><rect width=\"5\" height=\"7\" x=\"16\" y=\"14\" rx=\"1\"/></svg>\n  \n  <span class=\"md-ellipsis\">\n    \n  \n    Rendering\n  \n\n    \n  </span>\n  \n  \n\n      </a>\n      \n        \n\n\n<nav class=\"md-nav md-nav--secondary\" aria-label=\"On this page\">\n  \n  \n  \n    \n  \n  \n    <label class=\"md-nav__title\" for=\"__toc\">\n      <span class=\"md-nav__icon md-icon\"></span>\n      On this page\n    </label>\n    <ul class=\"md-nav__list\" data-md-component=\"toc\" data-md-scrollfix>\n      \n        <li class=\"md-nav__item\">\n  <a href=\"#installation\" class=\"md-nav__link\">\n    <span class=\"md-ellipsis\">\n      <span class=\"md-typeset\">\n        Installation\n      </span>\n    </span>\n  </a>\n  \n</li>\n      \n        <li class=\"md-nav__item\">\n  <a href=\"#quick-start\" class=\"md-nav__link\">\n    <span class=\"md-ellipsis\">\n      <span class=\"md-typeset\">\n        Quick start\n      </span>\n    </span>\n  </a>\n  \n</li>\n      \n        <li class=\"md-nav__item\">\n  <a href=\"#render_html_template\" class=\"md-nav__link\">\n    <span class=\"md-ellipsis\">\n      <span class=\"md-typeset\">\n        <code>render_html_template</code>\n      </span>\n    </span>\n  </a>\n  \n</li>\n      \n        <li class=\"md-nav__item\">\n  <a href=\"#render_html_string\" class=\"md-nav__link\">\n    <span class=\"md-ellipsis\">\n      <span class=\"md-typeset\">\n        <code>render_html_string</code>\n      </span>\n    </span>\n  </a>\n  \n</li>\n      \n        <li class=\"md-nav__item\">\n  <a href=\"#usage-with-mail\" class=\"md-nav__link\">\n    <span class=\"md-ellipsis\">\n      <span class=\"md-typeset\">\n        Usage with mail\n      </span>\n    </span>\n  </a>\n  \n</li>\n      \n    </ul>\n  \n</nav>\n      \n    </li>\n  \n\n              \n            \n          </ul>\n        </nav>\n      \n    </li>\n  \n\n    \n      \n      \n  \n  \n  \n  \n    \n    \n      \n        \n      \n    \n    \n    \n      \n        \n        \n      \n    \n    \n    <li class=\"md-nav__item md-nav__item--section md-nav__item--nested\">\n      \n        \n        \n        <input class=\"md-nav__toggle md-toggle \" type=\"checkbox\" id=\"__nav_9\" >\n        \n          \n          <label class=\"md-nav__link\" for=\"__nav_9\" id=\"__nav_9_label\" tabindex=\"\">\n            \n  \n  \n  <span class=\"md-ellipsis\">\n    \n  \n    Utils\n  \n\n    \n  </span>\n  \n  \n\n            <span class=\"md-nav__icon md-icon\"></span>\n          </label>\n        \n        <nav class=\"md-nav\" data-md-level=\"1\" aria-labelledby=\"__nav_9_label\" aria-expanded=\"false\">\n          <label class=\"md-nav__title\" for=\"__nav_9\">\n            <span class=\"md-nav__icon md-icon\"></span>\n            \n  \n    Utils\n  \n\n          </label>\n          <ul class=\"md-nav__list\" data-md-scrollfix>\n            \n              \n                \n  \n  \n  \n  \n    <li class=\"md-nav__item\">\n      <a href=\"../../utils/performance/\" class=\"md-nav__link\">\n        \n  \n  \n    <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-timer\" viewBox=\"0 0 24 24\"><path d=\"M10 2h4M12 14l3-3\"/><circle cx=\"12\" cy=\"14\" r=\"8\"/></svg>\n  \n  <span class=\"md-ellipsis\">\n    \n  \n    Performance\n  \n\n    \n  </span>\n  \n  \n\n      </a>\n    </li>\n  \n\n              \n            \n          </ul>\n        </nav>\n      \n    </li>\n  \n\n    \n  </ul>\n</nav>\n                  </div>\n                </div>\n              </div>\n            \n            \n              \n              <div class=\"md-sidebar md-sidebar--secondary\" data-md-component=\"sidebar\" data-md-type=\"toc\" >\n                <div class=\"md-sidebar__scrollwrap\">\n                  \n                    \n                    \n                    \n                      \n                    \n                    \n                      <input class=\"md-nav__toggle md-toggle\" type=\"checkbox\" id=\"__toc\">\n                      <div class=\"md-sidebar-button__wrapper\">\n                        <label class=\"md-sidebar-button\" for=\"__toc\"></label>\n                      </div>\n                    \n                  \n                  <div class=\"md-sidebar__inner\">\n                    \n\n\n<nav class=\"md-nav md-nav--secondary\" aria-label=\"On this page\">\n  \n  \n  \n    \n  \n  \n    <label class=\"md-nav__title\" for=\"__toc\">\n      <span class=\"md-nav__icon md-icon\"></span>\n      On this page\n    </label>\n    <ul class=\"md-nav__list\" data-md-component=\"toc\" data-md-scrollfix>\n      \n        <li class=\"md-nav__item\">\n  <a href=\"#installation\" class=\"md-nav__link\">\n    <span class=\"md-ellipsis\">\n      <span class=\"md-typeset\">\n        Installation\n      </span>\n    </span>\n  </a>\n  \n</li>\n      \n        <li class=\"md-nav__item\">\n  <a href=\"#quick-start\" class=\"md-nav__link\">\n    <span class=\"md-ellipsis\">\n      <span class=\"md-typeset\">\n        Quick start\n      </span>\n    </span>\n  </a>\n  \n</li>\n      \n        <li class=\"md-nav__item\">\n  <a href=\"#render_html_template\" class=\"md-nav__link\">\n    <span class=\"md-ellipsis\">\n      <span class=\"md-typeset\">\n        <code>render_html_template</code>\n      </span>\n    </span>\n  </a>\n  \n</li>\n      \n        <li class=\"md-nav__item\">\n  <a href=\"#render_html_string\" class=\"md-nav__link\">\n    <span class=\"md-ellipsis\">\n      <span class=\"md-typeset\">\n        <code>render_html_string</code>\n      </span>\n    </span>\n  </a>\n  \n</li>\n      \n        <li class=\"md-nav__item\">\n  <a href=\"#usage-with-mail\" class=\"md-nav__link\">\n    <span class=\"md-ellipsis\">\n      <span class=\"md-typeset\">\n        Usage with mail\n      </span>\n    </span>\n  </a>\n  \n</li>\n      \n    </ul>\n  \n</nav>\n                  </div>\n                </div>\n              </div>\n            \n          \n          \n            <div class=\"md-content\" data-md-component=\"content\">\n              \n                \n\n\n\n  \n\n\n  <nav class=\"md-path\" aria-label=\"Navigation\" >\n    <ol class=\"md-path__list\">\n      \n        \n  \n  \n    <li class=\"md-path__item\">\n      <a href=\"../..\" class=\"md-path__link\">\n        \n  <span class=\"md-ellipsis\">\n    Get started\n  </span>\n\n      </a>\n    </li>\n  \n\n      \n      \n        \n  \n  \n    \n    \n      <li class=\"md-path__item\">\n        <a href=\"././\" class=\"md-path__link\">\n          \n  <span class=\"md-ellipsis\">\n    Template\n  </span>\n\n        </a>\n      </li>\n    \n  \n\n      \n    </ol>\n  </nav>\n\n              \n              <article class=\"md-content__inner md-typeset\">\n                \n                  \n\n<h1 id=\"template-rendering\">Template Rendering<a class=\"headerlink\" href=\"#template-rendering\" title=\"Permanent link\">&para;</a></h1>\n<p>The <code>utkit.template.render</code> module provides HTML rendering utilities powered by <a href=\"https://jinja.palletsprojects.com/\">Jinja2</a>. It supports rendering from template files on disk and from raw template strings.</p>\n<h2 id=\"installation\">Installation<a class=\"headerlink\" href=\"#installation\" title=\"Permanent link\">&para;</a></h2>\n<p><code>jinja2</code> is part of the optional <code>standard</code> extras. Install <code>utkit</code> with the <code>standard</code> extra:</p>\n<div class=\"language-bash highlight\"><pre><span></span><code><span id=\"__span-0-1\"><a id=\"__codelineno-0-1\" name=\"__codelineno-0-1\" href=\"#__codelineno-0-1\"></a>pip<span class=\"w\"> </span>install<span class=\"w\"> </span><span class=\"s2\">&quot;utkit[standard]&quot;</span>\n</span></code></pre></div>\n<p>Or with <a href=\"https://docs.astral.sh/uv/\">uv</a>:</p>\n<div class=\"language-bash highlight\"><pre><span></span><code><span id=\"__span-1-1\"><a id=\"__codelineno-1-1\" name=\"__codelineno-1-1\" href=\"#__codelineno-1-1\"></a>uv<span class=\"w\"> </span>add<span class=\"w\"> </span><span class=\"s2\">&quot;utkit[standard]&quot;</span>\n</span></code></pre></div>\n<hr />\n<h2 id=\"quick-start\">Quick start<a class=\"headerlink\" href=\"#quick-start\" title=\"Permanent link\">&para;</a></h2>\n<p><strong>From a file:</strong></p>\n<div class=\"language-python highlight\"><pre><span></span><code><span id=\"__span-2-1\"><a id=\"__codelineno-2-1\" name=\"__codelineno-2-1\" href=\"#__codelineno-2-1\"></a><span class=\"kn\">from</span><span class=\"w\"> </span><span class=\"nn\">utkit.template.render</span><span class=\"w\"> </span><span class=\"kn\">import</span> <span class=\"n\">render_html_template</span>\n</span><span id=\"__span-2-2\"><a id=\"__codelineno-2-2\" name=\"__codelineno-2-2\" href=\"#__codelineno-2-2\"></a>\n</span><span id=\"__span-2-3\"><a id=\"__codelineno-2-3\" name=\"__codelineno-2-3\" href=\"#__codelineno-2-3\"></a><span class=\"n\">html</span> <span class=\"o\">=</span> <span class=\"n\">render_html_template</span><span class=\"p\">(</span>\n</span><span id=\"__span-2-4\"><a id=\"__codelineno-2-4\" name=\"__codelineno-2-4\" href=\"#__codelineno-2-4\"></a>    <span class=\"n\">template_name</span><span class=\"o\">=</span><span class=\"s2\">&quot;welcome.html&quot;</span><span class=\"p\">,</span>\n</span><span id=\"__span-2-5\"><a id=\"__codelineno-2-5\" name=\"__codelineno-2-5\" href=\"#__codelineno-2-5\"></a>    <span class=\"n\">context</span><span class=\"o\">=</span><span class=\"p\">{</span><span class=\"s2\">&quot;name&quot;</span><span class=\"p\">:</span> <span class=\"s2\">&quot;Alice&quot;</span><span class=\"p\">,</span> <span class=\"s2\">&quot;app&quot;</span><span class=\"p\">:</span> <span class=\"s2\">&quot;utkit&quot;</span><span class=\"p\">},</span>\n</span><span id=\"__span-2-6\"><a id=\"__codelineno-2-6\" name=\"__codelineno-2-6\" href=\"#__codelineno-2-6\"></a>    <span class=\"n\">template_dir</span><span class=\"o\">=</span><span class=\"s2\">&quot;templates&quot;</span><span class=\"p\">,</span>\n</span><span id=\"__span-2-7\"><a id=\"__codelineno-2-7\" name=\"__codelineno-2-7\" href=\"#__codelineno-2-7\"></a><span class=\"p\">)</span>\n</span></code></pre></div>\n<p><strong>From a string:</strong></p>\n<div class=\"language-python highlight\"><pre><span></span><code><span id=\"__span-3-1\"><a id=\"__codelineno-3-1\" name=\"__codelineno-3-1\" href=\"#__codelineno-3-1\"></a><span class=\"kn\">from</span><span class=\"w\"> </span><span class=\"nn\">utkit.template.render</span><span class=\"w\"> </span><span class=\"kn\">import</span> <span class=\"n\">render_html_string</span>\n</span><span id=\"__span-3-2\"><a id=\"__codelineno-3-2\" name=\"__codelineno-3-2\" href=\"#__codelineno-3-2\"></a>\n</span><span id=\"__span-3-3\"><a id=\"__codelineno-3-3\" name=\"__codelineno-3-3\" href=\"#__codelineno-3-3\"></a><span class=\"n\">html</span> <span class=\"o\">=</span> <span class=\"n\">render_html_string</span><span class=\"p\">(</span>\n</span><span id=\"__span-3-4\"><a id=\"__codelineno-3-4\" name=\"__codelineno-3-4\" href=\"#__codelineno-3-4\"></a>    <span class=\"n\">template_str</span><span class=\"o\">=</span><span class=\"s2\">&quot;&lt;h1&gt;Hello, {{ name }}!&lt;/h1&gt;&quot;</span><span class=\"p\">,</span>\n</span><span id=\"__span-3-5\"><a id=\"__codelineno-3-5\" name=\"__codelineno-3-5\" href=\"#__codelineno-3-5\"></a>    <span class=\"n\">context</span><span class=\"o\">=</span><span class=\"p\">{</span><span class=\"s2\">&quot;name&quot;</span><span class=\"p\">:</span> <span class=\"s2\">&quot;Alice&quot;</span><span class=\"p\">},</span>\n</span><span id=\"__span-3-6\"><a id=\"__codelineno-3-6\" name=\"__codelineno-3-6\" href=\"#__codelineno-3-6\"></a><span class=\"p\">)</span>\n</span></code></pre></div>\n<hr />\n<h2 id=\"render_html_template\"><code>render_html_template</code><a class=\"headerlink\" href=\"#render_html_template\" title=\"Permanent link\">&para;</a></h2>\n<p>Renders an HTML template file using Jinja2's <code>FileSystemLoader</code>. HTML and XML autoescaping is enabled automatically.</p>\n<div class=\"language-python highlight\"><pre><span></span><code><span id=\"__span-4-1\"><a id=\"__codelineno-4-1\" name=\"__codelineno-4-1\" href=\"#__codelineno-4-1\"></a><span class=\"k\">def</span><span class=\"w\"> </span><span class=\"nf\">render_html_template</span><span class=\"p\">(</span>\n</span><span id=\"__span-4-2\"><a id=\"__codelineno-4-2\" name=\"__codelineno-4-2\" href=\"#__codelineno-4-2\"></a>    <span class=\"n\">template_name</span><span class=\"p\">:</span> <span class=\"nb\">str</span><span class=\"p\">,</span>\n</span><span id=\"__span-4-3\"><a id=\"__codelineno-4-3\" name=\"__codelineno-4-3\" href=\"#__codelineno-4-3\"></a>    <span class=\"n\">context</span><span class=\"p\">:</span> <span class=\"n\">Dict</span><span class=\"p\">,</span>\n</span><span id=\"__span-4-4\"><a id=\"__codelineno-4-4\" name=\"__codelineno-4-4\" href=\"#__codelineno-4-4\"></a>    <span class=\"n\">template_dir</span><span class=\"p\">:</span> <span class=\"nb\">str</span> <span class=\"o\">=</span> <span class=\"s2\">&quot;templates&quot;</span><span class=\"p\">,</span>\n</span><span id=\"__span-4-5\"><a id=\"__codelineno-4-5\" name=\"__codelineno-4-5\" href=\"#__codelineno-4-5\"></a><span class=\"p\">)</span> <span class=\"o\">-&gt;</span> <span class=\"nb\">str</span>\n</span></code></pre></div>\n<table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Type</th>\n<th>Default</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>template_name</code></td>\n<td><code>str</code></td>\n<td>—</td>\n<td>File name of the template relative to <code>template_dir</code> (e.g. <code>\"email.html\"</code>)</td>\n</tr>\n<tr>\n<td><code>context</code></td>\n<td><code>Dict</code></td>\n<td>—</td>\n<td>Dictionary of variables passed into the template</td>\n</tr>\n<tr>\n<td><code>template_dir</code></td>\n<td><code>str</code></td>\n<td><code>\"templates\"</code></td>\n<td>Path to the directory containing template files</td>\n</tr>\n</tbody>\n</table>\n<p><strong>Returns:</strong> <code>str</code> — the fully rendered HTML string.</p>\n<div class=\"language-python highlight\"><pre><span></span><code><span id=\"__span-5-1\"><a id=\"__codelineno-5-1\" name=\"__codelineno-5-1\" href=\"#__codelineno-5-1\"></a><span class=\"c1\"># templates/invoice.html</span>\n</span><span id=\"__span-5-2\"><a id=\"__codelineno-5-2\" name=\"__codelineno-5-2\" href=\"#__codelineno-5-2\"></a><span class=\"c1\"># &lt;p&gt;Invoice #{{ number }} for {{ customer }}&lt;/p&gt;</span>\n</span><span id=\"__span-5-3\"><a id=\"__codelineno-5-3\" name=\"__codelineno-5-3\" href=\"#__codelineno-5-3\"></a>\n</span><span id=\"__span-5-4\"><a id=\"__codelineno-5-4\" name=\"__codelineno-5-4\" href=\"#__codelineno-5-4\"></a><span class=\"n\">html</span> <span class=\"o\">=</span> <span class=\"n\">render_html_template</span><span class=\"p\">(</span>\n</span><span id=\"__span-5-5\"><a id=\"__codelineno-5-5\" name=\"__codelineno-5-5\" href=\"#__codelineno-5-5\"></a>    <span class=\"s2\">&quot;invoice.html&quot;</span><span class=\"p\">,</span>\n</span><span id=\"__span-5-6\"><a id=\"__codelineno-5-6\" name=\"__codelineno-5-6\" href=\"#__codelineno-5-6\"></a>    <span class=\"p\">{</span><span class=\"s2\">&quot;number&quot;</span><span class=\"p\">:</span> <span class=\"mi\">1042</span><span class=\"p\">,</span> <span class=\"s2\">&quot;customer&quot;</span><span class=\"p\">:</span> <span class=\"s2\">&quot;Acme Corp&quot;</span><span class=\"p\">},</span>\n</span><span id=\"__span-5-7\"><a id=\"__codelineno-5-7\" name=\"__codelineno-5-7\" href=\"#__codelineno-5-7\"></a>    <span class=\"n\">template_dir</span><span class=\"o\">=</span><span class=\"s2\">&quot;templates&quot;</span><span class=\"p\">,</span>\n</span><span id=\"__span-5-8\"><a id=\"__codelineno-5-8\" name=\"__codelineno-5-8\" href=\"#__codelineno-5-8\"></a><span class=\"p\">)</span>\n</span></code></pre></div>\n<hr />\n<h2 id=\"render_html_string\"><code>render_html_string</code><a class=\"headerlink\" href=\"#render_html_string\" title=\"Permanent link\">&para;</a></h2>\n<p>Renders HTML directly from a Jinja2 template string. Autoescaping is always enabled.</p>\n<div class=\"language-python highlight\"><pre><span></span><code><span id=\"__span-6-1\"><a id=\"__codelineno-6-1\" name=\"__codelineno-6-1\" href=\"#__codelineno-6-1\"></a><span class=\"k\">def</span><span class=\"w\"> </span><span class=\"nf\">render_html_string</span><span class=\"p\">(</span><span class=\"n\">template_str</span><span class=\"p\">:</span> <span class=\"nb\">str</span><span class=\"p\">,</span> <span class=\"n\">context</span><span class=\"p\">:</span> <span class=\"n\">Dict</span><span class=\"p\">)</span> <span class=\"o\">-&gt;</span> <span class=\"nb\">str</span>\n</span></code></pre></div>\n<table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>template_str</code></td>\n<td><code>str</code></td>\n<td>A Jinja2 template string</td>\n</tr>\n<tr>\n<td><code>context</code></td>\n<td><code>Dict</code></td>\n<td>Dictionary of variables passed into the template</td>\n</tr>\n</tbody>\n</table>\n<p><strong>Returns:</strong> <code>str</code> — the fully rendered HTML string.</p>\n<div class=\"language-python highlight\"><pre><span></span><code><span id=\"__span-7-1\"><a id=\"__codelineno-7-1\" name=\"__codelineno-7-1\" href=\"#__codelineno-7-1\"></a><span class=\"n\">html</span> <span class=\"o\">=</span> <span class=\"n\">render_html_string</span><span class=\"p\">(</span>\n</span><span id=\"__span-7-2\"><a id=\"__codelineno-7-2\" name=\"__codelineno-7-2\" href=\"#__codelineno-7-2\"></a>    <span class=\"s2\">&quot;&lt;p&gt;Welcome, &lt;strong&gt;{{ name }}&lt;/strong&gt;!&lt;/p&gt;&quot;</span><span class=\"p\">,</span>\n</span><span id=\"__span-7-3\"><a id=\"__codelineno-7-3\" name=\"__codelineno-7-3\" href=\"#__codelineno-7-3\"></a>    <span class=\"p\">{</span><span class=\"s2\">&quot;name&quot;</span><span class=\"p\">:</span> <span class=\"s2\">&quot;Alice&quot;</span><span class=\"p\">},</span>\n</span><span id=\"__span-7-4\"><a id=\"__codelineno-7-4\" name=\"__codelineno-7-4\" href=\"#__codelineno-7-4\"></a><span class=\"p\">)</span>\n</span><span id=\"__span-7-5\"><a id=\"__codelineno-7-5\" name=\"__codelineno-7-5\" href=\"#__codelineno-7-5\"></a><span class=\"c1\"># &lt;p&gt;Welcome, &lt;strong&gt;Alice&lt;/strong&gt;!&lt;/p&gt;</span>\n</span></code></pre></div>\n<hr />\n<h2 id=\"usage-with-mail\">Usage with mail<a class=\"headerlink\" href=\"#usage-with-mail\" title=\"Permanent link\">&para;</a></h2>\n<p><code>render_html_template</code> pairs naturally with <code>utkit.communication.mail.smtp</code> to send dynamic HTML emails:</p>\n<div class=\"language-python highlight\"><pre><span></span><code><span id=\"__span-8-1\"><a id=\"__codelineno-8-1\" name=\"__codelineno-8-1\" href=\"#__codelineno-8-1\"></a><span class=\"kn\">from</span><span class=\"w\"> </span><span class=\"nn\">utkit.template.render</span><span class=\"w\"> </span><span class=\"kn\">import</span> <span class=\"n\">render_html_template</span>\n</span><span id=\"__span-8-2\"><a id=\"__codelineno-8-2\" name=\"__codelineno-8-2\" href=\"#__codelineno-8-2\"></a><span class=\"kn\">from</span><span class=\"w\"> </span><span class=\"nn\">utkit.communication.mail.smtp</span><span class=\"w\"> </span><span class=\"kn\">import</span> <span class=\"n\">SMTPConfig</span><span class=\"p\">,</span> <span class=\"n\">MailMessage</span><span class=\"p\">,</span> <span class=\"n\">send_mail</span>\n</span><span id=\"__span-8-3\"><a id=\"__codelineno-8-3\" name=\"__codelineno-8-3\" href=\"#__codelineno-8-3\"></a>\n</span><span id=\"__span-8-4\"><a id=\"__codelineno-8-4\" name=\"__codelineno-8-4\" href=\"#__codelineno-8-4\"></a><span class=\"n\">config</span> <span class=\"o\">=</span> <span class=\"n\">SMTPConfig</span><span class=\"p\">(</span>\n</span><span id=\"__span-8-5\"><a id=\"__codelineno-8-5\" name=\"__codelineno-8-5\" href=\"#__codelineno-8-5\"></a>    <span class=\"n\">host</span><span class=\"o\">=</span><span class=\"s2\">&quot;smtp.gmail.com&quot;</span><span class=\"p\">,</span>\n</span><span id=\"__span-8-6\"><a id=\"__codelineno-8-6\" name=\"__codelineno-8-6\" href=\"#__codelineno-8-6\"></a>    <span class=\"n\">port</span><span class=\"o\">=</span><span class=\"mi\">587</span><span class=\"p\">,</span>\n</span><span id=\"__span-8-7\"><a id=\"__codelineno-8-7\" name=\"__codelineno-8-7\" href=\"#__codelineno-8-7\"></a>    <span class=\"n\">username</span><span class=\"o\">=</span><span class=\"s2\">&quot;you@gmail.com&quot;</span><span class=\"p\">,</span>\n</span><span id=\"__span-8-8\"><a id=\"__codelineno-8-8\" name=\"__codelineno-8-8\" href=\"#__codelineno-8-8\"></a>    <span class=\"n\">password</span><span class=\"o\">=</span><span class=\"s2\">&quot;your-app-password&quot;</span><span class=\"p\">,</span>\n</span><span id=\"__span-8-9\"><a id=\"__codelineno-8-9\" name=\"__codelineno-8-9\" href=\"#__codelineno-8-9\"></a><span class=\"p\">)</span>\n</span><span id=\"__span-8-10\"><a id=\"__codelineno-8-10\" name=\"__codelineno-8-10\" href=\"#__codelineno-8-10\"></a>\n</span><span id=\"__span-8-11\"><a id=\"__codelineno-8-11\" name=\"__codelineno-8-11\" href=\"#__codelineno-8-11\"></a><span class=\"n\">html</span> <span class=\"o\">=</span> <span class=\"n\">render_html_template</span><span class=\"p\">(</span>\n</span><span id=\"__span-8-12\"><a id=\"__codelineno-8-12\" name=\"__codelineno-8-12\" href=\"#__codelineno-8-12\"></a>    <span class=\"s2\">&quot;welcome_email.html&quot;</span><span class=\"p\">,</span>\n</span><span id=\"__span-8-13\"><a id=\"__codelineno-8-13\" name=\"__codelineno-8-13\" href=\"#__codelineno-8-13\"></a>    <span class=\"p\">{</span><span class=\"s2\">&quot;name&quot;</span><span class=\"p\">:</span> <span class=\"s2\">&quot;Alice&quot;</span><span class=\"p\">,</span> <span class=\"s2\">&quot;app_url&quot;</span><span class=\"p\">:</span> <span class=\"s2\">&quot;https://example.com&quot;</span><span class=\"p\">},</span>\n</span><span id=\"__span-8-14\"><a id=\"__codelineno-8-14\" name=\"__codelineno-8-14\" href=\"#__codelineno-8-14\"></a><span class=\"p\">)</span>\n</span><span id=\"__span-8-15\"><a id=\"__codelineno-8-15\" name=\"__codelineno-8-15\" href=\"#__codelineno-8-15\"></a>\n</span><span id=\"__span-8-16\"><a id=\"__codelineno-8-16\" name=\"__codelineno-8-16\" href=\"#__codelineno-8-16\"></a><span class=\"n\">message</span> <span class=\"o\">=</span> <span class=\"n\">MailMessage</span><span class=\"p\">(</span>\n</span><span id=\"__span-8-17\"><a id=\"__codelineno-8-17\" name=\"__codelineno-8-17\" href=\"#__codelineno-8-17\"></a>    <span class=\"n\">subject</span><span class=\"o\">=</span><span class=\"s2\">&quot;Welcome to utkit&quot;</span><span class=\"p\">,</span>\n</span><span id=\"__span-8-18\"><a id=\"__codelineno-8-18\" name=\"__codelineno-8-18\" href=\"#__codelineno-8-18\"></a>    <span class=\"n\">from_address</span><span class=\"o\">=</span><span class=\"s2\">&quot;you@gmail.com&quot;</span><span class=\"p\">,</span>\n</span><span id=\"__span-8-19\"><a id=\"__codelineno-8-19\" name=\"__codelineno-8-19\" href=\"#__codelineno-8-19\"></a>    <span class=\"n\">to</span><span class=\"o\">=</span><span class=\"p\">[</span><span class=\"s2\">&quot;alice@example.com&quot;</span><span class=\"p\">],</span>\n</span><span id=\"__span-8-20\"><a id=\"__codelineno-8-20\" name=\"__codelineno-8-20\" href=\"#__codelineno-8-20\"></a>    <span class=\"n\">html</span><span class=\"o\">=</span><span class=\"n\">html</span><span class=\"p\">,</span>\n</span><span id=\"__span-8-21\"><a id=\"__codelineno-8-21\" name=\"__codelineno-8-21\" href=\"#__codelineno-8-21\"></a><span class=\"p\">)</span>\n</span><span id=\"__span-8-22\"><a id=\"__codelineno-8-22\" name=\"__codelineno-8-22\" href=\"#__codelineno-8-22\"></a>\n</span><span id=\"__span-8-23\"><a id=\"__codelineno-8-23\" name=\"__codelineno-8-23\" href=\"#__codelineno-8-23\"></a><span class=\"n\">send_mail</span><span class=\"p\">(</span><span class=\"n\">config</span><span class=\"p\">,</span> <span class=\"n\">message</span><span class=\"p\">)</span>\n</span></code></pre></div>\n\n\n\n\n\n\n\n\n\n  \n  \n\n\n\n\n\n\n                \n              </article>\n            </div>\n          \n          \n  <script>var tabs=__md_get(\"__tabs\");if(Array.isArray(tabs))e:for(var set of document.querySelectorAll(\".tabbed-set\")){var labels=set.querySelector(\".tabbed-labels\");for(var tab of tabs)for(var label of labels.getElementsByTagName(\"label\"))if(label.innerText.trim()===tab){var input=document.getElementById(label.htmlFor);input.checked=!0;continue e}}</script>\n\n<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith(\"__tabbed_\"))</script>\n        </div>\n        \n          <button type=\"button\" class=\"md-top md-icon\" data-md-component=\"top\" hidden>\n  \n  <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-circle-arrow-up\" viewBox=\"0 0 24 24\"><circle cx=\"12\" cy=\"12\" r=\"10\"/><path d=\"m16 12-4-4-4 4M12 16V8\"/></svg>\n  Back to top\n</button>\n        \n      </main>\n      \n        <footer class=\"md-footer\">\n  \n    \n      \n      <nav class=\"md-footer__inner md-grid\" aria-label=\"Footer\" >\n        \n          \n          <a href=\"../../store/redis/\" class=\"md-footer__link md-footer__link--prev\" aria-label=\"Previous: Redis\">\n            <div class=\"md-footer__button md-icon\">\n              \n              <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-arrow-left\" viewBox=\"0 0 24 24\"><path d=\"m12 19-7-7 7-7M19 12H5\"/></svg>\n            </div>\n            <div class=\"md-footer__title\">\n              <span class=\"md-footer__direction\">\n                Previous\n              </span>\n              <div class=\"md-ellipsis\">\n                Redis\n              </div>\n            </div>\n          </a>\n        \n        \n          \n          <a href=\"../../utils/performance/\" class=\"md-footer__link md-footer__link--next\" aria-label=\"Next: Performance\">\n            <div class=\"md-footer__title\">\n              <span class=\"md-footer__direction\">\n                Next\n              </span>\n              <div class=\"md-ellipsis\">\n                Performance\n              </div>\n            </div>\n            <div class=\"md-footer__button md-icon\">\n              \n              <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" class=\"lucide lucide-arrow-right\" viewBox=\"0 0 24 24\"><path d=\"M5 12h14M12 5l7 7-7 7\"/></svg>\n            </div>\n          </a>\n        \n      </nav>\n    \n  \n  <div class=\"md-footer-meta md-typeset\">\n    <div class=\"md-footer-meta__inner md-grid\">\n      <div class=\"md-copyright\">\n  \n    <div class=\"md-copyright__highlight\">\n      Copyright &copy; 2026 TINS PJ. All rights reserved.\n\n    </div>\n  \n  \n    Made with\n    <a href=\"https://zensical.org/\" target=\"_blank\" rel=\"noopener\">\n      Zensical\n    </a>\n  \n</div>\n      \n    </div>\n  </div>\n</footer>\n      \n    </div>\n    <div class=\"md-dialog\" data-md-component=\"dialog\">\n      <div class=\"md-dialog__inner md-typeset\"></div>\n    </div>\n    \n    \n    \n      \n      \n      <script id=\"__config\" type=\"application/json\">{\"annotate\":null,\"base\":\"../..\",\"features\":[\"announce.dismiss\",\"content.code.annotate\",\"content.code.copy\",\"content.code.select\",\"content.footnote.tooltips\",\"content.tabs.link\",\"content.tooltips\",\"navigation.footer\",\"navigation.indexes\",\"navigation.instant\",\"navigation.instant.prefetch\",\"navigation.path\",\"navigation.sections\",\"navigation.top\",\"navigation.tracking\",\"search.highlight\"],\"search\":\"../../assets/javascripts/workers/search.e2d2d235.min.js\",\"tags\":null,\"translations\":{\"clipboard.copied\":\"Copied to clipboard\",\"clipboard.copy\":\"Copy to clipboard\",\"search.result.more.one\":\"1 more on this page\",\"search.result.more.other\":\"# more on this page\",\"search.result.none\":\"No matching documents\",\"search.result.one\":\"1 matching document\",\"search.result.other\":\"# matching documents\",\"search.result.placeholder\":\"Type to start searching\",\"search.result.term.missing\":\"Missing\",\"select.version\":\"Select version\"},\"version\":null}</script>\n    \n    \n      <script src=\"../../assets/javascripts/bundle.dbc0afdc.min.js\"></script>\n      \n    \n  </body>\n</html>",
+  "hash": 361807550503777080
+}