Merge pull request #3 from laurierloi/pdf-support-weasyprint

Pdf support weasyprint

.gitignore

@@ -22,6 +22,7 @@ __pycache__
 # Built examples
 examples/*
 tutorial/*
+outputs/*
 !examples/*.yml
 !tutorial/*.yml
 !tutorial/*.md

requirements.txt

@@ -1,3 +1,4 @@
+# need to install pango > 1.44.0
 click
 graphviz
 pillow
@@ -5,3 +6,4 @@ pyyaml
 setuptools
 tabulate
 jinja2
+weasyprint

src/wireviz/templates/bom.html

@@ -1,7 +1,7 @@
 <style>
   .A4 #bom { /* BOM on top of title block */
     position: absolute;
-    bottom: calc({{ titleblock_rows + 1 }} * 4.25mm);
+    bottom: {{ (titleblock_rows + 1)  * 4.25 }}mm;
     right: 0;
   }
 

src/wireviz/templates/din-6771.html

@@ -38,7 +38,7 @@
       position: relative;
     }
 
-    .A4, .sheetsize_default { /* portrait */
+    .A4 { /* portrait */
       width: 180mm;
       height: 277mm;
     }
@@ -62,12 +62,19 @@
       {% set bottom_rows = [bom_rows, titleblock_rows]|max + 1 %}
     {% endif %}
 
+    .A4 #diagram, .A3 #diagram {
+        height: {{ 277 - bottom_rows * 4.25 }}mm;
+    }
+
+    .A2 #diagram {
+        height: {{ 400 - bottom_rows * 4.25 }}mm;
+    }
+
     #diagram {
       position: relative;
       top: 0;
       left: 0;
       max-width: 100%;
-      height: calc(100% - {{ bottom_rows }}  * 4.25mm);
       text-align: center;
       vertical-align: middle;
     }
@@ -85,14 +92,13 @@
   <style type="text/css" media="print">
 
     @page {
-      size: auto;
+      size: {{ sheetsize }} {{ orientation }};
       margin: 0;
     }
 
-    /* TODO: auto-adjust based on portrait (larger margin on left) or landscape (larger margin on top) */
     #page {
-      margin: 10mm;
-      margin-left: 20mm;
+      margin-top: 10mm;
+      margin-left: 15mm; /* TODO: maybe scale this value depending on sheetsize */
     }
 
   </style>

src/wireviz/templates/notes.html

@@ -2,9 +2,9 @@
   .A4 #notes { /* NOTES on top of BOM */
     position: absolute;
     {% if show_bom %}
-    bottom: calc({{ titleblock_rows + bom_rows + 2 }} * 4.25mm);
+    bottom: {{ (titleblock_rows + bom_rows + 2) * 4.25 }}mm;
     {% else %}
-    bottom: calc({{ titleblock_rows + 1 }} * 4.25mm);
+    bottom: {{ (titleblock_rows + 1) * 4.25 }}mm;
     {% endif %}
     right: 0;
   }
@@ -12,11 +12,11 @@
   .A3 #notes, .A2 #notes { /* NOTES on top of title block */
     position: absolute;
     {% if notes_on_right %}
-    bottom: calc({{ titleblock_rows + 1 }} * 4.25mm);
+    bottom: {{ (titleblock_rows + 1) * 4.25 }}mm;
     right: 0;
     {% else %}
     {% if show_bom %}
-    bottom: calc({{ bom_rows + 1 }} * 4.25mm);
+    bottom: {{ (bom_rows + 1) * 4.25 }}mm;
     {% else %}
     bottom: 0;
     {% endif %}

src/wireviz/templates/titleblock.html

@@ -1,13 +1,8 @@
 <style>
   #titleblock {
     position: absolute;
-    bottom: 0mm;
-    right: -0mm;
-  }
-
-  #titleblock {
-    width: 180mm;
-    height: calc({{ titleblock_rows }} * 4.25mm));
+    bottom: 0;
+    right: 0;
   }
 
   #titleblock table, th, td {
@@ -108,7 +103,7 @@
 
 <!-- START OF TEMPLATE --!>
 <div id="titleblock">
-  <table id="titleblock">
+  <table>
     <tr> <!-- ROW 1 --!>
       <!-- REVISIONS            Column 1 to 4 --!>
       {{ revision(1) }}

src/wireviz/tools/build_examples.py

