staticdash 0.1.0__tar.gz → 0.1.2__tar.gz

{staticdash-0.1.0 → staticdash-0.1.2}/PKG-INFO

@@ -1,13 +1,16 @@
 Metadata-Version: 2.4
 Name: staticdash
-Version: 0.1.0
-Summary: A minimal static dashboard generator with Plotly support
+Version: 0.1.2
+Summary: A lightweight static HTML dashboard generator with Plotly and pandas support.
 Author-email: Brian Day <brian.day1@gmail.com>
-License-Expression: MIT
+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 
 
@@ -29,50 +32,50 @@ Create a Python script like this:
 
 ```python
 from staticdash.dashboard import Dashboard, Page
-import plotly.graph_objects as go
+import plotly.express as px
 import pandas as pd
+import numpy as np
 
-# Create the dashboard
-dashboard = Dashboard(title="StaticDash Demo")
+# Create sample data
+df = pd.DataFrame({
+    "Category": ["A", "B", "C", "D"],
+    "Value": [10, 20, 30, 40]
+})
 
-# Page 1: Overview
-page1 = Page("overview", "Overview")
+df2 = pd.DataFrame({
+    "Time": pd.date_range("2024-01-01", periods=10, freq="D"),
+    "Signal": np.random.randn(10).cumsum()
+})
 
-# Add plo
-fig = go.Figure()
-fig.add_trace(go.Scatter(x=[1, 2, 3], y=[4, 1, 6], mode='lines+markers', name="Demo Line"))
-fig.update_layout(title="Sample Plot")
-page1.append(fig)
+fig1 = px.bar(df, x="Category", y="Value", title="Bar Chart Example")
+fig2 = px.line(df2, x="Time", y="Signal", title="Signal over Time")
 
-# Add table
-df1 = pd.DataFrame({
-    "Category": ["A", "B", "C"],
-    "Value": [100, 200, 150]
-})
-page1.append(df1)
+# Build dashboard
+dashboard = Dashboard(title="StaticDash Demo")
 
-# Add extra text
-page1.append("This page includes a sample plot, table, and descriptive text.")
+# 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.")
+
+# Register pages
 dashboard.add_page(page1)
-
-# Page 2: Data Table
-page2 = Page("data", "Data")
-df2 = pd.DataFrame({
-    "Name": ["Alice", "Bob", "Charlie"],
-    "Score": [85, 92, 78],
-    "Passed": [True, True, False]
-})
-page2.append("This table shows individual scores and pass/fail status.")
-page2.append(df2)
 dashboard.add_page(page2)
-
-# Page 3: Notes
-page3 = Page("notes", "Notes")
-page3.append("These are concluding notes about the dataset.")
-page3.append("You can also add multiple text blocks like this.")
 dashboard.add_page(page3)
 
-# Publish the dashboard
+# Export
 dashboard.publish(output_dir="output")
 ```
 

staticdash-0.1.2/README.md

