staticdash 2025.19__py3-none-any.whl → 2025.21__py3-none-any.whl

staticdash/dashboard.py

@@ -22,6 +22,7 @@ class AbstractPage:
     def __init__(self):
         self.elements = []
 
+
     def add_header(self, text, level=1, width=None):
         if level not in (1, 2, 3, 4):
             raise ValueError("Header level must be 1, 2, 3, or 4")
@@ -212,6 +213,34 @@ class Dashboard:
 
     def add_page(self, page):
         self.pages.append(page)
+    
+    # def _track_outline(self, flowable):
+    #     """
+    #     Hook for collecting TOC entries and setting bookmarks.
+    #     """
+    #     from reportlab.platypus import Paragraph
+    #     if isinstance(flowable, Paragraph):
+    #         text = flowable.getPlainText()
+    #         style_name = flowable.style.name
+    #         if style_name.startswith("Heading"):
+    #             try:
+    #                 level = int(style_name.replace("Heading", ""))
+    #             except ValueError:
+    #                 return
+    #             key = f"bookmark_{uuid.uuid4().hex}"
+    #             flowable.canv.bookmarkPage(key)
+    #             flowable.canv.addOutlineEntry(text, key, level=level - 1, closed=False)
+    #             flowable._bookmarkName = key
+
+
+    def _track_outline(self, canvas, doc):
+        if hasattr(doc, '_last_heading'):
+            level, text = doc._last_heading
+            key = f"bookmark_{uuid.uuid4().hex}"
+            canvas.bookmarkPage(key)
+            canvas.addOutlineEntry(text, key, level=level - 1, closed=False)
+            del doc._last_heading
+
 
     def _render_sidebar(self, pages, prefix="", current_slug=None):
         for page in pages:
@@ -316,57 +345,117 @@ class Dashboard:
         with open(os.path.join(output_dir, "index.html"), "w") as f:
             f.write(str(index_doc))
 
-    def publish_pdf(self, output_path="dashboard_report.pdf", pagesize="A4", include_title_page=False, title_page_marking=None, author=None, affiliation=None):
-        from reportlab.platypus import SimpleDocTemplate, Spacer, Paragraph, PageBreak, Image
-        from reportlab.lib.pagesizes import letter, A4
-        from reportlab.lib.styles import getSampleStyleSheet
+    def publish_pdf(self, output_path="dashboard_report.pdf", pagesize="A4", include_toc=True, include_title_page=False, author=None, affiliation=None, title_page_marking=None):
+        from reportlab.platypus import SimpleDocTemplate, Paragraph, Spacer, PageBreak, Table, TableStyle, Image
+        from reportlab.platypus.tableofcontents import TableOfContents
+        from reportlab.lib.pagesizes import A4, letter
+        from reportlab.lib.styles import getSampleStyleSheet, ParagraphStyle
+        from reportlab.lib import colors
+        from reportlab.lib.units import inch
         from datetime import datetime
+        import tempfile
         import io
+        import os
+        import plotly.io as pio
 
-        page_size = A4 if pagesize == "A4" else letter
+        pio.kaleido.scope.default_format = "png"
+
+        page_size = A4 if pagesize.upper() == "A4" else letter
         styles = getSampleStyleSheet()
+        normal_style = styles['Normal']
+
+        styles['Heading1'].fontSize = 18
+        styles['Heading1'].spaceAfter = 12
+        styles['Heading1'].spaceBefore = 18
+        styles['Heading1'].fontName = 'Helvetica-Bold'
+
+        styles['Heading2'].fontSize = 14
+        styles['Heading2'].spaceAfter = 8
+        styles['Heading2'].spaceBefore = 12
+        styles['Heading2'].fontName = 'Helvetica-Bold'
+
+        if 'CodeBlock' not in styles:
+            styles.add(ParagraphStyle(
+                name='CodeBlock',
+                fontName='Courier',
+                fontSize=9,
+                leading=12,
+                backColor=colors.whitesmoke,
+                leftIndent=12,
+                rightIndent=12,
+                spaceAfter=8,
+                borderPadding=4
+            ))
+
         story = []
 
-        # Add title page
+        class MyDocTemplate(SimpleDocTemplate):
+            def __init__(self, *args, **kwargs):
+                self.outline_entries = []
+                self._outline_idx = 0
+                super().__init__(*args, **kwargs)
+
+            def afterFlowable(self, flowable):
+                if hasattr(flowable, 'style') and hasattr(flowable, 'getPlainText'):
+                    style_name = flowable.style.name
+                    if style_name.startswith("Heading"):
+                        level = int(style_name.replace("Heading", ""))
+                        text = flowable.getPlainText().strip()
+                        key = f"heading_{uuid.uuid4().hex}"
+                        self.canv.bookmarkPage(key)
+                        self.canv.addOutlineEntry(text, key, level=level-1, closed=False)
+                        self.notify('TOCEntry', (level, text, self.page))
+
+        def add_marking(canvas, doc, marking):
+            if marking:
+                canvas.saveState()
+                canvas.setFont("Helvetica", 10)
+                width, height = doc.pagesize
+                text_width = canvas.stringWidth(marking, "Helvetica", 10)
+                x = (width - text_width) / 2
+                canvas.drawString(x, height - 36, marking)
+                canvas.drawString(x, 36, marking)
+                canvas.restoreState()
+
         if include_title_page:
             story.append(Spacer(1, 120))
             story.append(Paragraph(f"<b>{self.title}</b>", styles['Title']))
             story.append(Spacer(1, 48))
