staticdash 2026.6__py3-none-any.whl → 2026.7__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,98 @@
1
+ Metadata-Version: 2.4
2
+ Name: staticdash
3
+ Version: 2026.7
4
+ Summary: A lightweight static HTML dashboard generator with Plotly and pandas support.
5
+ Author-email: Brian Day <brian.day1@gmail.com>
6
+ License: CC0-1.0
7
+ Project-URL: Homepage, https://github.com/staticdash/staticdash
8
+ Project-URL: Repository, https://github.com/staticdash/staticdash
9
+ Requires-Python: >=3.8
10
+ Description-Content-Type: text/markdown
11
+ Requires-Dist: plotly
12
+ Requires-Dist: pandas
13
+ Requires-Dist: dominate
14
+ Requires-Dist: matplotlib
15
+ Requires-Dist: markdown
16
+ Requires-Dist: pymdown-extensions
17
+ Provides-Extra: images
18
+ Requires-Dist: kaleido; extra == "images"
19
+ Provides-Extra: all
20
+ Requires-Dist: kaleido; extra == "all"
21
+
22
+ # staticdash
23
+
24
+ <p align="center">
25
+ <img src="https://raw.githubusercontent.com/staticdash/staticdash/main/logo.svg" alt="staticdash logo" width="220" height="50">
26
+ </p>
27
+
28
+ staticdash is a lightweight Python module for creating static, multi-page HTML dashboards. It supports:
29
+
30
+ - **Plotly plots:** Interactive, responsive visualizations
31
+ - **Matplotlib figures:** Static plots and charts
32
+ - **Pandas DataFrames:** Sortable, searchable tables
33
+ - **Rich text formatting:** Full Markdown support including **bold**, *italic*, ~~strikethrough~~, lists, links, tables, and blockquotes
34
+ - **Math expressions:** LaTeX math rendering with MathJax (inline `$...$` and display `$$...$$`)
35
+ - **Mermaid diagrams:** Flowcharts, sequence diagrams, state diagrams, and more
36
+ - **File downloads:** Add download buttons for any file
37
+ - **Multi-page navigation:** Hierarchical sidebar with subpages
38
+ - **Custom styling:** Easily customize CSS and JavaScript
39
+ - **Air-gapped support:** All assets vendored for offline environments
40
+
41
+ ## Installation
42
+
43
+ ```bash
44
+ pip install staticdash
45
+ ```
46
+
47
+ ## Features
48
+
49
+ ### Content Types
50
+
51
+ - **Add Plotly figures:** `page.add(fig)` - Interactive plots with zoom, pan, hover tooltips
52
+ - **Add Matplotlib figures:** `page.add(fig)` - Static plots converted to PNG
53
+ - **Add tables:** `page.add(df)` - Pandas DataFrames rendered as sortable, searchable tables
54
+ - **Add text:** `page.add("Your text")` - Full Markdown support including:
55
+ - **Bold**, *italic*, ~~strikethrough~~
56
+ - Lists (ordered and unordered)
57
+ - Links, blockquotes, code blocks
58
+ - Tables in Markdown syntax
59
+ - **Add headers:** `page.add_header("Title", level=2)` - Markdown headers (h1-h6)
60
+ - **Add math:** Use `$inline math$` or `$$display math$$` for LaTeX expressions
61
+ - **Add diagrams:** Use ` ```mermaid ` code blocks for flowcharts, sequence diagrams, state diagrams, gantt charts
62
+ - **Add downloads:** `page.add_download("path/to/file", "Label")` - File download buttons
63
+
64
+ ### Layout & Styling
65
+
66
+ - **Sidebar navigation:** Fixed sidebar with hierarchical pages and subpages
67
+ - **Responsive design:** Works on desktop and mobile devices
68
+ - **Custom styling:** Edit `assets/css/style.css` for your own look
69
+ - **Per-page HTML:** Individual HTML files for each page plus combined dashboard
70
+
71
+ ### Air-Gapped Support
72
+
73
+ All external dependencies (Plotly, MathJax, Mermaid, Prism) are vendored during installation, ensuring dashboards work completely offline without internet access or CDN dependencies.
74
+
75
+ ## Live Demos
76
+
77
+ - **[Tutorial Dashboard](https://staticdash.github.io/staticdash/tutorial_output/)** - Comprehensive feature demonstration
78
+ - **[Directory Example](https://staticdash.github.io/staticdash/directory_out/)** - Multiple dashboard aggregation
79
+
80
+ ## Examples
81
+
82
+ The repository includes a comprehensive tutorial demonstrating all features:
83
+
84
+ **Tutorial Dashboard:** Run `python tutorial.py` to generate `tutorial_output/index.html`
85
+
86
+ The tutorial demonstrates:
87
+ - Basic page creation and navigation
88
+ - Text formatting with Markdown (bold, italic, strikethrough, lists, links, tables)
89
+ - Plotly and Matplotlib figures
90
+ - Pandas DataFrame tables
91
+ - Subpages and hierarchical navigation
92
+ - MathJax math expressions (inline and display)
93
+ - Mermaid diagrams (flowcharts, sequence diagrams, state diagrams)
94
+ - Directory class for aggregating multiple dashboards
95
+
96
+ ---
97
+
98
+ For the source code, see [`tutorial.py`](./tutorial.py) in this repository.
@@ -1,8 +1,9 @@
1
1
  staticdash/__init__.py,sha256=MQGR6LAqx2aFEA64MZz1ADxwpXLPn3VYNVIyjt9qx4Q,268
2
- staticdash/dashboard.py,sha256=7XCwSKzmY9K-DwSikzykQGtbsxzxEfqAaTJlUP-KuGE,46106
2
+ staticdash/dashboard.py,sha256=RReghZyNXt2Q2gK5wdLCKO7IPE877ojoXf7hlqwW34Y,31026
3
3
  staticdash/assets/css/style.css,sha256=AOYdkw-nK_WvV6im_Y34gz4rJZWifk5o-mRmCKwMP60,7014
4
4
  staticdash/assets/js/script.js,sha256=7xBRlz_19wybbNVwAcfuKNXtDEojGB4EB0Yj4klsoTA,6998
5
5
  staticdash/assets/vendor/mathjax/tex-mml-chtml.js,sha256=MASABpB4tYktI2Oitl4t-78w_lyA-D7b_s9GEP0JOGI,1173007
6
+ staticdash/assets/vendor/mermaid/mermaid.min.js,sha256=YWoQnxnNGGhC4R1Fs1rAdFazp1UTMQ9uoHU1GqQwseI,3338725
6
7
  staticdash/assets/vendor/plotly/plotly.min.js,sha256=ChdxmnJ1FwSGEhXaDlxc2z-ajVDv9cuEy2-LgHhmgrA,3632287
7
8
  staticdash/assets/vendor/prism/prism-tomorrow.min.css,sha256=GxX-KXGZigSK67YPJvbu12EiBx257zuZWr0AMiT1Kpg,1313
8
9
  staticdash/assets/vendor/prism/prism.min.js,sha256=EdE2oGDnjbSlWFc6T9waKCyJ8BTHnekiEzTYyXFwfQ0,19644
@@ -13,7 +14,7 @@ staticdash/assets/vendor/prism/components/prism-json.min.js,sha256=lW2GuqWufsQQZ
13
14
  staticdash/assets/vendor/prism/components/prism-markup.min.js,sha256=h5_J0lbDUtmA4FOFf6cHMwhTuL-2fOKE6mYaJN7FdW4,2850
14
15
  staticdash/assets/vendor/prism/components/prism-python.min.js,sha256=7UOFaFvPLUk1yNu6tL3hZgPaEyngktK_NsPa3WfpqFw,2113
15
16
  staticdash/assets/vendor/prism/components/prism-sql.min.js,sha256=P8X4zmmVDsc63JcvBh30Kq6nj6pIZHCRNOoq3Ag_OjM,3261
16
- staticdash-2026.6.dist-info/METADATA,sha256=gYrNTyhXOQWigyRspfiGBRzPJ7qfV17nooCMRFUdH-o,2521
17
- staticdash-2026.6.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
18
- staticdash-2026.6.dist-info/top_level.txt,sha256=3MzZU6SptkUkjcHV1cvPji0H4aRzPphLHnpStgGEcxM,11
19
- staticdash-2026.6.dist-info/RECORD,,
17
+ staticdash-2026.7.dist-info/METADATA,sha256=Lc5A27ADNcCNL2VGOiTu9_K7IjCLNH58PADa-Cq1U2Y,4061
18
+ staticdash-2026.7.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
19
+ staticdash-2026.7.dist-info/top_level.txt,sha256=3MzZU6SptkUkjcHV1cvPji0H4aRzPphLHnpStgGEcxM,11
20
+ staticdash-2026.7.dist-info/RECORD,,
@@ -1,5 +1,5 @@
1
1
  Wheel-Version: 1.0
2
- Generator: setuptools (80.9.0)
2
+ Generator: setuptools (80.10.2)
3
3
  Root-Is-Purelib: true
4
4
  Tag: py3-none-any
5
5
 
@@ -1,71 +0,0 @@
1
- Metadata-Version: 2.4
2
- Name: staticdash
3
- Version: 2026.6
4
- Summary: A lightweight static HTML dashboard generator with Plotly and pandas support.
5
- Author-email: Brian Day <brian.day1@gmail.com>
6
- License: CC0-1.0
7
- Project-URL: Homepage, https://github.com/staticdash/staticdash
8
- Project-URL: Repository, https://github.com/staticdash/staticdash
9
- Requires-Python: >=3.8
10
- Description-Content-Type: text/markdown
11
- Requires-Dist: plotly
12
- Requires-Dist: pandas
13
- Requires-Dist: dominate
14
- Requires-Dist: matplotlib
15
- Provides-Extra: images
16
- Requires-Dist: kaleido; extra == "images"
17
- Provides-Extra: all
18
- Requires-Dist: kaleido; extra == "all"
19
-
20
- # staticdash
21
-
22
- <p align="center">
23
- <img src="https://raw.githubusercontent.com/staticdash/staticdash/main/logo.svg" alt="staticdash logo" width="220" height="50">
24
- </p>
25
-
26
- staticdash is a lightweight Python module for creating static, multi-page HTML dashboards. It supports:
27
-
28
- - Plotly plots (interactive, responsive)
29
- - Pandas DataFrames as sortable tables
30
- - Text and headers (Markdown-like)
31
- - File download buttons
32
- - Multi-page navigation with sidebar
33
- - Custom CSS and JavaScript
34
- - Easy extension for new content types
35
-
36
- ## Installation
37
-
38
- ```bash
39
- pip install staticdash
40
- ```
41
-
42
- ## Features
43
-
44
- - **Add Plotly figures:** `page.add(fig)`
45
- - **Add tables:** `page.add(df)` (sortable by default)
46
- - **Add text or headers:** `page.add("Some text")`, `page.add_header("Title", level=2)`
47
- - **Add download buttons:** `page.add_download("path/to/file", "Label")`
48
- - **Multi-page:** Create multiple `Page` objects and add them to your `Dashboard`
49
- - **Custom styling:** Edit `assets/css/style.css` for your own look
50
-
51
- ## Options
52
-
53
- - **Sidebar navigation:** Fixed, with active highlighting
54
- - **Responsive layout:** Works on desktop and mobile
55
- - **Export:** Outputs a static HTML dashboard (no server needed)
56
- - **Per-page HTML:** Also generates individual HTML files for each page
57
-
58
- ## Live Demo
59
-
60
- [View the latest demo dashboard](https://staticdash.github.io/staticdash/)
61
-
62
- ## Examples
63
-
64
- This repository includes two example dashboards that demonstrate staticdash capabilities:
65
-
66
- - **Tutorial Dashboard:** [View tutorial_output/index.html](https://staticdash.github.io/staticdash/tutorial_output/index.html) - A comprehensive tutorial showing all staticdash features
67
- - **Directory Example:** [View directory_out/index.html](https://staticdash.github.io/staticdash/directory_out/index.html) - Demonstrates the Directory class for aggregating multiple dashboards
68
-
69
- ---
70
-
71
- For a full example, see [`demo.py`](./demo.py) in this repository.