Merge pull request #27 from pythonnz/danny-pydantic

Use pydantic models for configuration

Author: dannyadair

.pre-commit-config.yaml

@@ -43,12 +43,11 @@ repos:
     rev: v3.3.4
     hooks:
       - id: pylint
-        args:
-          - --rcfile=.pylintrc
         additional_dependencies:
           - "cairosvg"
           - "click"
           - "jinja2"
+          - "pydantic"
           - "pypdf"
           - "pytest"
-          - "pyyaml"
+          - "ruamel.yaml"

.pylintrc

@@ -1,8 +1,6 @@
 title: "Custom Location Example"
 description: "This page uses custom directory structure"
 template:
-  # If you just wrote this directly it would be relative to the templates directory
-  # We want it to be relative to the config file, so use path:
   path: "../other_templates/custom_page.svg.j2"
 detailed_description:
   "This example demonstrates custom file locations in pdfbaker. The template file is in

examples/custom_locations/other_pages/custom_page.yaml

@@ -5,12 +5,12 @@
 import urllib.request
 from datetime import datetime
 
-from pdfbaker.document import PDFBakerDocument
+from pdfbaker.document import Document
 from pdfbaker.errors import PDFBakerError
 from pdfbaker.processing import wordwrap
 
 
-def process_document(document: PDFBakerDocument) -> None:
+def process_document(document: Document) -> None:
     """Process document with live XKCD comic."""
     try:
         # Fetch latest XKCD
@@ -29,7 +29,7 @@ def process_document(document: PDFBakerDocument) -> None:
         wrapped_alt_text = wordwrap(data["alt"], max_chars=60)
 
         # Update config/template context with XKCD info
-        document.config["xkcd"] = {
+        document.config.xkcd = {
             "title": data["title"],
             "alt_text": data["alt"],
             "alt_text_lines": wrapped_alt_text,

examples/custom_processing/bake.py

@@ -2,5 +2,11 @@ documents:
   - minimal
   - regular
   - variants
-  - ./custom_locations/your_directory
+  - path: ./custom_locations/your_directory
+    name: custom_locations
   - custom_processing
+
+custom_stuff:
+  - year: 2025
+  - nested:
+      - anything: really

examples/examples.yaml

@@ -5,21 +5,21 @@ variants:
   - name: Basic
     style:
       color: "#3498db"
-      features:
-        - "Single page layout"
-        - "Basic styling"
+    features:
+      - "Single page layout"
+      - "Basic styling"
   - name: Premium
     style:
       color: "#2ecc71"
-      features:
-        - "Single page layout"
-        - "Premium styling"
-        - "Custom colors"
+    features:
+      - "Single page layout"
+      - "Premium styling"
+      - "Custom colors"
   - name: Enterprise
     style:
       color: "#e74c3c"
-      features:
-        - "Single page layout"
-        - "Enterprise styling"
-        - "Custom colors"
-        - "Priority support"
+    features:
+      - "Single page layout"
+      - "Enterprise styling"
+      - "Custom colors"
+      - "Priority support"

examples/variants/config.yaml

@@ -8,7 +8,7 @@
 
   <!-- Features -->
   <text x="20" y="90" font-family="Arial" font-size="10" font-weight="bold" fill="#333">Features:</text>
-  {% for feature in variant.style.features %}
+  {% for feature in variant.features %}
   <text x="30" y="{{ 110 + loop.index0 * 16 }}" font-family="Arial" font-size="9" fill="#333">• {{ feature }}</text>
   {% endfor %}
 </svg>

examples/variants/templates/main.svg.j2

@@ -9,8 +9,9 @@ dependencies = [
     "cairosvg",
     "click",
     "jinja2",
+    "pydantic",
     "pypdf",
-    "pyyaml",
+    "ruamel.yaml",
 ]
 readme = "README.md"
 requires-python = ">= 3.11"
@@ -42,3 +43,17 @@ addopts = "-v --cov=pdfbaker --cov-report=term-missing"
 
 [tool.coverage.run]
 source = ["pdfbaker"]
+
+[tool.pylint.main]
+py-version = "3.11"
+ignore-paths = ["tests/"]
+init-hook = "import sys; sys.path.insert(0, 'src')"
+
+[tool.pylint.messages_control]
+disable = ["W0511"]  # Disable TODO/FIXME warnings
+
+[tool.pylint.reports]
+msg-template = "{path}:{line}: [{msg_id}({symbol}), {obj}] {msg}"
+output-format = "colorized"
+reports = "no"
+score = "no"

pyproject.toml

@@ -7,7 +7,7 @@
 import click
 
 from pdfbaker import __version__
-from pdfbaker.baker import PDFBaker, PDFBakerOptions
+from pdfbaker.baker import Baker, BakerOptions
 from pdfbaker.errors import DocumentNotFoundError, PDFBakerError
 
 logger = logging.getLogger(__name__)
@@ -54,20 +54,20 @@ def bake(
         keep_build = True
 
     try:
-        options = PDFBakerOptions(
+        options = BakerOptions(
             quiet=quiet,
             verbose=verbose,
             trace=trace,
             keep_build=keep_build,
         )
-        baker = PDFBaker(config_file, options=options)
+        baker = Baker(config_file, options=options)
         success = baker.bake(document_names=documents if documents else None)
         sys.exit(0 if success else 1)
     except DocumentNotFoundError as exc:
-        logger.error(str(exc))
+        logger.error("❌ %s", str(exc))
         sys.exit(2)
     except PDFBakerError as exc:
-        logger.error(str(exc))
+        logger.error("❌ %s", str(exc))
         sys.exit(1)