-
-            # Center author, affiliation, and date
+            lines = []
             if author:
-                story.append(Paragraph(f"<para align='center'>{author}</para>", styles['Normal']))
+                lines.append(str(author))
             if affiliation:
-                story.append(Paragraph(f"<para align='center'>{affiliation}</para>", styles['Normal']))
-            current_date = datetime.now().strftime("%B %d, %Y")
-            story.append(Paragraph(f"<para align='center'>{current_date}</para>", styles['Normal']))
+                lines.append(str(affiliation))
+            lines.append(datetime.now().strftime('%B %d, %Y'))
+            story.append(Paragraph("<para align='center'>" + "<br/>".join(lines) + "</para>", normal_style))
+            story.append(PageBreak())
 
+        if include_toc:
+            toc = TableOfContents()
+            toc.levelStyles = [
+                ParagraphStyle(name='TOCHeading1', fontSize=14, leftIndent=20, firstLineIndent=-20, spaceBefore=10, leading=16),
+                ParagraphStyle(name='TOCHeading2', fontSize=12, leftIndent=40, firstLineIndent=-20, spaceBefore=5, leading=12),
+            ]
+            story.append(Paragraph("Table of Contents", styles["Title"]))
+            story.append(toc)
             story.append(PageBreak())
 
-        # Add markings to the PDF
-        def add_marking(canvas, doc, marking):
-            if marking:
-                canvas.saveState()
-                canvas.setFont("Helvetica", 10)
-                page_width = doc.pagesize[0]
-                text_width = canvas.stringWidth(marking, "Helvetica", 10)
-                x_position = (page_width - text_width) / 2  # Center the marking
-                canvas.drawString(x_position, doc.pagesize[1] - 36, marking)  # Header
-                canvas.drawString(x_position, 36, marking)  # Footer
-                canvas.restoreState()
+        def render_page(page, level=0, sec_prefix=[]):
+            heading_style = styles['Heading1'] if level == 0 else styles['Heading2']
+            story.append(Paragraph(page.title, heading_style))
+            story.append(Spacer(1, 12))
 
-        # Recursive function to render pages and subpages
-        def render_page(page):
-            # Render the current page
             for kind, content, _ in page.elements:
                 if kind == "text":
-                    story.append(Paragraph(content, styles['Normal']))
+                    story.append(Paragraph(content, normal_style))
                     story.append(Spacer(1, 8))
+
                 elif kind == "header":
-                    text, level = content
-                    header_style = styles[f'Heading{min(level + 1, 4)}']
-                    story.append(Paragraph(text, header_style))
+                    text, lvl = content
+                    style = styles['Heading{}'.format(min(lvl + 1, 4))]
+                    story.append(Paragraph(text, style))
                     story.append(Spacer(1, 8))
+
                 elif kind == "table":
                     df = content
                     try:
@@ -392,47 +481,57 @@ class Dashboard:
                         story.append(t)
                         story.append(Spacer(1, 12))
                     except Exception:
-                        story.append(Paragraph("Table could not be rendered.", styles['Normal']))
+                        story.append(Paragraph("Table could not be rendered.", normal_style))
+
                 elif kind == "plot":
                     fig = content
                     try:
-                        # Handle Plotly figures
-                        if hasattr(fig, "to_image"):
-                            img_bytes = fig.to_image(format="png", width=800, height=600, scale=2)
-                            img_buffer = io.BytesIO(img_bytes)
-                            img = Image(img_buffer, width=6 * inch, height=4.5 * inch)
-                            story.append(img)
-                            story.append(Spacer(1, 12))
-                        # Handle Matplotlib figures
-                        elif hasattr(fig, "savefig"):
+                        if hasattr(fig, "savefig"):  # Matplotlib
                             buf = io.BytesIO()
                             fig.savefig(buf, format="png", bbox_inches="tight", dpi=300)
                             buf.seek(0)
-                            img = Image(buf, width=6 * inch, height=4.5 * inch)
-                            story.append(img)
+                            story.append(Spacer(1, 8))
+                            story.append(Image(buf, width=6*inch, height=4.5*inch))
                             story.append(Spacer(1, 12))
