staticdash 0.2.1__py3-none-any.whl → 0.3.0__py3-none-any.whl

staticdash/assets/css/style.css

@@ -174,4 +174,15 @@ table.sortable th.sorted-asc::after {
 
 table.sortable th.sorted-desc::after {
   content: "\25BC";
+}
+
+.minipage-row {
+  display: flex;
+  gap: 20px;
+  margin-bottom: 20px;
+}
+
+.minipage {
+  box-sizing: border-box;
+  padding: 10px;
 }

staticdash/dashboard.py

@@ -4,15 +4,12 @@ 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, table, thead, tr, th, tbody, td, span
+from dominate.tags import div, h1, h2, h3, h4, p, a, script, link
 from dominate.util import raw as raw_util
 
-class Page:
-    def __init__(self, slug, title):
-        self.slug = slug
-        self.title = title
+class AbstractPage:
+    def __init__(self):
         self.elements = []
-        self.add_header(title, level=1)  # Add page title as level 1 header
 
     def add_header(self, text, level=1):
         if level not in (1, 2, 3, 4):
@@ -40,20 +37,25 @@ class Page:
             raise FileNotFoundError(f"File not found: {file_path}")
         self.elements.append(("download", (file_path, label)))
 
-    def add(self, element):
-        if isinstance(element, str):
-            self.add_text(element)
-        elif isinstance(element, go.Figure):
-            self.add_plot(element)
-        elif isinstance(element, pd.DataFrame):
-            self.add_table(element)
-        else:
-            raise ValueError(f"Unsupported element type: {type(element)}")
+    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(id=f"page-{index}", cls="page-section")
+        section = div()
+        minipage_row = []
         for kind, content in self.elements:
-            if kind == "header":
+            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)
@@ -70,8 +72,65 @@ class Page:
             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
@@ -99,7 +158,6 @@ class Dashboard:
 
             with doc:
                 with div(cls="page-section", id=f"page-{page.slug}"):
-                    # Remove h1(page.title) here, since it's already a header element
                     for kind, content in page.elements:
                         if kind == "header":
                             text, level = content
@@ -136,39 +194,10 @@ class Dashboard:
                     a("Produced by staticdash", href="https://pypi.org/project/staticdash/", target="_blank")
 
             with div(id="content"):
-                for page in self.pages:
-                    with div(id=f"page-{page.slug}", cls="page-section", style="display:none;"):
-                        # Remove h2(page.title) here, since it's already a header element
-                        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
-                                div(raw_util(table_html))
-                            elif kind == "download":
-                                src_path, label = content
-                                file_uuid = f"{uuid.uuid4().hex}_{os.path.basename(src_path)}"
-                                dst_path = os.path.join(downloads_dir, file_uuid)
-                                shutil.copy2(src_path, dst_path)
-                                download_link = f"downloads/{file_uuid}"
-                                btn = a(label or os.path.basename(src_path),
-                                        href=download_link,
-                                        cls="download-button",
-                                        download=True)
-                                div(btn)
-                                div(raw_util("<br>"))
+                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))

staticdash-0.3.0.dist-info/METADATA

