icplot 0.1.4__tar.gz → 0.1.5__tar.gz

{icplot-0.1.4/src/icplot.egg-info → icplot-0.1.5}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: icplot
-Version: 0.1.4
+Version: 0.1.5
 Summary: Utilities for generating plots and graphics for technical reports.
 Author-email: "James Grogan, Irish Centre for High End Computing" <james.grogan@ichec.ie>
 Project-URL: Repository, https://git.ichec.ie/performance/toolshed/icplot
@@ -11,7 +11,7 @@ Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
 Classifier: Operating System :: OS Independent
 Classifier: Topic :: System :: Distributed Computing
-Requires-Python: >=3.8
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: wand
@@ -28,6 +28,7 @@ Requires-Dist: pylint; extra == "test"
 Provides-Extra: cairo
 Requires-Dist: pycairo; extra == "cairo"
 Requires-Dist: CairoSVG; extra == "cairo"
+Dynamic: license-file
 
 # icplot
 
@@ -38,8 +39,9 @@ This is a library used at [The Irish Centre for High End Computing (ICHEC)](http
 The project has support for:
 
 * Coverting image formats between pdf, svg and png
-* Building pdf output from tex files, including tikz.
+* Building pdf and png output from tex files, including tikz.
 * Generating plots based on a serializable data model to support reproducible research
+* Generating mermaid plots
 
 To covert between image formats you can do:
 
@@ -53,6 +55,12 @@ To render a Tex tikz image as pdf and png you can do:
 icplot convert --source my_tikz.tex
 ```
 
+To render a Mermaid plot as png you can do:
+
+``` shell
+icplot convert --source my_mermaid.mmd
+```
+
 To generate a plot or collection of plots from a yaml description you can do:
 
 ``` shell

{icplot-0.1.4 → icplot-0.1.5}/README.md

@@ -7,8 +7,9 @@ This is a library used at [The Irish Centre for High End Computing (ICHEC)](http
 The project has support for:
 
 * Coverting image formats between pdf, svg and png
-* Building pdf output from tex files, including tikz.
+* Building pdf and png output from tex files, including tikz.
 * Generating plots based on a serializable data model to support reproducible research
+* Generating mermaid plots
 
 To covert between image formats you can do:
 
@@ -22,6 +23,12 @@ To render a Tex tikz image as pdf and png you can do:
 icplot convert --source my_tikz.tex
 ```
 
+To render a Mermaid plot as png you can do:
+
+``` shell
+icplot convert --source my_mermaid.mmd
+```
+
 To generate a plot or collection of plots from a yaml description you can do:
 
 ``` shell

{icplot-0.1.4 → icplot-0.1.5}/pyproject.toml

@@ -1,12 +1,12 @@
 [project]
 name = "icplot"
-version = "0.1.4"
+version = "0.1.5"
 authors = [
   { name="James Grogan, Irish Centre for High End Computing", email="james.grogan@ichec.ie" },
 ]
 description = "Utilities for generating plots and graphics for technical reports."
 readme = "README.md"
-requires-python = ">=3.8"
+requires-python = ">=3.10"
 classifiers = [
     "Development Status :: 3 - Alpha",
     "Programming Language :: Python :: 3",

{icplot-0.1.4 → icplot-0.1.5}/src/icplot/convert.py

@@ -1,8 +1,12 @@
+"""
+Module supporting conversion between various formats
+"""
+
 import logging
 import os
 from pathlib import Path
 
-from icplot import tex
+from icplot import tex, mermaid
 from icplot.tex import TexBuildSettings
 from icplot.image_utils import pdf_to_png, svg_to_pdf, svg_to_png
 
@@ -10,7 +14,9 @@ from icplot.image_utils import pdf_to_png, svg_to_pdf, svg_to_png
 logger = logging.getLogger(__name__)
 
 
-def convert(source: Path, target: Path, build_dir: Path):
+def convert(
+    source: Path, target: Path, build_dir: Path, extra_config: Path | None = None
+):
     """
     Convert the file at source outputing at target and using
     the source and target file extensions as format hints.
@@ -36,5 +42,10 @@ def convert(source: Path, target: Path, build_dir: Path):
             target = Path(os.getcwd())
         settings = TexBuildSettings(source, build_dir, target)
         tex.build(settings)
+    elif source.suffix == ".mmd":
+        if not target:
+            target = Path(os.getcwd())
+        settings = TexBuildSettings(source, build_dir, target)
+        mermaid.convert(source, target, extra_config)
 
     logger.info("Finished conversion")

{icplot-0.1.4 → icplot-0.1.5}/src/icplot/main_cli.py

@@ -20,7 +20,12 @@ def convert_cli(args):
     else:
         target = None
 
-    icplot.convert(args.source.resolve(), target, args.buid_dir.resolve())
+    if args.extra_config:
+        extra_config = Path(args.extra_config).resolve()
+    else:
+        extra_config = None
+
+    icplot.convert(args.source.resolve(), target, args.buid_dir.resolve(), extra_config)
 
 
 def plot_cli(args):
@@ -57,6 +62,12 @@ def main_cli():
         default=Path(os.getcwd()) / "_build/tikz",
         help="Path for build output",
     )
+    convert_parser.add_argument(
+        "--extra_config",
+        type=str,
+        default="",
+        help="Extra config for third party tooling, e.g. puppeteer for mermaid",
+    )
     convert_parser.set_defaults(func=convert_cli)
 
     plot_parser = subparsers.add_parser("plot")

icplot-0.1.5/src/icplot/mermaid.py

@@ -0,0 +1,39 @@
+"""
+Interface for generating mermaid plots.
+
+Mermaid must already be set up on the system, eg. via the npm ecosystem.
+"""
+
+import subprocess
+import shutil
+import os
+from pathlib import Path
+import logging
+
+
+logger = logging.getLogger(__name__)
+
+
+def has_mermaid() -> bool:
+    """
+    True if the mermaid cli is found in the environment
+    """
+
+    return bool(shutil.which("mmdc"))
+
+
+def convert(input_path: Path, work_dir: Path, browser_config: Path | None = None):
+
+    if not has_mermaid():
+        raise RuntimeError("Mermaid CLI 'mmdc' not found in path.")
+
+    os.makedirs(work_dir, exist_ok=True)
+
+    output_path = work_dir / f"{input_path.stem}.png"
+
+    logger.info("Converting: %s to %s", input_path, output_path)
+
+    cmd = f"mmdc -i {input_path} -o {output_path}"
+    if browser_config:
+        cmd += f" -p {browser_config}"
+    subprocess.run(cmd, shell=True, check=True)

{icplot-0.1.4 → icplot-0.1.5/src/icplot.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: icplot
-Version: 0.1.4
+Version: 0.1.5
 Summary: Utilities for generating plots and graphics for technical reports.
 Author-email: "James Grogan, Irish Centre for High End Computing" <james.grogan@ichec.ie>
 Project-URL: Repository, https://git.ichec.ie/performance/toolshed/icplot
@@ -11,7 +11,7 @@ Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
 Classifier: Operating System :: OS Independent
 Classifier: Topic :: System :: Distributed Computing
-Requires-Python: >=3.8
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: wand
@@ -28,6 +28,7 @@ Requires-Dist: pylint; extra == "test"
 Provides-Extra: cairo
 Requires-Dist: pycairo; extra == "cairo"
 Requires-Dist: CairoSVG; extra == "cairo"
+Dynamic: license-file
 
 # icplot
 
@@ -38,8 +39,9 @@ This is a library used at [The Irish Centre for High End Computing (ICHEC)](http
 The project has support for:
 
 * Coverting image formats between pdf, svg and png
-* Building pdf output from tex files, including tikz.
+* Building pdf and png output from tex files, including tikz.
 * Generating plots based on a serializable data model to support reproducible research
+* Generating mermaid plots
 
 To covert between image formats you can do:
 
@@ -53,6 +55,12 @@ To render a Tex tikz image as pdf and png you can do:
 icplot convert --source my_tikz.tex
 ```
 
+To render a Mermaid plot as png you can do:
+
+``` shell
+icplot convert --source my_mermaid.mmd
+```
+
 To generate a plot or collection of plots from a yaml description you can do:
 
 ``` shell

{icplot-0.1.4 → icplot-0.1.5}/src/icplot.egg-info/SOURCES.txt

@@ -9,6 +9,7 @@ src/icplot/convert.py
 src/icplot/geometry.py
 src/icplot/image_utils.py
 src/icplot/main_cli.py
+src/icplot/mermaid.py
 src/icplot/py.typed
 src/icplot/tex.py
 src/icplot.egg-info/PKG-INFO
@@ -33,4 +34,5 @@ test/test_cairo_interface.py
 test/test_gantt_chart.py
 test/test_image_utils.py
 test/test_line_plots.py
-test/test_tex_interface.py
+test/test_mermaid.py
+test/test_tex.py

icplot-0.1.5/test/test_mermaid.py

@@ -0,0 +1,24 @@
+import shutil
+from pathlib import Path
+
+from iccore.test_utils import get_test_data_dir, get_test_output_dir
+
+from icplot import mermaid
+
+
+def test_mermaid():
+
+    if not mermaid.has_mermaid():
+        return
+
+    # Pass in the browser config so we can also run headless
+    # on the CI
+    browser_config = Path(__file__).parent.parent / "infra/puppeteer-config.json"
+
+    output_dir = get_test_output_dir()
+    source = get_test_data_dir() / "test.mmd"
+
+    mermaid.convert(source, output_dir, browser_config)
+    assert Path(output_dir / "test.png").exists()
+
+    shutil.rmtree(output_dir)

icplot-0.1.4/test/test_tex_interface.py → icplot-0.1.5/test/test_tex.py

@@ -7,7 +7,7 @@ from icplot import tex
 from icplot.tex import TexBuildSettings
 
 
-def test_tex_interface():
+def test_tex():
 
     data_dir = get_test_data_dir()
     build_dir = get_test_output_dir()