@@ -0,0 +1,68 @@
+# 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.")
+
+# Register pages
+dashboard.add_page(page1)
+dashboard.add_page(page2)
+dashboard.add_page(page3)
+
+# Export
+dashboard.publish(output_dir="output")
+```
+
+After running the script, open output/index.html in your browser.

staticdash-0.1.2/pyproject.toml

@@ -0,0 +1,29 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "staticdash"
+version = "0.1.2"
+description = "A lightweight static HTML dashboard generator with Plotly and pandas support."
+authors = [
+    { name = "Brian Day", email = "brian.day1@gmail.com" }
+]
+license = { text = "CC0-1.0" }
+readme = "README.md"
+requires-python = ">=3.8"
+dependencies = [
+    "plotly",
+    "pandas",
+    "dominate"
+]
+
+[tool.setuptools]
+packages = ["staticdash"]
+
+[tool.setuptools.package-data]
+staticdash = ["assets/css/*.css", "assets/js/*.js"]
+
+[project.urls]
+Homepage = "https://github.com/briday1/staticdash"
+Repository = "https://github.com/briday1/staticdash"

staticdash-0.1.2/staticdash/__init__.py

@@ -0,0 +1 @@
+from .dashboard import Page, Dashboard

staticdash-0.1.2/staticdash/assets/css/style.css

@@ -0,0 +1,100 @@
+body {
+  margin: 0;
+  font-family: sans-serif;
+  background-color: #f9f9f9;
+  color: #333;
+}
+
+#sidebar {
+  position: fixed;
+  top: 0;
+  left: 0;
+  width: 240px;
+  height: 100vh;
+  background-color: #2c3e50;
+  padding: 20px;
+  box-sizing: border-box;
+  overflow-y: auto;
+}
+
+#sidebar h1 {
+  color: #ecf0f1;
+  font-size: 20px;
+  margin-bottom: 20px;
+}
+
+.nav-link {
+  display: block;
+  color: #bdc3c7;
+  text-decoration: none;
+  margin: 10px 0;
+  font-weight: bold;
+  transition: color 0.3s;
+}
+
+.nav-link.active,
+.nav-link:hover {
+  color: #ffffff;
+}
+
+#content {
+  margin-left: 260px;
+  padding: 20px;
+  box-sizing: border-box;
+}
+
+.page-section {
+  display: none;
+}
+
+.page-section.active {
+  display: block;
+}
+
+.plot-container {
+  margin: 20px 0;
+}
+
+table {
+  width: 100%;
+  border-collapse: collapse;
+  margin-top: 1em;
+  background-color: white;
+  box-shadow: 0 2px 4px rgba(0, 0, 0, 0.1);
+}
+
+thead {
+  background-color: #2c3e50;
+  color: white;
+}
+
+th,
+td {
+  padding: 10px;
+  border: 1px solid #ddd;
+  text-align: left;
+}
+
+tr:nth-child(even) {
+  background-color: #f2f2f2;
+}
+
+tr:hover {
+  background-color: #e8f0fe;
+}
+
+.dash-image {
+  max-width: 100%;
+  height: auto;
+  margin: 1em 0;
+}
+
+
+.plot-container {
+  width: 100%;
+}
+
+.plot-container .plotly-graph-div {
+  width: 100% !important;
+  height: auto !important;
+}

staticdash-0.1.2/staticdash/assets/js/script.js

@@ -0,0 +1,43 @@
+document.addEventListener("DOMContentLoaded", () => {
+  const links = document.querySelectorAll(".nav-link");
+  const sections = document.querySelectorAll(".page-section");
+
+  function resizePlotsIn(section) {
+    const plots = section.querySelectorAll(".plotly-graph-div");
+    plots.forEach(plot => {
+      if (typeof Plotly !== "undefined" && plot.data) {
+        Plotly.Plots.resize(plot);
+      }
+    });
+  }
+
+  function showPage(id) {
+    sections.forEach(section => section.style.display = "none");
+    const page = document.getElementById(id);
+    if (page) {
+      page.style.display = "block";
+
+      // Resize Plotly charts within the newly visible section
+      requestAnimationFrame(() => {
+        resizePlotsIn(page);
+      });
+    }
+
+    links.forEach(link => link.classList.remove("active"));
+    const activeLink = Array.from(links).find(link => link.dataset.target === id);
+    if (activeLink) activeLink.classList.add("active");
+  }
+
+  links.forEach(link => {
+    link.addEventListener("click", e => {
+      e.preventDefault();
+      const targetId = link.dataset.target;
+      showPage(targetId);
+    });
+  });
+
+  // Initial page load
+  if (sections.length > 0) {
+    showPage(sections[0].id);
+  }
+});

staticdash-0.1.2/staticdash/dashboard.py

@@ -0,0 +1,119 @@
+import os
+import shutil
+import uuid
+import pandas as pd
+import plotly.graph_objects as go
+import plotly.express as px
+from dominate import document
+from dominate.tags import div, h1, h2, p, a, script, link, table, thead, tr, th, tbody, td, span
+from dominate.util import raw as raw_util  # To avoid ambiguity
+
+class Page:
+    def __init__(self, slug, title):
+        self.slug = slug
+        self.title = title
+        self.elements = []
+
+    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):
+        if table_id is None:
+            table_id = f"table-{len(self.elements)}"
+        html = df.to_html(classes="table-hover table-striped", index=False, border=0, table_id=table_id)
+        self.elements.append(("table", (html, table_id)))
+
+    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 render(self, index):
+        section = div(id=f"page-{index}", cls="page-section")
+        section += h1(self.title)
+        for kind, content in self.elements:
+            if 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)
+        return section
+
+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"):
+        os.makedirs(output_dir, exist_ok=True)
+        pages_dir = os.path.join(output_dir, "pages")
+        os.makedirs(pages_dir, exist_ok=True)
+
+        # Copy assets
+        assets_src = os.path.join(os.path.dirname(__file__), "assets")
+        assets_dst = os.path.join(output_dir, "assets")
+        shutil.copytree(assets_src, assets_dst, dirs_exist_ok=True)
+
+        # Generate each page
+        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"))
+
+            with doc:
+                with div(cls="page-section", id=f"page-{page.slug}"):
+                    h1(page.title)
+                    for kind, content in page.elements:
+                        if 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))
+
+        # Generate index.html with navigation
+        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"))
+
+        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="content"):
+                for page in self.pages:
+                    with div(id=f"page-{page.slug}", cls="page-section", style="display:none;"):
+                        h2(page.title)
+                        for kind, content in page.elements:
+                            if kind == "text":
+                                p(content)
+                            elif kind == "plot":
+                                div(content, cls="plot-container")
+                            elif kind == "table":
+                                table_html, _ = content
+                                div(raw_util(table_html))
+
+
+        with open(os.path.join(output_dir, "index.html"), "w") as f:
+            f.write(str(index_doc))

{staticdash-0.1.0 → staticdash-0.1.2}/staticdash.egg-info/PKG-INFO

@@ -1,13 +1,16 @@
 Metadata-Version: 2.4
 Name: staticdash
-Version: 0.1.0
-Summary: A minimal static dashboard generator with Plotly support
+Version: 0.1.2
+Summary: A lightweight static HTML dashboard generator with Plotly and pandas support.
 Author-email: Brian Day <brian.day1@gmail.com>
-License-Expression: MIT
+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 
 
@@ -29,50 +32,50 @@ Create a Python script like this:
 
 ```python
 from staticdash.dashboard import Dashboard, Page
