icplot 0.8.3__tar.gz → 0.9.0__tar.gz

{icplot-0.8.3/src/icplot.egg-info → icplot-0.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: icplot
-Version: 0.8.3
+Version: 0.9.0
 Summary: Utilities for generating plots and graphics for technical reports.
 Author: Irish Centre for High End Computing
 License: MIT
@@ -16,30 +16,22 @@ Requires-Python: >=3.14
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: iccore==0.2.6
-Requires-Dist: ichec_platform_core==0.1.7
+Requires-Dist: pydantic
+Requires-Dist: PyYAML
 Requires-Dist: graphviz
 Requires-Dist: Jinja2
 Requires-Dist: fonttools[woff]
 Provides-Extra: cairo
 Requires-Dist: CairoSVG; extra == "cairo"
-Provides-Extra: imagemagick
-Requires-Dist: wand; extra == "imagemagick"
-Provides-Extra: plot
-Requires-Dist: matplotlib; extra == "plot"
-Provides-Extra: video
-Requires-Dist: moviepy; extra == "video"
 Provides-Extra: preview
 Requires-Dist: playwright; extra == "preview"
 Provides-Extra: all
 Requires-Dist: CairoSVG; extra == "all"
-Requires-Dist: wand; extra == "all"
-Requires-Dist: matplotlib; extra == "all"
-Requires-Dist: moviepy; extra == "all"
 Dynamic: license-file
 
 # icplot
 
-`icplot` makes plots, diagrams and images for technical documents at
+`icplot` makes diagrams and images for technical documents at
 [ICHEC](https://www.ichec.ie). It converts between image formats, renders
 text-based diagrams to images and applies a shared theme.
 
@@ -57,14 +49,11 @@ The core install is small. Add the extras for the backends you need:
 
 | Extra | Installs | For |
 |---|---|---|
-| `cairo` | CairoSVG | SVG to PNG or PDF, and drawing scenes |
-| `imagemagick` | wand | PDF to PNG |
-| `plot` | matplotlib | plots and charts |
-| `video` | moviepy | videos |
-| `all` | all of these | everything |
+| `cairo` | CairoSVG | SVG to PNG or PDF |
+| `preview` | Playwright | PNG previews of diagrams, drawn by Chromium |
 
-For example, `pip install "icplot[cairo]"`. The `cairo` and `imagemagick`
-extras also need the system libraries. On a Mac:
+For example, `pip install "icplot[cairo]"`. The `cairo` extra needs the cairo
+library, and PDF to PNG needs ImageMagick's `magick`. On a Mac:
 
 ```shell
 brew install imagemagick cairo
@@ -85,8 +74,7 @@ icplot render uml_diagram.puml
 ```
 
 This renders the PlantUML file to PNG and SVG. `icplot` also renders LaTeX and
-TikZ, and Mermaid. It renders its own JSON formats for plots, trees, Gantt
-charts and scenes.
+TikZ, and Mermaid.
 
 ## Render a folder of diagrams
 

{icplot-0.8.3 → icplot-0.9.0}/README.md

@@ -1,6 +1,6 @@
 # icplot
 
-`icplot` makes plots, diagrams and images for technical documents at
+`icplot` makes diagrams and images for technical documents at
 [ICHEC](https://www.ichec.ie). It converts between image formats, renders
 text-based diagrams to images and applies a shared theme.
 
@@ -18,14 +18,11 @@ The core install is small. Add the extras for the backends you need:
 
 | Extra | Installs | For |
 |---|---|---|
-| `cairo` | CairoSVG | SVG to PNG or PDF, and drawing scenes |
-| `imagemagick` | wand | PDF to PNG |
-| `plot` | matplotlib | plots and charts |
-| `video` | moviepy | videos |
-| `all` | all of these | everything |
+| `cairo` | CairoSVG | SVG to PNG or PDF |
+| `preview` | Playwright | PNG previews of diagrams, drawn by Chromium |
 
-For example, `pip install "icplot[cairo]"`. The `cairo` and `imagemagick`
-extras also need the system libraries. On a Mac:
+For example, `pip install "icplot[cairo]"`. The `cairo` extra needs the cairo
+library, and PDF to PNG needs ImageMagick's `magick`. On a Mac:
 
 ```shell
 brew install imagemagick cairo
@@ -46,8 +43,7 @@ icplot render uml_diagram.puml
 ```
 
 This renders the PlantUML file to PNG and SVG. `icplot` also renders LaTeX and
-TikZ, and Mermaid. It renders its own JSON formats for plots, trees, Gantt
-charts and scenes.
+TikZ, and Mermaid.
 
 ## Render a folder of diagrams
 

{icplot-0.8.3 → icplot-0.9.0}/pyproject.toml

@@ -17,13 +17,11 @@ classifiers = [
 ]
 keywords = ["Publishing", "Technical Reports", "Graphics"]
 
-# Core is deliberately light: only what every import path needs. The heavy
-# rendering backends (matplotlib/moviepy/wand) are optional extras
-# so consumers that only use the converter or diagram renderer (e.g. the
-# handbook build) can install a small footprint. Use icplot[all] for the
-# previous behaviour of pulling every backend.
+# Core holds only what every import path needs. Cairo and the Chromium
+# preview are optional extras, so the handbook build stays small.
 dependencies = ["iccore==0.2.6",
-                "ichec_platform_core==0.1.7",
+                "pydantic",
+                "PyYAML",
                 "graphviz",
                 "Jinja2",
                 "fonttools[woff]"]
@@ -33,32 +31,16 @@ Repository = "https://git.ichec.ie/platform-engineering/modules/documentation/ic
 Homepage = "https://git.ichec.ie/platform-engineering/modules/documentation/ichec-plot"
 
 [project.optional-dependencies]
-# svg/pdf conversion (converter.svg_to_png / svg_to_pdf) and vector scene
-# drawing (renderer.scene.cairo). CairoSVG pulls cairocffi, which dlopens
-# libcairo at runtime — no C build step, and one cairo binding rather than two.
+# SVG to PNG or PDF (converter.svg_to_png / svg_to_pdf). CairoSVG pulls
+# cairocffi, which dlopens libcairo at runtime, so there is no C build step.
 cairo = ["CairoSVG"]
 
-# raster conversion via ImageMagick bindings (converter.pdf_to_png);
-# falls back to the `magick` CLI if wand is absent
-imagemagick = ["wand"]
-
-# 2D plotting backend (icplot.renderer.graph / icplot.charts)
-plot = ["matplotlib"]
-
-# video assembly (renderer.video, driven from renderer.graph.mpl)
-video = ["moviepy"]
-
 # PNG previews of diagrams, drawn by headless Chromium so embedded fonts and
 # shadows render as in a browser. Run `playwright install chromium` once.
 preview = ["playwright"]
 
-# convenience aggregate — every backend
-all = [
-   "CairoSVG",
-   "wand",
-   "matplotlib",
-   "moviepy",
-]
+# Kept so existing `icplot[all]` installs still resolve.
+all = ["CairoSVG"]
 
 [build-system]
 requires = ["setuptools>=64", "setuptools-scm>=8"]

{icplot-0.8.3 → icplot-0.9.0}/src/icplot/converter/image.py

@@ -11,14 +11,6 @@ from pathlib import Path
 
 logger = logging.getLogger(__name__)
 
-_HAS_WAND = True
-try:
-    from wand.color import Color
-    from wand.image import Image
-except ImportError as e:
-    logger.debug("wand not available: %s", e)
-    _HAS_WAND = False
-
 _HAS_CAIRO_SVG = True
 try:
     import cairosvg
@@ -27,10 +19,6 @@ except ImportError as e:
     _HAS_CAIRO_SVG = False
 
 
-def has_wand() -> bool:
-    return _HAS_WAND
-
-
 def has_magick() -> bool:
     return bool(shutil.which("magick"))
 
@@ -67,24 +55,12 @@ def _pdf_to_png(source: Path, target: Path | None = None, resolution: int = 300)
 
 def pdf_to_png(source: Path, target: Path | None = None, resolution: int = 300):
     """
-    Convert a pdf to png with white background
+    Convert a pdf to png with white background, using ImageMagick's magick
     """
 
-    if not has_wand():
-        if has_magick():
-            _pdf_to_png(source, target, resolution)
-            return
-        else:
-            raise RuntimeError("Loading Wand failed - no pdf to png support")
-
-    outfile = _get_out_filename(source, target, "png")
-    os.makedirs(outfile.parent, exist_ok=True)
-
-    with Image(filename=source, resolution=resolution) as img:
-        img.format = "png"
-        img.background_color = Color("white")
-        img.alpha_channel = "remove"
-        img.save(filename=outfile)
+    if not has_magick():
+        raise RuntimeError("magick not found - no pdf to png support")
+    _pdf_to_png(source, target, resolution)
 
 
 def svg_to_png(source: Path, target: Path | None = None):

{icplot-0.8.3 → icplot-0.9.0/src/icplot.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: icplot
-Version: 0.8.3
+Version: 0.9.0
 Summary: Utilities for generating plots and graphics for technical reports.
 Author: Irish Centre for High End Computing
 License: MIT
@@ -16,30 +16,22 @@ Requires-Python: >=3.14
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: iccore==0.2.6
-Requires-Dist: ichec_platform_core==0.1.7
+Requires-Dist: pydantic
+Requires-Dist: PyYAML
 Requires-Dist: graphviz
 Requires-Dist: Jinja2
 Requires-Dist: fonttools[woff]
 Provides-Extra: cairo
 Requires-Dist: CairoSVG; extra == "cairo"
-Provides-Extra: imagemagick
-Requires-Dist: wand; extra == "imagemagick"
-Provides-Extra: plot
-Requires-Dist: matplotlib; extra == "plot"
-Provides-Extra: video
-Requires-Dist: moviepy; extra == "video"
 Provides-Extra: preview
 Requires-Dist: playwright; extra == "preview"
 Provides-Extra: all
 Requires-Dist: CairoSVG; extra == "all"
-Requires-Dist: wand; extra == "all"
-Requires-Dist: matplotlib; extra == "all"
-Requires-Dist: moviepy; extra == "all"
 Dynamic: license-file
 
 # icplot
 
-`icplot` makes plots, diagrams and images for technical documents at
+`icplot` makes diagrams and images for technical documents at
 [ICHEC](https://www.ichec.ie). It converts between image formats, renders
 text-based diagrams to images and applies a shared theme.
 
@@ -57,14 +49,11 @@ The core install is small. Add the extras for the backends you need:
 
 | Extra | Installs | For |
 |---|---|---|
-| `cairo` | CairoSVG | SVG to PNG or PDF, and drawing scenes |
-| `imagemagick` | wand | PDF to PNG |
-| `plot` | matplotlib | plots and charts |
-| `video` | moviepy | videos |
-| `all` | all of these | everything |
+| `cairo` | CairoSVG | SVG to PNG or PDF |
+| `preview` | Playwright | PNG previews of diagrams, drawn by Chromium |
 
-For example, `pip install "icplot[cairo]"`. The `cairo` and `imagemagick`
-extras also need the system libraries. On a Mac:
+For example, `pip install "icplot[cairo]"`. The `cairo` extra needs the cairo
+library, and PDF to PNG needs ImageMagick's `magick`. On a Mac:
 
 ```shell
 brew install imagemagick cairo
@@ -85,8 +74,7 @@ icplot render uml_diagram.puml
 ```
 
 This renders the PlantUML file to PNG and SVG. `icplot` also renders LaTeX and
-TikZ, and Mermaid. It renders its own JSON formats for plots, trees, Gantt
-charts and scenes.
+TikZ, and Mermaid.
 
 ## Render a folder of diagrams
 

{icplot-0.8.3 → icplot-0.9.0}/src/icplot.egg-info/SOURCES.txt

@@ -4,16 +4,12 @@ pyproject.toml
 src/icplot/__init__.py
 src/icplot/main_cli.py
 src/icplot/py.typed
-src/icplot/scene.py
 src/icplot.egg-info/PKG-INFO
 src/icplot.egg-info/SOURCES.txt
 src/icplot.egg-info/dependency_links.txt
 src/icplot.egg-info/entry_points.txt
 src/icplot.egg-info/requires.txt
 src/icplot.egg-info/top_level.txt
-src/icplot/charts/__init__.py
-src/icplot/charts/gantt.py
-src/icplot/charts/tree.py
 src/icplot/converter/__init__.py
 src/icplot/converter/cli.py
 src/icplot/converter/convert.py
@@ -193,29 +189,15 @@ src/icplot/diagram/assets/simple-icons/sentry.svg
 src/icplot/diagram/assets/simple-icons/trivy.svg
 src/icplot/diagram/assets/simple-icons/wireguard.svg
 src/icplot/diagram/assets/simple-icons/zenodo.svg
-src/icplot/graph/__init__.py
-src/icplot/graph/axis.py
-src/icplot/graph/plot.py
-src/icplot/graph/plot_group.py
-src/icplot/graph/series.py
 src/icplot/renderer/__init__.py
 src/icplot/renderer/cli.py
 src/icplot/renderer/config.py
 src/icplot/renderer/frontmatter.py
 src/icplot/renderer/render.py
-src/icplot/renderer/video.py
-src/icplot/renderer/charts/pgfgantt.py
-src/icplot/renderer/charts/svggantt.py
 src/icplot/renderer/formats/__init__.py
 src/icplot/renderer/formats/mermaid.py
 src/icplot/renderer/formats/plantuml.py
 src/icplot/renderer/formats/tex.py
-src/icplot/renderer/graph/__init__.py
-src/icplot/renderer/graph/color.py
-src/icplot/renderer/graph/matplotlib.py
-src/icplot/renderer/graph/mpl.py
-src/icplot/renderer/graph/renderer.py
-src/icplot/renderer/scene/cairo.py
 src/icplot/theme/__init__.py
 src/icplot/theme/cli.py
 src/icplot/theme/color.py
@@ -224,17 +206,12 @@ src/icplot/theme/theme.py
 src/icplot/theme/theme_generator.py
 src/icplot/theme/templates/puml.j2
 src/icplot/theme/templates/tikz.j2
-test/test_cairo.py
 test/test_diagram.py
 test/test_diagram_brand.py
 test/test_diagram_preview.py
 test/test_frontmatter.py
-test/test_gantt_chart.py
 test/test_image.py
-test/test_line_plots.py
 test/test_mermaid.py
-test/test_plot_group.py
 test/test_puml.py
 test/test_tex.py
-test/test_theme_generator.py
-test/test_tree.py
+test/test_theme_generator.py

icplot-0.9.0/src/icplot.egg-info/requires.txt

@@ -0,0 +1,15 @@
+iccore==0.2.6
+pydantic
+PyYAML
+graphviz
+Jinja2
+fonttools[woff]
+
+[all]
+CairoSVG
+
+[cairo]
+CairoSVG
+
+[preview]
+playwright

icplot-0.8.3/src/icplot/charts/gantt.py

@@ -1,25 +0,0 @@
-"""
-This module represents a gantt chard
-"""
-
-from datetime import datetime
-
-from ichec_platform_core.project import Milestone
-from pydantic import BaseModel
-
-from icplot.theme.color import Color
-
-
-class GanttChart(BaseModel, frozen=True):
-    """
-    A gantt chart
-    """
-
-    milestones: list[Milestone] = []
-    title: str = ""
-    start_date: datetime | None = None
-    end_date: datetime | None = None
-    bar_max_height: float = 0.1
-    height: int = 100
-    width: int = 500
-    bar_color: Color = Color.from_rgba(0.7, 0, 0)

icplot-0.8.3/src/icplot/charts/tree.py

@@ -1,103 +0,0 @@
-import logging
-import os
-import shutil
-from collections.abc import Callable
-from dataclasses import dataclass
-from pathlib import Path
-
-import graphviz
-
-logger = logging.getLogger(__name__)
-
-
-@dataclass
-class TreeFunctions:
-    find_children: Callable[[], list]
-    find_decision_content: Callable[[], str]
-    find_leaf_content: Callable[[], str]
-
-
-def _sub_string(node, tree_functions, spacing="  "):
-    """Visualize a tree in string form"""
-    out_str = ""
-    children = tree_functions.find_children(node)
-    if children is None or len(children) == 0:
-        out_str = f"{tree_functions.find_leaf_content(node)}\n"
-    else:
-        out_str = f"{tree_functions.find_decision_content(node)},\n"
-        for i, child in enumerate(children):
-            out_str = (
-                f"{out_str}"
-                f"\n{spacing}Child {i}:"
-                f"{_sub_string(child, tree_functions, 2 * spacing)}"
-            )
-    return out_str
-
-
-def _sub_graph(
-    graph,
-    node,
-    tree_functions,
-    label="0",
-    parent_label=None,
-):
-    children = tree_functions.find_children(node)
-    if children is None or len(children) == 0:
-        graph.node(label, tree_functions.find_leaf_content(node), shape="ellipse")
-    else:
-        graph.node(label, tree_functions.find_decision_content(node), shape="box")
-        for i, child in enumerate(children):
-            _sub_graph(
-                graph,
-                child,
-                tree_functions,
-                f"{label}|{i}",
-                parent_label=label,
-            )
-    if parent_label:
-        graph.edge(parent_label, label)
-
-
-def has_graphviz():
-    graphviz_path = shutil.which("dot")
-    return graphviz_path and os.access(graphviz_path, os.X_OK)
-
-
-def display_tree(
-    root,
-    path: Path,
-    find_children: Callable[[], list],
-    find_decision_content: Callable[[], str],
-    find_leaf_content: Callable[[], str],
-):
-    """
-    Allows classes which have attributes that are instances of the same class (children)
-    to be visualised as a decision tree.
-    Uses graphviz by default, alternatively, if system-wide graphviz is not available,
-    uses a string representation .
-
-    :param callable find_children: Function that takes a "node" and returns a list of
-        children nodes
-    :param callable find_decision_content: Function that takes a "node" and returns a
-        string for content for decision nodes
-    :param callable find_leaf_content: Function that takes a "node" and returns a
-        string for content for leaf nodes
-    """
-    tree_functions = TreeFunctions(
-        find_children, find_decision_content, find_leaf_content
-    )
-    if has_graphviz():
-        graph = graphviz.Digraph(path.name, comment="Graphviz representation of tree")
-        graph.format = "svg"
-        _sub_graph(graph, root, tree_functions)
-        graph.render(directory=path.parent, filename=path.name, cleanup=True).replace(
-            "\\", "/"
-        )
-    else:
-        # If system graphviz install isn't available, use string representation
-        logger.info(
-            "Warning: System graphviz install could not be found, creating string "
-            "representation instead"
-        )
-        with open(f"{path}.txt", "w", encoding="utf-8") as f:
-            f.write(_sub_string(root, tree_functions))

icplot-0.8.3/src/icplot/graph/__init__.py

@@ -1,6 +0,0 @@
-from .axis import *  # NOQA
-from .plot import *  # NOQA
-from .plot_group import PlotGroupCreate, PlotGroupPublic
-from .series import *  # NOQA
-
-__all__ = ["PlotGroupCreate", "PlotGroupPublic"]

icplot-0.8.3/src/icplot/graph/axis.py

@@ -1,44 +0,0 @@
-"""
-This module has a plot's axis
-"""
-
-from pydantic import BaseModel
-
-
-class Range(BaseModel, frozen=True):
-    """
-    This is a sequence of numbers specified by lower and upper
-    bounds and a step size. Eg (1, 5, 1) gives: [1, 2, 3, 4]
-    """
-
-    lower: int
-    upper: int
-    step: int
-
-    def eval(self) -> list:
-        return list(range(self.lower, self.upper, self.step))
-
-
-class PlotAxis(BaseModel, frozen=True):
-    """
-    This is a plot's axis
-
-    :param str label: The axis label
-    :param Range | None: A specification for tick marks
-    """
-
-    label: str = ""
-    ticks: Range | list[int] | None = None
-    scale: str = "linear"
-    text_fontsize: int = 10
-    tick_fontsize: int = 10
-    max_ticks: int = 0
-    limits: dict = {}
-
-    @property
-    def resolved_ticks(self) -> list:
-        if self.ticks:
-            if isinstance(self.ticks, Range):
-                return self.ticks.eval()
-            return self.ticks
-        return []

icplot-0.8.3/src/icplot/graph/plot.py

@@ -1,71 +0,0 @@
-"""
-This module has content for generating plots
-"""
-
-import random
-
-from pydantic import BaseModel
-
-from .axis import PlotAxis
-from .series import ImageSeries, LinePlotSeries, ScatterPlotSeries
-
-
-class Plot(BaseModel, frozen=True):
-    """
-    A generic plot with optional axis ticks
-    """
-
-    title: str = ""
-    name: str = ""
-    x_axis: PlotAxis = PlotAxis()
-    y_axes: list[PlotAxis] = [PlotAxis()]
-    plot_type: str = ""
-    line_series: list[LinePlotSeries] = []
-    scatter_series: list[ScatterPlotSeries] = []
-    image_series: list[ImageSeries] = []
-    legend: str = "none"
-    aspect: str = "auto"
-    legend_fontsize: int = 10
-    title_fontsize: int = 10
-
-    @property
-    def series(self):
-        return self.line_series + self.scatter_series + self.image_series
-
-
-class GridPlot(Plot, frozen=True):
-    """
-    Make a grid of plots
-    """
-
-    stride: int = 4
-    size: tuple = (25, 20)
-    data: list = []
-
-    def get_series_indices(self, num_samples: int = 0):
-        rows = max(1, num_samples // self.stride)
-        cols = num_samples // rows
-        len_data = len(self.data)
-
-        if num_samples == 0:
-            indices = list(range(0, len_data))
-        else:
-            indices = [random.randint(0, len_data - 1) for _ in range(num_samples)]
-        return rows, cols, indices
-
-    def get_subplots(self, num_samples: int = 0):
-        rows, cols, indices = self.get_series_indices(num_samples)
-
-        subplots = []
-        count = 1
-        for index in indices:
-            if num_samples > 0 and count == num_samples + 1:
-                break
-            if isinstance(self.data[index], list):
-                for series in self.data[index]:
-                    subplots.append(series)
-                    count += 1
-            else:
-                subplots.append(self.data[index])
-                count += 1
-        return rows, cols, subplots