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

staticdash-0.2.2.dist-info/METADATA

@@ -0,0 +1,57 @@
+Metadata-Version: 2.4
+Name: staticdash
+Version: 0.2.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
+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.2.1.dist-info → staticdash-0.2.2.dist-info}/RECORD

@@ -2,7 +2,7 @@ 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,,
+staticdash-0.2.2.dist-info/METADATA,sha256=VDgodqPfaNsvqb-H8gqWWpixRKZie42xF3xG7jlz7rA,1776
+staticdash-0.2.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+staticdash-0.2.2.dist-info/top_level.txt,sha256=3MzZU6SptkUkjcHV1cvPji0H4aRzPphLHnpStgGEcxM,11
+staticdash-0.2.2.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.