-import plotly.graph_objects as go
+import plotly.express as px
 import pandas as pd
+import numpy as np
 
-# Create the dashboard
-dashboard = Dashboard(title="StaticDash Demo")
+# Create sample data
+df = pd.DataFrame({
+    "Category": ["A", "B", "C", "D"],
+    "Value": [10, 20, 30, 40]
+})
 
-# Page 1: Overview
-page1 = Page("overview", "Overview")
+df2 = pd.DataFrame({
+    "Time": pd.date_range("2024-01-01", periods=10, freq="D"),
+    "Signal": np.random.randn(10).cumsum()
+})
 
-# Add plo
-fig = go.Figure()
-fig.add_trace(go.Scatter(x=[1, 2, 3], y=[4, 1, 6], mode='lines+markers', name="Demo Line"))
-fig.update_layout(title="Sample Plot")
-page1.append(fig)
+fig1 = px.bar(df, x="Category", y="Value", title="Bar Chart Example")
+fig2 = px.line(df2, x="Time", y="Signal", title="Signal over Time")
 
-# Add table
-df1 = pd.DataFrame({
-    "Category": ["A", "B", "C"],
-    "Value": [100, 200, 150]
-})
-page1.append(df1)
+# Build dashboard
+dashboard = Dashboard(title="StaticDash Demo")
 
-# Add extra text
-page1.append("This page includes a sample plot, table, and descriptive text.")
+# 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.")
+
+# Register pages
 dashboard.add_page(page1)
-
-# Page 2: Data Table
-page2 = Page("data", "Data")
-df2 = pd.DataFrame({
-    "Name": ["Alice", "Bob", "Charlie"],
-    "Score": [85, 92, 78],
-    "Passed": [True, True, False]
-})
-page2.append("This table shows individual scores and pass/fail status.")
-page2.append(df2)
 dashboard.add_page(page2)
-
-# Page 3: Notes
-page3 = Page("notes", "Notes")
-page3.append("These are concluding notes about the dataset.")
-page3.append("You can also add multiple text blocks like this.")
 dashboard.add_page(page3)
 
-# Publish the dashboard
+# Export
 dashboard.publish(output_dir="output")
 ```
 

{staticdash-0.1.0 → staticdash-0.1.2}/staticdash.egg-info/SOURCES.txt

@@ -5,4 +5,7 @@ staticdash/dashboard.py
 staticdash.egg-info/PKG-INFO
 staticdash.egg-info/SOURCES.txt
 staticdash.egg-info/dependency_links.txt
-staticdash.egg-info/top_level.txt
+staticdash.egg-info/requires.txt
+staticdash.egg-info/top_level.txt
+staticdash/assets/css/style.css
+staticdash/assets/js/script.js

staticdash-0.1.2/staticdash.egg-info/requires.txt

@@ -0,0 +1,3 @@
+plotly
+pandas
+dominate

staticdash-0.1.0/README.md

@@ -1,68 +0,0 @@
-# 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.graph_objects as go
-import pandas as pd
-
-# Create the dashboard
-dashboard = Dashboard(title="StaticDash Demo")
-
-# Page 1: Overview
-page1 = Page("overview", "Overview")
-
-# Add plo
-fig = go.Figure()
-fig.add_trace(go.Scatter(x=[1, 2, 3], y=[4, 1, 6], mode='lines+markers', name="Demo Line"))
-fig.update_layout(title="Sample Plot")
-page1.append(fig)
-
-# Add table
-df1 = pd.DataFrame({
-    "Category": ["A", "B", "C"],
-    "Value": [100, 200, 150]
-})
-page1.append(df1)
-
-# Add extra text
-page1.append("This page includes a sample plot, table, and descriptive text.")
-dashboard.add_page(page1)
-
-# Page 2: Data Table
-page2 = Page("data", "Data")
-df2 = pd.DataFrame({
-    "Name": ["Alice", "Bob", "Charlie"],
-    "Score": [85, 92, 78],
-    "Passed": [True, True, False]
-})
-page2.append("This table shows individual scores and pass/fail status.")
-page2.append(df2)
-dashboard.add_page(page2)
-
-# Page 3: Notes
-page3 = Page("notes", "Notes")
-page3.append("These are concluding notes about the dataset.")
-page3.append("You can also add multiple text blocks like this.")
-dashboard.add_page(page3)
-
-# Publish the dashboard
-dashboard.publish(output_dir="output")
-```
-
-After running the script, open output/index.html in your browser.