@@ -0,0 +1,57 @@
+Metadata-Version: 2.4
+Name: staticdash
+Version: 0.3.0
+Summary: A lightweight static HTML dashboard generator with Plotly and pandas support.
+Author-email: Brian Day <brian.day1@gmail.com>
+License: CC0-1.0
+Project-URL: Homepage, https://github.com/briday1/staticdash
+Project-URL: Repository, https://github.com/briday1/staticdash
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: plotly
+Requires-Dist: pandas
+Requires-Dist: dominate
+
+# staticdash
+
+staticdash is a lightweight Python module for creating static, multi-page HTML dashboards. It supports:
+
+- Plotly plots (interactive, responsive)
+- Pandas DataFrames as sortable tables
+- Text and headers (Markdown-like)
+- File download buttons
+- Multi-page navigation with sidebar
+- Custom CSS and JavaScript
+- Easy extension for new content types
+
+## Installation
+
+```bash
+git clone https://github.com/briday1/staticdash.git
+cd staticdash
+pip install .
+```
+
+## Features
+
+- **Add Plotly figures:** `page.add(fig)`
+- **Add tables:** `page.add(df)` (sortable by default)
+- **Add text or headers:** `page.add("Some text")`, `page.add_header("Title", level=2)`
+- **Add download buttons:** `page.add_download("path/to/file", "Label")`
+- **Multi-page:** Create multiple `Page` objects and add them to your `Dashboard`
+- **Custom styling:** Edit `assets/css/style.css` for your own look
+
+## Options
+
+- **Sidebar navigation:** Fixed, with active highlighting
+- **Responsive layout:** Works on desktop and mobile
+- **Export:** Outputs a static HTML dashboard (no server needed)
+- **Per-page HTML:** Also generates individual HTML files for each page
+
+## Live Demo
+
+[View the latest demo dashboard](https://briday1.github.io/staticdash/)
+
+---
+
+For a full example, see [`demo.py`](./demo.py) in this repository.

staticdash-0.3.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+staticdash/__init__.py,sha256=KqViaDkiQnhBI8-j3hr14umLDmPgddvdB_G1nJeC5Xs,38
+staticdash/dashboard.py,sha256=WrUtkwaHxKJ7dCCKuaBtJrP-BqeWmUGpofJWrTH3qJc,8002
+staticdash/assets/css/style.css,sha256=z3bC-QjAb9f5E3HUkr6R81qQyAfKpMW48yjy11CYH-Q,2779
+staticdash/assets/js/script.js,sha256=SMOyh7_E_BlvLYMEwYlvCnV7-GnMR-x8PtEiFbIIAsw,3089
+staticdash-0.3.0.dist-info/METADATA,sha256=DYhxjusTv_YeqNUHmjq37ygzj7C8qZu1eMDTfxLntNg,1776
+staticdash-0.3.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+staticdash-0.3.0.dist-info/top_level.txt,sha256=3MzZU6SptkUkjcHV1cvPji0H4aRzPphLHnpStgGEcxM,11
+staticdash-0.3.0.dist-info/RECORD,,

staticdash-0.2.1.dist-info/METADATA

@@ -1,89 +0,0 @@
-Metadata-Version: 2.4
-Name: staticdash
-Version: 0.2.1
-Summary: A lightweight static HTML dashboard generator with Plotly and pandas support.
-Author-email: Brian Day <brian.day1@gmail.com>
-License: CC0-1.0
-Project-URL: Homepage, https://github.com/briday1/staticdash
-Project-URL: Repository, https://github.com/briday1/staticdash
-Requires-Python: >=3.8
-Description-Content-Type: text/markdown
-Requires-Dist: plotly
-Requires-Dist: pandas
-Requires-Dist: dominate
-
-# staticdash 
-
-staticdash is a lightweight Python module for creating static, multi-page HTML dashboards. It supports Plotly plots, tables, and text content, with a fixed sidebar for navigation.
-
-## Installation
-
-Clone the repository and install it in editable mode:
-
-```bash
-git clone https://github.com/briday1/staticdash.git 
-cd staticdash
-pip install .
-```
-
-## Usage
-
-Create a Python script like this:
-
-```python
-from staticdash.dashboard import Dashboard, Page
-import plotly.express as px
-import pandas as pd
-import numpy as np
-
-# Create sample data
-df = pd.DataFrame({
-    "Category": ["A", "B", "C", "D"],
-    "Value": [10, 20, 30, 40]
-})
-
-df2 = pd.DataFrame({
-    "Time": pd.date_range("2024-01-01", periods=10, freq="D"),
-    "Signal": np.random.randn(10).cumsum()
-})
-
-fig1 = px.bar(df, x="Category", y="Value", title="Bar Chart Example")
-fig2 = px.line(df2, x="Time", y="Signal", title="Signal over Time")
-
-# Build dashboard
-dashboard = Dashboard(title="StaticDash Demo")
-
-# Page 1: Overview
-page1 = Page("overview", "Overview")
-page1.add("Welcome to the StaticDash demo. Below is a bar chart and a table.")
-page1.add(fig1)
-page1.add(df)
-
-# Page 2: Timeseries
-page2 = Page("timeseries", "Timeseries")
-page2.add("Here is a random time series with cumulative noise.")
-page2.add(fig2)
-page2.add(df2)
-
-# Page 3: Summary
-page3 = Page("summary", "Summary")
-page3.add("Summary and notes can be added here.")
-page3.add("StaticDash is a lightweight static dashboard generator.")
-
-# Page 4: Download
-page4 = Page("download", "Download")
-page4.add("Here is a button to download a file.")
-page4.add_download('./test_file.txt', "Download File")
-page4.add_download('./test_file2.txt', "Download Another File")
-
-# Register pages
-dashboard.add_page(page1)
-dashboard.add_page(page2)
-dashboard.add_page(page3)
-dashboard.add_page(page4)
-
-# Export
-dashboard.publish(output_dir="output")
-```
-
-After running the script, open output/index.html in your browser.

staticdash-0.2.1.dist-info/RECORD

@@ -1,8 +0,0 @@
-staticdash/__init__.py,sha256=KqViaDkiQnhBI8-j3hr14umLDmPgddvdB_G1nJeC5Xs,38
-staticdash/dashboard.py,sha256=trPzco0AZw4IAwZzgY__RsOjwg4UrD7etB-4Da1kHE0,7515
-staticdash/assets/css/style.css,sha256=kL6FAGxIwYrfNoo4oCzC-ygHmyOZDEjhjixpY0YGpss,2649
-staticdash/assets/js/script.js,sha256=SMOyh7_E_BlvLYMEwYlvCnV7-GnMR-x8PtEiFbIIAsw,3089
-staticdash-0.2.1.dist-info/METADATA,sha256=IohPqKSIpXUNPsDhZUFXTpMbtwcrHzYwrhQnUX1Wync,2409
-staticdash-0.2.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-staticdash-0.2.1.dist-info/top_level.txt,sha256=3MzZU6SptkUkjcHV1cvPji0H4aRzPphLHnpStgGEcxM,11
-staticdash-0.2.1.dist-info/RECORD,,