@@ -37,7 +37,7 @@ groups = {
 
 input_extensions = [".yml"]
 extensions_not_containing_graphviz_output = [".gv", ".bom.tsv"]
-extensions_containing_graphviz_output = [".png", ".svg", ".html"]
+extensions_containing_graphviz_output = [".png", ".svg", ".html", ".pdf"]
 generated_extensions = (
     extensions_not_containing_graphviz_output + extensions_containing_graphviz_output
 )
@@ -68,7 +68,7 @@ def build_generated(groupkeys):
             try:
                 res = cli([
                     "--formats",
-                    "ghpst",
+                    "ghpstPb",
                     str(yaml_file),
                     "--prepend",
                     yaml_file.parent / "metadata.yml"

src/wireviz/wv_cli.py

@@ -14,6 +14,7 @@ from wireviz import APP_NAME, __version__
 from wireviz.wv_bom import bom_list
 from wireviz.wv_utils import bom2tsv
 from wireviz.wv_harness_quantity import HarnessQuantity
+from wireviz.wv_output import generate_pdf_output
 
 format_codes = {
     "c": "csv",
@@ -126,9 +127,11 @@ def cli(files, formats, prepend, output_dir, output_name, version, use_qty_multi
     harness = None
     shared_bom = {}
     sheet_current = 1
+    output_names = []
     # run WireVIz on each input file
     for _file in files:
         _output_name = _file.stem if not output_name else output_name
+        output_names.append(_output_dir / _output_name)
 
         print("Input file:  ", _file)
         print(
@@ -155,6 +158,9 @@ def cli(files, formats, prepend, output_dir, output_name, version, use_qty_multi
         )
         shared_bom = ret["shared_bom"]
 
+    if 'pdf' in output_formats and 'html' in output_formats and len(output_names) > 1:
+        generate_pdf_output(output_names)
+
     # TODO: move shared bom generation to a method?
     if "shared_bom" in output_formats:
         shared_bom_file = (_output_dir / "shared_bom").with_suffix(".tsv")

src/wireviz/wv_harness.py

@@ -30,7 +30,7 @@ from wireviz.wv_graphviz import (
     parse_arrow_str,
     set_dot_basics,
 )
-from wireviz.wv_output import embed_svg_images_file, generate_html_output
+from wireviz.wv_output import embed_svg_images_file, generate_html_output, generate_pdf_output
 from wireviz.wv_utils import bom2tsv
 
 
@@ -394,8 +394,7 @@ class Harness:
             generate_html_output(filename, bomlist, self.metadata, self.options)
         # PDF output
         if "pdf" in fmt:
-            # TODO: implement PDF output
-            print("PDF output is not yet supported")
+            generate_pdf_output(filename)
         # delete SVG if not needed
         if "html" in fmt and not "svg" in fmt:
             # SVG file was just needed to generate HTML

src/wireviz/wv_output.py

@@ -3,7 +3,10 @@
 import base64
 import re
 from pathlib import Path
-from typing import List, Union
+from typing import Dict, List, Union
+import logging
+
+from weasyprint import HTML
 
 import wireviz  # for doing wireviz.__file__
 from wireviz.wv_dataclasses import Metadata, Options
@@ -56,6 +59,28 @@ def embed_svg_images_file(
         filename_out.replace(filename_in)
 
 
+def generate_pdf_output(
+    filename_list: List[Path],
+    options: Dict=None,
+):
+    '''Generate a pdf output, options are ignored for now, expect the formatting
+       to be done within the html files
+    '''
+    if isinstance(filename_list, Path):
+        filename_list = [filename_list]
+        output_path = filename_list[0].with_suffix('.pdf')
+    else:
+        output_dir = filename_list[0].parent
+        output_path = (output_dir / output_dir.name).with_suffix('.pdf')
+
+    filepath_list = [f.with_suffix('.html') for f in filename_list]
+
+    print(f'Generating pdf output: {output_path}')
+    files_html = [HTML(path) for path in filepath_list]
+    documents = [f.render() for f in files_html]
+    all_pages = [p for doc in documents for p in doc.pages]
+    documents[0].copy(all_pages).write_pdf(output_path)
+
 
 def generate_html_output(
     filename: Path,
@@ -117,7 +142,8 @@ def generate_html_output(
     added_metadata = {
         "revisions": [],
         "authors": [],
-        "sheetsize": "sheetsize_default",
+        "sheetsize": "A4",
+        "orientation": "portrait",
     }
     if metadata:
         for item, contents in metadata.items():
@@ -132,9 +158,9 @@ def generate_html_output(
             elif item == "pn":
                 added_metadata[item] = f'{contents}-{metadata.get("sheet_name")}'
             elif item == "template":
-                added_metadata["sheetsize"] = contents.get(
-                    "sheetsize", "sheetsize_default"
-                )
+                added_metadata["sheetsize"] = contents.get("sheetsize", "A4")
+                if added_metadata["sheetsize"] in ["A2", "A3"]:
+                    added_metadata["orientation"] = "landscape"
             else:
                 added_metadata[item] = contents