staticdash-0.1.0/pyproject.toml

@@ -1,22 +0,0 @@
-[project]
-name = "staticdash"
-version = "0.1.0"
-description = "A minimal static dashboard generator with Plotly support"
-authors = [
-  { name = "Brian Day", email = "brian.day1@gmail.com" }
-]
-license = "MIT"
-readme = "README.md"
-requires-python = ">=3.8"
-
-[project.urls]
-Homepage = "https://github.com/briday1/staticdash"
-Repository = "https://github.com/briday1/staticdash"
-
-[build-system]
-requires = ["setuptools>=61.0"]
-build-backend = "setuptools.build_meta"
-
-[tool.setuptools.packages.find]
-include = ["staticdash*"]
-exclude = ["output*"]

staticdash-0.1.0/staticdash/__init__.py

@@ -1,2 +0,0 @@
-from .dashboard import Page, Dashboard
-import simpledash.assets.css

staticdash-0.1.0/staticdash/dashboard.py

@@ -1,88 +0,0 @@
-import os
-import shutil
-import dominate
-from dominate.tags import div, h1, h2, p, a, script, link, table, thead, tr, th, tbody, td
-from dominate.util import raw  # ✅ correct usage
-
-import plotly.graph_objs as go
-import pandas as pd
-
-
-class Page:
-    def __init__(self, slug, title):
-        self.slug = slug
-        self.title = title
-        self.elements = []
-
-    def append(self, element):
-        if isinstance(element, str):
-            self.elements.append(p(element))
-        elif isinstance(element, go.Figure):
-            html = element.to_html(include_plotlyjs=False, full_html=False)
-            self.elements.append(raw(html))
-        elif isinstance(element, pd.DataFrame):
-            tbl = table()
-            tbl.add(thead(tr(*[th(col) for col in element.columns])))
-            tb = tbody()
-            for _, row in element.iterrows():
-                tb.add(tr(*[td(str(val)) for val in row]))
-            tbl.add(tb)
-            self.elements.append(tbl)
-        else:
-            self.elements.append(element)
-
-
-class Dashboard:
-    def __init__(self, title="Dashboard"):
-        self.title = title
-        self.pages = []
-
-    def add_page(self, page):
-        self.pages.append(page)
-
-    def publish(self, output_dir="output"):
-        os.makedirs(output_dir, exist_ok=True)
-        self._write_assets(output_dir)
-        self._write_index(output_dir)
-
-    def _write_assets(self, output_dir):
-        css_src = os.path.join(os.path.dirname(__file__), "assets", "css", "style.css")
-        css_dst_dir = os.path.join(output_dir, "assets", "css")
-        os.makedirs(css_dst_dir, exist_ok=True)
-        shutil.copyfile(css_src, os.path.join(css_dst_dir, "style.css"))
-
-    def _write_index(self, output_dir):
-        doc = dominate.document(title=self.title)
-
-        with doc.head:
-            link(rel="stylesheet", href="assets/css/style.css")
-            script(src="https://cdn.plot.ly/plotly-latest.min.js")
-
-        with doc:
-            with div(id="sidebar"):
-                h1(self.title)
-                for i, page in enumerate(self.pages):
-                    a(page.title, href="#", cls="nav-link", onclick=f"showPage('page-{i}')")
-
-            with div(id="content"):
-                for i, page in enumerate(self.pages):
-                    section = div(id=f"page-{i}", cls="page-section")
-                    section.add(h2(page.title))
-                    for elem in page.elements:
-                        section.add(elem)
-
-        # JavaScript block
-        js_code = """
-        function showPage(id) {
-          document.querySelectorAll('.page-section').forEach(el => el.style.display = 'none');
-          document.getElementById(id).style.display = 'block';
-          document.querySelectorAll('.nav-link').forEach(el => el.classList.remove('active'));
-          event.target.classList.add('active');
-        }
-        window.onload = () => showPage('page-0');
-        """
-        with doc:
-            script(raw(js_code))
-
-        with open(os.path.join(output_dir, "index.html"), "w") as f:
-            f.write(doc.render())