montin 0.6.0__tar.gz

montin-0.6.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 André Rezende Dessimoni Carvalho
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

montin-0.6.0/PKG-INFO

@@ -0,0 +1,173 @@
+Metadata-Version: 2.4
+Name: montin
+Version: 0.6.0
+Summary: Generate self-contained, interactive HTML reports from data in Python
+Author-email: André Rezende Dessimoni Carvalho <andre.rdc@outlook.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/andre-dessimoni/montin
+Project-URL: Repository, https://github.com/andre-dessimoni/montin
+Project-URL: Issues, https://github.com/andre-dessimoni/montin/issues
+Project-URL: Documentation, https://montin.readthedocs.io/
+Keywords: report,dashboard,html,data,analytics,visualization,plotly,mermaid,self-contained,notebook
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Documentation
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Classifier: Topic :: Text Processing :: Markup :: HTML
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: jinja2>=3.1
+Provides-Extra: markdown
+Requires-Dist: markdown-it-py>=3.0; extra == "markdown"
+Provides-Extra: image
+Requires-Dist: pillow>=9.0; extra == "image"
+Provides-Extra: full
+Requires-Dist: markdown-it-py>=3.0; extra == "full"
+Requires-Dist: pillow>=9.0; extra == "full"
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: ruff>=0.4; extra == "dev"
+Requires-Dist: mypy>=1.10; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Requires-Dist: plotly>=5.0; extra == "dev"
+Requires-Dist: pandas>=1.5; extra == "dev"
+Requires-Dist: matplotlib>=3.5; extra == "dev"
+Dynamic: license-file
+
+# Montin
+
+> **See the whole.**
+
+[![CI](https://github.com/andre-dessimoni/montin/actions/workflows/ci.yml/badge.svg)](https://github.com/andre-dessimoni/montin/actions/workflows/ci.yml)
+
+Build **self-contained, interactive HTML reports** from Python — one file you
+can commit, or serve, with no runtime and no dependencies on the viewer's
+machine. Designed for **batch-generated data and ML output**: loop over your
+experiments, runs, or segments and emit a report per iteration.
+
+Content is laid out on a grid of typed cells (charts, tables, metrics, code,
+images, diagrams), and the whole deck embeds into a single `.html`.
+
+## Documentation
+
+https://montin.readthedocs.io/
+
+## Installation
+
+```bash
+pip install montin
+```
+
+
+## Quick start
+
+```python
+from montin import Deck
+
+deck = Deck(
+    title="My Report",
+)
+
+deck.add_title("My Report", subtitle="Subtitle here")
+deck.add_section("1 — Introduction")
+
+slide = deck.add_slide("Results", ncols=2)
+
+slide.add_metric(value=98.7, label="Efficiency (%)", delta=+2.3)
+slide.add_text("Text with **markdown** and LaTeX: $E = mc^2$")
+
+deck.write("report", open_browser=True)
+```
+
+## Batch generation
+
+The core use case — one report per run, generated in a loop:
+
+```python
+deck = Deck(title=f"Experiment Results", author="Company name", date="Jun 20th, 2026")
+
+for run in experiment_runs:
+    
+    deck.add_section(title=f"Run #{run.id}")    
+    
+    slide = deck.add_slide("Metrics", nrows=1, ncols=3)
+    
+    slide.add_metric(value=run.accuracy, label="Accuracy", delta=run.delta)
+    slide.add_plotly(run.loss_curve)
+    slide.add_table(run.results_table, caption="Results")
+
+deck.write("report")
+```
+
+
+## Cell types
+
+| Method | Cell | Description |
+|---|---|---|
+| `add_text` | TextCell | Markdown + LaTeX (MathJax) |
+| `add_metric` | MetricCell | KPI card with value, label and delta |
+| `add_table` | TableCell | CSV, dict, list or DataFrame |
+| `add_image` | ImageCell | Image with lightbox and zoom/pan |
+| `add_image_slider` | ImageSliderCell | Image carousel |
+| `add_list` | ListCell | Bullet or numbered list |
+| `add_code` | CodeCell | Code with syntax highlighting |
+| `add_plotly` | PlotlyCell | Interactive Plotly chart |
+| `add_mermaid` | MermaidCell | Declarative diagram (flowchart, etc.) |
+| `add_html` | HtmlCell | Raw HTML without escaping |
+| `add_iframe` | IframeCell | Embed external content |
+| `add_empty` | EmptyCell | Reserves space in the grid |
+
+## Common cell options
+
+All `add_*` methods accept:
+
+```python
+slide.add_text(
+    "content",
+    colspan=2,          # spans 2 columns
+    rowspan=1,
+    caption="Caption",
+    overflow=True,      # internal scroll
+    expand_button=True, # expand to fullscreen button
+    copy_button=True,   # copy button (CodeCell)
+    transparent=True,   # hides cell border and background
+)
+```
+
+## About the name
+
+**Montin** fuses two roots:
+
+- **Muntin** — the slender bar that divides a window's panes into one composed
+  whole. It maps directly onto the library's **CSS Grid**: the structure that
+  organizes cells and panels across a report.
+- **Monte** — a heap of raw data (simulations, DOE iterations, notebooks) waiting
+  to be processed and understood.
+
+Montin is the structure that turns a heap of data into understanding — and, from
+above, you *see the whole*.
+
+### Palette
+
+| Name | Hex | Use |
+|---|---|---|
+| Ink | `#0F1F2E` | Primary text, dark background |
+| Slate | `#35546B` | Secondary colour, UI elements |
+| Stone | `#9AA6B2` | Neutral, secondary text |
+| Sand | `#E9ECEF` | Light background, borders |
+| Accent | `#E07A3F` | Highlight (logo sun, CTAs, links) |
+
+## License
+
+MIT

montin-0.6.0/README.md

@@ -0,0 +1,126 @@
+# Montin
+
+> **See the whole.**
+
+[![CI](https://github.com/andre-dessimoni/montin/actions/workflows/ci.yml/badge.svg)](https://github.com/andre-dessimoni/montin/actions/workflows/ci.yml)
+
+Build **self-contained, interactive HTML reports** from Python — one file you
+can commit, or serve, with no runtime and no dependencies on the viewer's
+machine. Designed for **batch-generated data and ML output**: loop over your
+experiments, runs, or segments and emit a report per iteration.
+
+Content is laid out on a grid of typed cells (charts, tables, metrics, code,
+images, diagrams), and the whole deck embeds into a single `.html`.
+
+## Documentation
+
+https://montin.readthedocs.io/
+
+## Installation
+
+```bash
+pip install montin
+```
+
+
+## Quick start
+
+```python
+from montin import Deck
+
+deck = Deck(
+    title="My Report",
+)
+
+deck.add_title("My Report", subtitle="Subtitle here")
+deck.add_section("1 — Introduction")
+
+slide = deck.add_slide("Results", ncols=2)
+
+slide.add_metric(value=98.7, label="Efficiency (%)", delta=+2.3)
+slide.add_text("Text with **markdown** and LaTeX: $E = mc^2$")
+
+deck.write("report", open_browser=True)
+```
+
+## Batch generation
+
+The core use case — one report per run, generated in a loop:
+
+```python
+deck = Deck(title=f"Experiment Results", author="Company name", date="Jun 20th, 2026")
+
+for run in experiment_runs:
+    
+    deck.add_section(title=f"Run #{run.id}")    
+    
+    slide = deck.add_slide("Metrics", nrows=1, ncols=3)
+    
+    slide.add_metric(value=run.accuracy, label="Accuracy", delta=run.delta)
+    slide.add_plotly(run.loss_curve)
+    slide.add_table(run.results_table, caption="Results")
+
+deck.write("report")
+```
+
+
+## Cell types
+
+| Method | Cell | Description |
+|---|---|---|
+| `add_text` | TextCell | Markdown + LaTeX (MathJax) |
+| `add_metric` | MetricCell | KPI card with value, label and delta |
+| `add_table` | TableCell | CSV, dict, list or DataFrame |
+| `add_image` | ImageCell | Image with lightbox and zoom/pan |
+| `add_image_slider` | ImageSliderCell | Image carousel |
+| `add_list` | ListCell | Bullet or numbered list |
+| `add_code` | CodeCell | Code with syntax highlighting |
+| `add_plotly` | PlotlyCell | Interactive Plotly chart |
+| `add_mermaid` | MermaidCell | Declarative diagram (flowchart, etc.) |
+| `add_html` | HtmlCell | Raw HTML without escaping |
+| `add_iframe` | IframeCell | Embed external content |
+| `add_empty` | EmptyCell | Reserves space in the grid |
+
+## Common cell options
+
+All `add_*` methods accept:
+
+```python
+slide.add_text(
+    "content",
+    colspan=2,          # spans 2 columns
+    rowspan=1,
+    caption="Caption",
+    overflow=True,      # internal scroll
+    expand_button=True, # expand to fullscreen button
+    copy_button=True,   # copy button (CodeCell)
+    transparent=True,   # hides cell border and background
+)
+```
+
+## About the name
+
+**Montin** fuses two roots:
+
+- **Muntin** — the slender bar that divides a window's panes into one composed
+  whole. It maps directly onto the library's **CSS Grid**: the structure that
+  organizes cells and panels across a report.
+- **Monte** — a heap of raw data (simulations, DOE iterations, notebooks) waiting
+  to be processed and understood.
+
+Montin is the structure that turns a heap of data into understanding — and, from
+above, you *see the whole*.
+
+### Palette
+
+| Name | Hex | Use |
+|---|---|---|
+| Ink | `#0F1F2E` | Primary text, dark background |
+| Slate | `#35546B` | Secondary colour, UI elements |
+| Stone | `#9AA6B2` | Neutral, secondary text |
+| Sand | `#E9ECEF` | Light background, borders |
+| Accent | `#E07A3F` | Highlight (logo sun, CTAs, links) |
+
+## License
+
+MIT

montin-0.6.0/montin/__init__.py

@@ -0,0 +1,63 @@
+"""
+montin
+=======
+Python library for generating self-contained, interactive HTML reports
+from data — built for batch-generated ML and analytics output.
+
+Basic usage::
+
+    from montin import Deck, Plugin, SlideDefaults, CellDefaults
+
+    deck = Deck(title="My Report")
+    slide = deck.add_slide("Results", nrows=1, ncols=2)
+    slide.add_text("Hello, world!")
+    deck.write("my-report")
+"""
+
+from importlib.metadata import PackageNotFoundError, version
+
+from montin.core.deck import CellDefaults, Deck, SlideDefaults
+from montin.core.plugins import (
+    Highlight,
+    MathJax,
+    Mermaid,
+    Plotly,
+    Plugin,
+    Plugins,
+    Tabulator,
+)
+from montin.core.security import Security
+from montin.exceptions import (
+    CellPlacementError,
+    MontinError,
+    InvalidDataError,
+    PluginNotDeclaredError,
+    SecurityError,
+    ThemeNotFoundError,
+)
+
+try:
+    __version__ = version("montin")
+except PackageNotFoundError:  # running from source without installing
+    __version__ = "0.0.0.dev"
+
+__all__ = [
+    "Deck",
+    "Plugin",
+    "Plugins",
+    "Plotly",
+    "Mermaid",
+    "Highlight",
+    "MathJax",
+    "Tabulator",
+    "Security",
+    "SlideDefaults",
+    "CellDefaults",
+    "MontinError",
+    "CellPlacementError",
+    "PluginNotDeclaredError",
+    "ThemeNotFoundError",
+    "InvalidDataError",
+    "SecurityError",
+    "__version__",
+]

montin-0.6.0/montin/cells/__init__.py

@@ -0,0 +1,55 @@
+"""
+montin.cells
+=============
+Sub-package containing all cell types.
+
+Import directly from here::
+
+    from montin.cells import TextCell, TableCell, ImageCell, ...
+"""
+
+from montin.cells.base import (
+    _UNSET,
+    Cell,
+    CellParams,
+    cell_method,
+)
+from montin.cells.image import ImageCell
+from montin.cells.image_slider import ImageSliderCell
+from montin.cells.matplotlib import MatplotlibCell
+from montin.cells.misc import (
+    CodeCell,
+    EmptyCell,
+    HtmlCell,
+    IframeCell,
+    ListCell,
+    MermaidCell,
+    MetricCell,
+)
+from montin.cells.plotly import PlotlyCell
+from montin.cells.table import TableCell
+from montin.cells.tabulator import TabulatorCell
+from montin.cells.text import TextCell
+
+__all__ = [
+    # base
+    "_UNSET",
+    "Cell",
+    "CellParams",
+    "cell_method",
+    # concrete types
+    "TextCell",
+    "ImageCell",
+    "ImageSliderCell",
+    "MatplotlibCell",
+    "TableCell",
+    "TabulatorCell",
+    "ListCell",
+    "PlotlyCell",
+    "CodeCell",
+    "MetricCell",
+    "MermaidCell",
+    "HtmlCell",
+    "IframeCell",
+    "EmptyCell",
+]