staticdash 0.3.1__tar.gz → 0.3.2__tar.gz

{staticdash-0.3.1 → staticdash-0.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: staticdash
-Version: 0.3.1
+Version: 0.3.2
 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-0.3.1 → staticdash-0.3.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "staticdash"
-version = "0.3.1"
+version = "0.3.2"
 description = "A lightweight static HTML dashboard generator with Plotly and pandas support."
 authors = [
     { name = "Brian Day", email = "brian.day1@gmail.com" }

{staticdash-0.3.1 → staticdash-0.3.2}/staticdash/assets/css/style.css

@@ -104,12 +104,14 @@ body {
   height: auto !important;
 }
 
+/* Tables */
 table {
   width: 100%;
   border-collapse: collapse;
   margin-top: 1em;
   background-color: white;
   box-shadow: 0 2px 4px rgba(0, 0, 0, 0.1);
+  overflow-x: auto;
 }
 
 thead {
@@ -153,6 +155,7 @@ tbody tr:hover {
   background-color: #547a9f;
 }
 
+/* Sortable Tables */
 table.sortable th {
   cursor: pointer;
   position: relative;
@@ -176,13 +179,89 @@ table.sortable th.sorted-desc::after {
   content: "\25BC";
 }
 
+/* MiniPage Layout */
 .minipage-row {
   display: flex;
+  width: 100%;
   gap: 20px;
   margin-bottom: 20px;
+  box-sizing: border-box;
 }
 
-.minipage {
+.minipage-cell {
+  flex: 1 1 0;
+  min-width: 0;
   box-sizing: border-box;
   padding: 10px;
+  overflow-x: auto;
+}
+
+.minipage-cell pre {
+  flex: 0 1 auto;
+  max-height: 400px;
+  overflow: auto;
+}
+
+.minipage-cell h4 {
+  margin-top: 0;
+}
+
+.minipage-cell .syntax-block {
+  margin-top: 0.5em;
+  margin-bottom: 0.5em;
+}
+
+.minipage-cell table {
+  display: block;
+  overflow-x: auto;
+  width: 100%;
+}
+
+/* Syntax Blocks */
+.syntax-block {
+  position: relative;
+  margin: 1em 0;
+  background: #23272e;
+  border-radius: 6px;
+  overflow: auto;
+  color: #f8f8f2;
+}
+
+.syntax-block pre {
+  margin: 0;
+  padding: 1em;
+  background: none;
+  color: inherit;
+  font-family: 'Fira Mono', 'Consolas', monospace;
+  font-size: 0.95em;
+}
+
+.code-toolbar {
+  position: absolute;
+  top: 6px;
+  right: 12px;
+  z-index: 2;
+}
+
+.copy-btn,
+.view-raw-btn {
+  color: #fff;
+  background: #444;
+  border-radius: 4px;
+  padding: 2px 8px;
+  font-size: 0.85em;
+  text-decoration: none;
+  margin-left: 4px;
+  cursor: pointer;
+  transition: background 0.2s;
+}
+
+.copy-btn:hover,
+.view-raw-btn:hover {
+  background: #1abc9c;
+}
+
+.table-wrapper {
+  overflow-x: auto;
+  width: 100%;
 }

{staticdash-0.3.1 → staticdash-0.3.2}/staticdash/assets/js/script.js

@@ -11,9 +11,9 @@ document.addEventListener("DOMContentLoaded", () => {
     });
   }
 
-  function showPage(id) {
+  function showPage(pageId) {
     sections.forEach(section => section.style.display = "none");
-    const page = document.getElementById(id);
+    const page = document.getElementById(pageId);
     if (page) {
       page.style.display = "block";
 
@@ -24,8 +24,12 @@ document.addEventListener("DOMContentLoaded", () => {
     }
 
     links.forEach(link => link.classList.remove("active"));
-    const activeLink = Array.from(links).find(link => link.dataset.target === id);
+    const activeLink = Array.from(links).find(link => link.dataset.target === pageId);
     if (activeLink) activeLink.classList.add("active");
+
+    if (window.Prism && typeof Prism.highlightAll === "function") {
+      Prism.highlightAll();
+    }
   }
 
   links.forEach(link => {
@@ -91,4 +95,32 @@ document.addEventListener("DOMContentLoaded", () => {
       });
     });
   });
+
+  // Syntax block copy/view raw
+  document.querySelectorAll(".copy-btn").forEach(btn => {
+    btn.addEventListener("click", e => {
+      e.preventDefault();
+      const codeId = btn.dataset.target;
+      const code = document.getElementById(codeId);
+      if (code) {
+        navigator.clipboard.writeText(code.textContent);
+        btn.textContent = "Copied!";
+        setTimeout(() => { btn.textContent = "Copy"; }, 1200);
+      }
+    });
+  });
+  document.querySelectorAll(".view-raw-btn").forEach(btn => {
+    btn.addEventListener("click", e => {
+      e.preventDefault();
+      const codeId = btn.dataset.target;
+      const code = document.getElementById(codeId);
+      if (code) {
+        const win = window.open("", "_blank");
+        win.document.write("<pre>" + code.textContent.replace(/[<>&]/g, c => ({
+          '<': '&lt;', '>': '&gt;', '&': '&amp;'
+        }[c])) + "</pre>");
+        win.document.close();
+      }
+    });
+  });
 });

staticdash-0.3.2/staticdash/dashboard.py

@@ -0,0 +1,212 @@
+import os
+import shutil
+import uuid
+import pandas as pd
+import plotly.graph_objects as go
+from dominate import document
+from dominate.tags import div, h1, h2, h3, h4, p, a, script, link
+from dominate.util import raw as raw_util
+import html
+
+class AbstractPage:
+    def __init__(self):
+        self.elements = []
+
+    def add_header(self, text, level=1):
+        if level not in (1, 2, 3, 4):
+            raise ValueError("Header level must be 1, 2, 3, or 4")
+        self.elements.append(("header", (text, level)))
+
+    def add_text(self, text):
+        self.elements.append(("text", text))
+
+    def add_plot(self, plot):
+        html_plot = raw_util(plot.to_html(full_html=False, include_plotlyjs='cdn', config={'responsive': True}))
+        self.elements.append(("plot", html_plot))
+
+    def add_table(self, df, table_id=None, sortable=True):
+        if table_id is None:
+            table_id = f"table-{len(self.elements)}"
+        classes = "table-hover table-striped"
+        if sortable:
+            classes += " sortable"
+        html_table = df.to_html(classes=classes, index=False, border=0, table_id=table_id, escape=False)
+        self.elements.append(("table", (html_table, table_id)))
+
+    def add_download(self, file_path, label=None):
+        if not os.path.isfile(file_path):
+            raise FileNotFoundError(f"File not found: {file_path}")
+        self.elements.append(("download", (file_path, label)))
+
+    def add_minipage(self, minipage):
+        self.elements.append(("minipage", minipage))
+
+    def add_syntax(self, code, language="python"):
+        self.elements.append(("syntax", (code, language)))
+
+class Page(AbstractPage):
+    def __init__(self, slug, title):
+        super().__init__()
+        self.slug = slug
+        self.title = title
+        self.add_header(title, level=1)
+
+    def render(self, index, downloads_dir=None, relative_prefix=""):
+        elements = []
+        for kind, content in self.elements:
+            if kind == "minipage":
+                row_div = div(cls="minipage-row")
+                row_div += content.render(index, downloads_dir=downloads_dir, relative_prefix=relative_prefix)
+                elements.append(row_div)
+            elif kind == "header":
+                text, level = content
+                elements.append({1: h1, 2: h2, 3: h3, 4: h4}[level](text))
+            elif kind == "text":
+                elements.append(p(content))
+            elif kind == "plot":
+                elements.append(div(content, cls="plot-container"))
+            elif kind == "table":
+                table_html, _ = content
+                wrapped = div(raw_util(table_html), cls="table-wrapper")
+                elements.append(wrapped)
+            elif kind == "download":
+                file_path, label = content
+                file_uuid = f"{uuid.uuid4().hex}_{os.path.basename(file_path)}"
+                dst_path = os.path.join(downloads_dir, file_uuid)
+                shutil.copy2(file_path, dst_path)
+                btn = a(label or os.path.basename(file_path),
+                        href=f"{relative_prefix}downloads/{file_uuid}",
+                        cls="download-button",
+                        download=True)
+                elements.append(div(btn))
+            elif kind == "syntax":
+                code, language = content
+                code_id = f"code-{uuid.uuid4().hex[:8]}"
+                toolbar = div(cls="code-toolbar")
+                toolbar += a("Copy", href="#", cls="copy-btn", **{"data-target": code_id})
+                toolbar += a("View Raw", href="#", cls="view-raw-btn", **{"data-target": code_id, "style": "margin-left:10px;"})
+                escaped_code = html.escape(code)
+                header_text = f"{language.capitalize()} Example"
+                block_wrapper = div(
+                    h4(header_text),
+                    div(
+                        toolbar,
+                        raw_util(f'<pre><code id="{code_id}" class="language-{language}">{escaped_code}</code></pre>'),
+                        cls="syntax-block"
+                    )
+                )
+                elements.append(block_wrapper)
+        return elements
+
+class MiniPage(AbstractPage):
+    def __init__(self):
+        super().__init__()
+
+    def render(self, index=None, downloads_dir=None, relative_prefix=""):
+        row_div = div(cls="minipage-row")
+        for kind, content in self.elements:
+            cell = div(cls="minipage-cell")
+            if kind == "header":
+                text, level = content
+                cell += {1: h1, 2: h2, 3: h3, 4: h4}[level](text)
+            elif kind == "text":
+                cell += p(content)
+            elif kind == "plot":
+                cell += div(content, cls="plot-container")
+            elif kind == "table":
+                table_html, _ = content
+                cell += div(raw_util(table_html), cls="table-wrapper")
+            elif kind == "download":
+                file_path, label = content
+                file_uuid = f"{uuid.uuid4().hex}_{os.path.basename(file_path)}"
+                dst_path = os.path.join(downloads_dir, file_uuid)
+                shutil.copy2(file_path, dst_path)
+                btn = a(label or os.path.basename(file_path),
+                        href=f"{relative_prefix}downloads/{file_uuid}",
+                        cls="download-button",
+                        download=True)
+                cell += div(btn)
+            elif kind == "syntax":
+                code, language = content
+                code_id = f"code-{uuid.uuid4().hex[:8]}"
+                toolbar = div(cls="code-toolbar")
+                toolbar += a("Copy", href="#", cls="copy-btn", **{"data-target": code_id})
+                toolbar += a("View Raw", href="#", cls="view-raw-btn", **{"data-target": code_id, "style": "margin-left:10px;"})
+                escaped_code = html.escape(code)
+                header_text = f"{language.capitalize()} Example"
+                block_wrapper = div(
+                    h4(header_text),
+                    div(
+                        toolbar,
+                        raw_util(f'<pre><code id="{code_id}" class="language-{language}">{escaped_code}</code></pre>'),
+                        cls="syntax-block"
+                    )
+                )
+                cell += block_wrapper
+            row_div += cell
+        return row_div
+
+class Dashboard:
+    def __init__(self, title="Dashboard"):
+        self.title = title
+        self.pages = []
+
+    def add_page(self, page: Page):
+        self.pages.append(page)
+
+    def publish(self, output_dir="output"):
+        output_dir = os.path.abspath(output_dir)
+        pages_dir = os.path.join(output_dir, "pages")
+        downloads_dir = os.path.join(output_dir, "downloads")
+        assets_src = os.path.join(os.path.dirname(__file__), "assets")
+        assets_dst = os.path.join(output_dir, "assets")
+
+        os.makedirs(pages_dir, exist_ok=True)
+        os.makedirs(downloads_dir, exist_ok=True)
+        shutil.copytree(assets_src, assets_dst, dirs_exist_ok=True)
+
+        # Per-page HTML
+        for page in self.pages:
+            doc = document(title=page.title)
+            with doc.head:
+                doc.head.add(link(rel="stylesheet", href="../assets/css/style.css"))
+                doc.head.add(script(type="text/javascript", src="../assets/js/script.js"))
+                doc.head.add(script(src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"))
+                doc.head.add(link(rel="stylesheet", href="https://cdn.jsdelivr.net/npm/prismjs@1.29.0/themes/prism-tomorrow.min.css"))
+                doc.head.add(script(src="https://cdn.jsdelivr.net/npm/prismjs@1.29.0/prism.min.js"))
+                doc.head.add(script(src="https://cdn.jsdelivr.net/npm/prismjs@1.29.0/components/prism-python.min.js"))
+                doc.head.add(script(src="https://cdn.jsdelivr.net/npm/prismjs@1.29.0/components/prism-javascript.min.js"))
+            with doc:
+                with div(cls="page-section", id=f"page-{page.slug}") as section:
+                    for el in page.render(0, downloads_dir=downloads_dir, relative_prefix="../"):
+                        section += el
+            with open(os.path.join(pages_dir, f"{page.slug}.html"), "w") as f:
+                f.write(str(doc))
+
+        # Main index.html
+        index_doc = document(title=self.title)
+        with index_doc.head:
+            index_doc.head.add(link(rel="stylesheet", href="assets/css/style.css"))
+            index_doc.head.add(script(type="text/javascript", src="assets/js/script.js"))
+            index_doc.head.add(script(src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"))
+            index_doc.head.add(link(rel="stylesheet", href="https://cdn.jsdelivr.net/npm/prismjs@1.29.0/themes/prism-tomorrow.min.css"))
+            index_doc.head.add(script(src="https://cdn.jsdelivr.net/npm/prismjs@1.29.0/prism.min.js"))
+            index_doc.head.add(script(src="https://cdn.jsdelivr.net/npm/prismjs@1.29.0/components/prism-python.min.js"))
+            index_doc.head.add(script(src="https://cdn.jsdelivr.net/npm/prismjs@1.29.0/components/prism-javascript.min.js"))
+
+        with index_doc:
+            with div(id="sidebar"):
+                h1(self.title)
+                for page in self.pages:
+                    a(page.title, cls="nav-link", href="#", **{"data-target": f"page-{page.slug}"})
+                with div(id="sidebar-footer"):
+                    a("Produced by staticdash", href="https://pypi.org/project/staticdash/", target="_blank")
+
+            with div(id="content"):
+                for idx, page in enumerate(self.pages):
+                    with div(id=f"page-{page.slug}", cls="page-section", style="display:none;") as section:
+                        for el in page.render(idx, downloads_dir=downloads_dir, relative_prefix=""):
+                            section += el
+
+        with open(os.path.join(output_dir, "index.html"), "w") as f:
+            f.write(str(index_doc))

{staticdash-0.3.1 → staticdash-0.3.2}/staticdash.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: staticdash
-Version: 0.3.1
+Version: 0.3.2
 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-0.3.1/staticdash/dashboard.py

@@ -1,205 +0,0 @@
-import os
-import shutil
-import uuid
-import pandas as pd
-import plotly.graph_objects as go
-from dominate import document
-from dominate.tags import div, h1, h2, h3, h4, p, a, script, link
-from dominate.util import raw as raw_util
-
-class AbstractPage:
-    def __init__(self):
-        self.elements = []
-
-    def add_header(self, text, level=1):
-        if level not in (1, 2, 3, 4):
-            raise ValueError("Header level must be 1, 2, 3, or 4")
-        self.elements.append(("header", (text, level)))
-
-    def add_text(self, text):
-        self.elements.append(("text", text))
-
-    def add_plot(self, plot):
-        html = raw_util(plot.to_html(full_html=False, include_plotlyjs='cdn', config={'responsive': True}))
-        self.elements.append(("plot", html))
-
-    def add_table(self, df, table_id=None, sortable=True):
-        if table_id is None:
-            table_id = f"table-{len(self.elements)}"
-        classes = "table-hover table-striped"
-        if sortable:
-            classes += " sortable"
-        html = df.to_html(classes=classes, index=False, border=0, table_id=table_id, escape=False)
-        self.elements.append(("table", (html, table_id)))
-
-    def add_download(self, file_path, label=None):
-        if not os.path.isfile(file_path):
-            raise FileNotFoundError(f"File not found: {file_path}")
-        self.elements.append(("download", (file_path, label)))
-
-    def add_minipage(self, minipage):
-        self.elements.append(("minipage", minipage))
-
-class Page(AbstractPage):
-    def __init__(self, slug, title):
-        super().__init__()
-        self.slug = slug
-        self.title = title
-        self.add_header(title, level=1)
-
-    def render(self, index):
-        section = div()
-        minipage_row = []
-        for kind, content in self.elements:
-            if kind == "minipage":
-                row_div = div(cls="minipage-row")
-                row_div += content.render(index)
-                section += row_div
-            elif kind == "header":
-                text, level = content
-                if level == 1:
-                    section += h1(text)
-                elif level == 2:
-                    section += h2(text)
-                elif level == 3:
-                    section += h3(text)
-                elif level == 4:
-                    section += h4(text)
-            elif kind == "text":
-                section += p(content)
-            elif kind == "plot":
-                section += div(content, cls="plot-container")
-            elif kind == "table":
-                table_html, _ = content
-                section += raw_util(table_html)
-            elif kind == "download":
-                file_path, label = content
-                btn = a(label or os.path.basename(file_path),
-                        href=file_path,
-                        cls="download-button",
-                        download=True)
-                section += div(btn)
-        return section
-
-class MiniPage(AbstractPage):
-    def __init__(self, width=1.0):
-        super().__init__()
-        self.width = width
-
-    def render(self, index=None):
-        style = f"flex: 0 0 {self.width * 100}%; max-width: {self.width * 100}%;"
-        container = div(cls="minipage", style=style)
-        minipage_row = []
-        for kind, content in self.elements:
-            if kind == "minipage":
-                minipage_row.append(content)
-            else:
-                if minipage_row:
-                    row_div = div(cls="minipage-row")
-                    for mp in minipage_row:
-                        row_div += mp.render(index)
-                    container += row_div
-                    minipage_row = []
-                if kind == "header":
-                    text, level = content
-                    if level == 1:
-                        container += h1(text)
-                    elif level == 2:
-                        container += h2(text)
-                    elif level == 3:
-                        container += h3(text)
-                    elif level == 4:
-                        container += h4(text)
-                elif kind == "text":
-                    container += p(content)
-                elif kind == "plot":
-                    container += div(content, cls="plot-container")
-                elif kind == "table":
-                    table_html, _ = content
-                    container += raw_util(table_html)
-                elif kind == "download":
-                    file_path, label = content
-                    btn = a(label or os.path.basename(file_path),
-                            href=file_path,
-                            cls="download-button",
-                            download=True)
-                    container += div(btn)
-        if minipage_row:
-            row_div = div(cls="minipage-row")
-            for mp in minipage_row:
-                row_div += mp.render(index)
-            container += row_div
-        return container
-
-class Dashboard:
-    def __init__(self, title="Dashboard"):
-        self.title = title
-        self.pages = []
-
-    def add_page(self, page: Page):
-        self.pages.append(page)
-
-    def publish(self, output_dir="output"):
-        output_dir = os.path.abspath(output_dir)
-        pages_dir = os.path.join(output_dir, "pages")
-        downloads_dir = os.path.join(output_dir, "downloads")
-        assets_src = os.path.join(os.path.dirname(__file__), "assets")
-        assets_dst = os.path.join(output_dir, "assets")
-
-        os.makedirs(pages_dir, exist_ok=True)
-        os.makedirs(downloads_dir, exist_ok=True)
-        shutil.copytree(assets_src, assets_dst, dirs_exist_ok=True)
-
-        for page in self.pages:
-            doc = document(title=page.title)
-            with doc.head:
-                doc.head.add(link(rel="stylesheet", href="../assets/css/style.css"))
-                doc.head.add(script(type="text/javascript", src="../assets/js/script.js"))
-                doc.head.add(script(src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"))
-
-            with doc:
-                with div(cls="page-section", id=f"page-{page.slug}"):
-                    for kind, content in page.elements:
-                        if kind == "header":
-                            text, level = content
-                            if level == 1:
-                                h1(text)
-                            elif level == 2:
-                                h2(text)
-                            elif level == 3:
-                                h3(text)
-                            elif level == 4:
-                                h4(text)
-                        elif kind == "text":
-                            p(content)
-                        elif kind == "plot":
-                            div(content, cls="plot-container")
-                        elif kind == "table":
-                            table_html, _ = content
-                            doc.add(raw_util(table_html))
-
-            with open(os.path.join(pages_dir, f"{page.slug}.html"), "w") as f:
-                f.write(str(doc))
-
-        index_doc = document(title=self.title)
-        with index_doc.head:
-            index_doc.head.add(link(rel="stylesheet", href="assets/css/style.css"))
-            index_doc.head.add(script(type="text/javascript", src="assets/js/script.js"))
-            index_doc.head.add(script(src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"))
-
-        with index_doc:
-            with div(id="sidebar"):
-                h1(self.title)
-                for page in self.pages:
-                    a(page.title, cls="nav-link", href="#", **{"data-target": f"page-{page.slug}"})
-                with div(id="sidebar-footer"):
-                    a("Produced by staticdash", href="https://pypi.org/project/staticdash/", target="_blank")
-
-            with div(id="content"):
-                for idx, page in enumerate(self.pages):
-                    with div(id=f"page-{page.slug}", cls="page-section", style="display:none;") as section:
-                        rendered = page.render(idx)
-                        section += rendered  # This is correct
-
-        with open(os.path.join(output_dir, "index.html"), "w") as f:
-            f.write(str(index_doc))