add ReportLab sample

Author: twotwo

click-sample/requirements-dev.txt

@@ -1,4 +1,4 @@
 --index https://mirrors.aliyun.com/pypi/simple
-black>=20.0
+black>=20.8b1
 isort>=5.6.0
 pytest>=6.1.0

reportlab-sample/README.md

@@ -0,0 +1,20 @@
+# ReportLab Sample
+
+use reportlab to write pdf.
+
+[ReportLab Tutorial](http://wiki.li3huo.com/ReportLab)
+
+## Running on host
+
+```bash
+# create virtual env
+$ virtualenv venv -p python3.7 && source venv/bin/activate
+$ pip install --upgrade pip && \
+pip install -r requirements.txt && \
+pip install -r requirements-dev.txt
+```
+
+```bash
+# running command
+python addons_reportlab.py
+```

reportlab-sample/addons_reportlab.py

@@ -0,0 +1,170 @@
+# https://docs.worldviz.com/vizard/latest/addons_reportlab.htm
+import os
+
+from reportlab.graphics.charts.barcharts import VerticalBarChart
+from reportlab.graphics.charts.legends import Legend
+# from reportlab.graphics.charts.textlabels import Label
+from reportlab.graphics.shapes import Drawing  # , string
+from reportlab.lib import colors, pagesizes
+from reportlab.lib.styles import getSampleStyleSheet
+from reportlab.lib.units import inch
+from reportlab.platypus import (Image, Paragraph, SimpleDocTemplate, Spacer,
+                                Table, TableStyle)
+
+# This is your data collected from your Vizard experiment
+subject1 = "Tom"
+subject2 = "Ana"
+results1 = [15, 23, 42, 56, 76]
+results2 = [34, 67, 94, 31, 56]
+
+
+# take the data and make ready for paragraph
+def dataToParagraph(name, data):
+
+    p = (
+        "<strong>Subject name: </strong>"
+        + name
+        + "<br/>"
+        + "<strong>Data: </strong>  ("
+    )
+    for i in range(len(data)):
+        p += str(data[i])
+        if i != len(data) - 1:
+            p += ", "
+        else:
+            p += ")"
+    return p
+
+
+# take the data and convert to list of strings ready for table
+def dataToTable(name, data):
+
+    data = [str(x) for x in data]
+    data.insert(0, name)
+    return data
+
+
+# create the table for our document
+def myTable(tabledata):
+
+    # first define column and row size
+    colwidths = (70, 50, 50, 50, 50, 50)
+    rowheights = (25, 20, 20)
+
+    t = Table(tabledata, colwidths, rowheights)
+
+    GRID_STYLE = TableStyle(
+        [
+            ("GRID", (0, 0), (-1, -1), 0.25, colors.black),
+            ("ALIGN", (1, 1), (-1, -1), "RIGHT"),
+        ]
+    )
+
+    t.setStyle(GRID_STYLE)
+    return t
+
+
+# create a bar chart and specify positions, sizes, and colors
+def myBarChart(data):
+    drawing = Drawing(400, 200)
+
+    bc = VerticalBarChart()
+    bc.x = 50
+    bc.y = 50
+    bc.height = 125
+    bc.width = 300
+    bc.data = data
+    bc.barWidth = 0.3 * inch
+    bc.groupSpacing = 0.2 * inch
+
+    bc.strokeColor = colors.black
+
+    bc.valueAxis.valueMin = 0
+    bc.valueAxis.valueMax = 100
+    bc.valueAxis.valueStep = 10
+
+    bc.categoryAxis.labels.boxAnchor = "ne"
+    bc.categoryAxis.labels.dx = 8
+    bc.categoryAxis.labels.dy = -2
+
+    catNames = ("Trial1 Trial2 Trial3 Trial4 Trial5").split()
+    bc.categoryAxis.categoryNames = catNames
+
+    bc.bars[0].fillColor = colors.blue
+    bc.bars[1].fillColor = colors.lightblue
+
+    drawing.add(bc)
+
+    return drawing
+
+
+# add a legend for the bar chart
+def myBarLegend(drawing, name1, name2):
+    "Add sample swatches to a diagram."
+
+    d = drawing or Drawing(400, 200)
+
+    swatches = Legend()
+    swatches.alignment = "right"
+    swatches.x = 80
+    swatches.y = 160
+    swatches.deltax = 60
+    swatches.dxTextSpace = 10
+    swatches.columnMaximum = 4
+    items = [(colors.blue, name1), (colors.lightblue, name2)]
+    swatches.colorNamePairs = items
+
+    d.add(swatches, "legend")
+    return d
+
+
+def prepare_content():
+    # create a list and add the elements of our document (image, paragraphs, table, chart) to it
+    story = []
+
+    # define the style for our paragraph text
+    styles = getSampleStyleSheet()
+    styleN = styles["Normal"]
+
+    # First add the Vizard Logo
+    imagePath = os.path.join(
+        os.path.dirname(os.path.abspath(__file__)),
+        "image/logo.png",
+    )
+    # 200 * 200 mm logo
+    im = Image(imagePath, width=1 * inch, height=1 * inch)
+    im.hAlign = "RIGHT"
+    story.append(im)
+
+    # add the title
+    story.append(Paragraph("<strong>Results for Vizard Experiment</strong>", styleN))
+    story.append(Spacer(1, 0.25 * inch))
+
+    # convert data to paragraph form and then add paragraphs
+    story.append(Paragraph(dataToParagraph(subject1, results1), styleN))
+    story.append(Spacer(1, 0.25 * inch))
+    story.append(Paragraph(dataToParagraph(subject2, results2), styleN))
+    story.append(Spacer(1, 0.5 * inch))
+
+    # add our table - first prepare data and then pass this to myTable function
+    tabledata = (
+        ("", "Trial 1", "Trial 2", "Trial 3", "Trial 4", "Trial 5"),
+        dataToTable(subject1, results1),
+        dataToTable(subject2, results2),
+    )
+
+    story.append(myTable(tabledata))
+    story.append(Spacer(1, 0.5 * inch))
+
+    # add our barchart and legend
+    drawing = myBarChart([results1, results2])
+    drawing = myBarLegend(drawing, subject1, subject2)
+    drawing.hAlign = "CENTER"
+    story.append(drawing)
+    return story
+
+
+# build our document with the list of flowables we put together
+doc = SimpleDocTemplate("mydoc.pdf", pagesize=pagesizes.A4, topMargin=0)
+print(f"width={pagesizes.A4[0]}, height={pagesizes.A4[1]}")
+doc.build(prepare_content())

reportlab-sample/image/logo.png

@@ -0,0 +1,64 @@
+import os
+import platform
+from io import BytesIO
+
+from PIL import Image
+from reportlab.graphics.shapes import Drawing, Line
+from reportlab.lib import pagesizes, units
+from reportlab.pdfbase import pdfmetrics, ttfonts
+from reportlab.platypus import SimpleDocTemplate
+
+if platform.system() == "Darwin":
+    regular_path = os.path.join("~/Library/Fonts/Monofur for Powerline.ttf")
+    italic_path = os.path.join("~/Library/Fonts/Monofur Italic for Powerline.ttf")
+
+    pdfmetrics.registerFont(ttfonts.TTFont("Bold", regular_path))
+    pdfmetrics.registerFont(ttfonts.TTFont("Medium", regular_path))
+    pdfmetrics.registerFont(ttfonts.TTFont("Regular", regular_path))
+
+
+# A4 页面外边距默认值 1.25 inch
+MARGIN = 31.7 * units.mm
+
+
+def build_pdf(flowables, pagesize=pagesizes.A4, margin=MARGIN):
+    """根据 flowables 中的内容生成 pdf
+
+    Args:
+        flowables: content of pdf
+        pagesize: default is pagesizes.A4
+    Returns:
+        store content in memory
+    """
+    pdf_buffer = BytesIO()
+    # 更多配置信息，参考 BaseDocTemplate
+    my_doc = SimpleDocTemplate(
+        pdf_buffer, pagesize=pagesize, leftMargin=MARGIN, rightMargin=MARGIN
+    )
+
+    my_doc.build(flowables)
+    # content = pdf_buffer.getbuffer()
+    # pdf_buffer.close()
+    return pdf_buffer
+
+
+def new_line(width=210 * units.mm):
+    """create a new line in pdf
+    A4 = (210*mm,297*mm)
+    """
+    d = Drawing(width=width, height=1)
+    d.hAlign = "CENTER"
+    d.add(Line(x1=MARGIN, y1=0, x2=width - MARGIN, y2=0))
+    return d
+
+
+def load_image(fp):
+    """load image with PIL.Image, convert to BytesIO
+
+    Args:
+        fp: Union[str, Path, BinaryIO]
+    """
+    img = BytesIO()
+    Image.open(fp).save(img, "PNG")
+    img.seek(0)
+    return img

reportlab-sample/pdf_render.py

@@ -0,0 +1,4 @@
+--index https://mirrors.aliyun.com/pypi/simple
+black>=20.8b1
+isort>=5.6.0
+# pytest>=6.1.0

reportlab-sample/requirements-dev.txt

@@ -0,0 +1,3 @@
+--index https://mirrors.aliyun.com/pypi/simple
+reportlab>=3.5.55
+python-dotenv>=0.15.0