+                        elif hasattr(fig, "write_image"):  # Plotly
+                            with tempfile.NamedTemporaryFile(suffix=".png", delete=False) as tmpfile:
+                                fig.write_image(tmpfile.name, width=600, height=360, scale=2)
+                                with open(tmpfile.name, "rb") as f:
+                                    story.append(Spacer(1, 8))
+                                    story.append(Image(io.BytesIO(f.read()), width=6*inch, height=3.6*inch))
+                                    story.append(Spacer(1, 12))
+                            os.unlink(tmpfile.name)
                     except Exception as e:
-                        story.append(Paragraph(f"Plot could not be rendered: {e}", styles['Normal']))
+                        story.append(Paragraph(f"Plot rendering failed: {e}", normal_style))
+
                 elif kind == "syntax":
-                    # Handle syntax blocks
-                    pass
+                    code, language = content
+                    from html import escape
+                    story.append(Paragraph(f"<b>Code ({language}):</b>", normal_style))
+                    story.append(Spacer(1, 4))
+                    code_html = escape(code).replace(" ", "&nbsp;").replace("\n", "<br/>")
+                    story.append(Paragraph(f"<font face='Courier'>{code_html}</font>", styles['CodeBlock']))
+                    story.append(Spacer(1, 12))
+
                 elif kind == "minipage":
-                    # Handle subpages
-                    pass
+                    render_page(content, level=level + 1, sec_prefix=sec_prefix)
 
-            # Recursively render subpages
             for child in getattr(page, "children", []):
-                story.append(PageBreak())  # Add a PageBreak before rendering subpages
-                render_page(child)
+                story.append(PageBreak())
+                render_page(child, level=level + 1, sec_prefix=sec_prefix + [1])
+
+            story.append(PageBreak())
 
-        # Render all pages
         for page in self.pages:
             render_page(page)
-            story.append(PageBreak())  # Add a PageBreak after each top-level page
 
-        # Build the PDF
-        doc = SimpleDocTemplate(output_path, pagesize=page_size)
-        doc.build(
+        doc = MyDocTemplate(
+            output_path,
+            pagesize=page_size,
+            rightMargin=72, leftMargin=72, topMargin=72, bottomMargin=72,
+        )
+
+        doc.multiBuild(
             story,
             onFirstPage=lambda canvas, doc: add_marking(canvas, doc, title_page_marking),
             onLaterPages=lambda canvas, doc: add_marking(canvas, doc, self.marking)

{staticdash-2025.19.dist-info → staticdash-2025.21.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: staticdash
-Version: 2025.19
+Version: 2025.21
 Summary: A lightweight static HTML dashboard generator with Plotly and pandas support.
 Author-email: Brian Day <brian.day1@gmail.com>
 License: CC0-1.0

staticdash-2025.21.dist-info/RECORD

@@ -0,0 +1,8 @@
+staticdash/__init__.py,sha256=UN_-h8wFGfTPHYjnEb7N9CsxqXo-DQVo0cmREOtvRXE,244
+staticdash/dashboard.py,sha256=b6xx5-zdSCzbcaBTe52flSXrK_cdAo3vzGfIeR2MsNQ,25950
+staticdash/assets/css/style.css,sha256=RVqNdwBsaDv8izdOQjGmUZ4NROWF8uZhiq8DTNvUB1M,5962
+staticdash/assets/js/script.js,sha256=7xBRlz_19wybbNVwAcfuKNXtDEojGB4EB0Yj4klsoTA,6998
+staticdash-2025.21.dist-info/METADATA,sha256=qKcshAi26kzpuRYjYpUppRTQW3F3ZsoKiKjHxIAbfWQ,1960
+staticdash-2025.21.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+staticdash-2025.21.dist-info/top_level.txt,sha256=3MzZU6SptkUkjcHV1cvPji0H4aRzPphLHnpStgGEcxM,11
+staticdash-2025.21.dist-info/RECORD,,

staticdash-2025.19.dist-info/RECORD

@@ -1,8 +0,0 @@
-staticdash/__init__.py,sha256=UN_-h8wFGfTPHYjnEb7N9CsxqXo-DQVo0cmREOtvRXE,244
-staticdash/dashboard.py,sha256=fTxesbZOkM4H2VEDZX152z8gLLZ3w0ahdYA7yBJ08aA,21960
-staticdash/assets/css/style.css,sha256=RVqNdwBsaDv8izdOQjGmUZ4NROWF8uZhiq8DTNvUB1M,5962
-staticdash/assets/js/script.js,sha256=7xBRlz_19wybbNVwAcfuKNXtDEojGB4EB0Yj4klsoTA,6998
-staticdash-2025.19.dist-info/METADATA,sha256=Mmt-_2QcTkiWSV6nXRUZhuNBbMchCom9UC3lW45aG70,1960
-staticdash-2025.19.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-staticdash-2025.19.dist-info/top_level.txt,sha256=3MzZU6SptkUkjcHV1cvPji0H4aRzPphLHnpStgGEcxM,11
-staticdash-2025.19.dist-info/RECORD,,