icplot 0.0.3__tar.gz → 0.0.4__tar.gz

{icplot-0.0.3/src/icplot.egg-info → icplot-0.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: icplot
-Version: 0.0.3
+Version: 0.0.4
 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
@@ -15,19 +15,49 @@ Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: wand
+Requires-Dist: pycairo
+Requires-Dist: CairoSVG
+Requires-Dist: iccore==0.0.7
 Provides-Extra: test
 Requires-Dist: pytest; extra == "test"
 Requires-Dist: pytest-cov; extra == "test"
 Requires-Dist: pytest-sugar; extra == "test"
 Requires-Dist: black; extra == "test"
 Requires-Dist: mypy; extra == "test"
-Provides-Extra: cairo
-Requires-Dist: pycairo; extra == "cairo"
 
 # icplot
 
 This project is a utility library used at ICHEC for generating plots and graphics for use in technical documents.
 
+# Installation #
+
+The package is available on PyPI. For a minimal installation you can do:
+
+``` shell
+pip install icplot
+```
+
+For full functionality, particularly for conversion of image formats `imagemagick` and `cairo` are required. On Mac you can install them with:
+
+``` shell
+brew install imagemagick cairo
+```
+
+# Features #
+
+The project has support for:
+
+* Coverting image formats between pdf, svg and png
+* Building pdf output from tex files, including tikz.
+
+There is a command line interface included, mainly for testing, which may be heplful in getting to know available features.
+
+To covert between image formats you can do:
+
+``` shell
+icplot convert --source my_image.svg --target my_image.png
+```
+
 # Copyright #
 
 Copyright 2024 Irish Centre for High End Computing

icplot-0.0.4/README.md

@@ -0,0 +1,39 @@
+# icplot
+
+This project is a utility library used at ICHEC for generating plots and graphics for use in technical documents.
+
+# Installation #
+
+The package is available on PyPI. For a minimal installation you can do:
+
+``` shell
+pip install icplot
+```
+
+For full functionality, particularly for conversion of image formats `imagemagick` and `cairo` are required. On Mac you can install them with:
+
+``` shell
+brew install imagemagick cairo
+```
+
+# Features #
+
+The project has support for:
+
+* Coverting image formats between pdf, svg and png
+* Building pdf output from tex files, including tikz.
+
+There is a command line interface included, mainly for testing, which may be heplful in getting to know available features.
+
+To covert between image formats you can do:
+
+``` shell
+icplot convert --source my_image.svg --target my_image.png
+```
+
+# Copyright #
+
+Copyright 2024 Irish Centre for High End Computing
+
+The software in this repository can be used under the conditions of the GPLv3+ license, which is available for reading in the accompanying LICENSE file.
+

{icplot-0.0.3 → icplot-0.0.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "icplot"
-version = "0.0.3"
+version = "0.0.4"
 authors = [
   { name="James Grogan, Irish Centre for High End Computing", email="james.grogan@ichec.ie" },
 ]
@@ -16,7 +16,10 @@ classifiers = [
 ]
 keywords = ["Publishing", "Technical Reports", "Graphics"]
 
-dependencies = ["wand"]
+dependencies = ["wand",
+	       "pycairo",
+	       "CairoSVG",
+	       "iccore==0.0.7"]
 
 [project.urls]
 Repository = "https://git.ichec.ie/performance/toolshed/icplot"
@@ -31,12 +34,13 @@ test = [
     "mypy"
 ]
 
-cairo = ["pycairo"]
-
 [build-system]
 requires = ["setuptools>=61.0", "wheel"]
 build-backend = "setuptools.build_meta"
 
+[project.scripts]
+icplot = "icplot.main_cli:main_cli"
+
 [tool.setuptools.package-data]
 "icplot" = ["py.typed"]
 
@@ -47,6 +51,7 @@ where = ["src"]
 testpaths = ["test",]
 log_cli = 1
 log_cli_level = "debug"
+addopts = "--cov=icplot --cov-report term --cov-report xml:coverage.xml --cov-report html"
 
 [tool.mypy]
 ignore_missing_imports = true
@@ -64,7 +69,7 @@ description = run unit tests
 deps =
     pytest>=7
     pytest-sugar
-    pycairo
+    pytest-cov
 commands =
     pytest {posargs:test}
 

icplot-0.0.4/src/icplot/image_utils.py

@@ -0,0 +1,36 @@
+import logging
+from pathlib import Path
+
+from wand.image import Image
+from wand.color import Color
+
+import cairosvg
+
+logger = logging.getLogger(__name__)
+
+
+def _get_out_filename(source: Path, target: Path | None, extension: str) -> Path:
+    if target:
+        return target
+    else:
+        return source.parent / f"{source.stem}.{extension}"
+
+
+def pdf_to_png(source: Path, target: Path | None = None):
+
+    outfile = _get_out_filename(source, target, "png")
+    with Image(filename=source, resolution=300) as img:
+        img.format = "png"
+        img.background_color = Color("white")
+        img.alpha_channel = "remove"
+        img.save(filename=outfile)
+
+
+def svg_to_png(source: Path, target: Path | None = None):
+    outfile = _get_out_filename(source, target, "png")
+    cairosvg.svg2png(url=str(source), write_to=str(outfile))
+
+
+def svg_to_pdf(source: Path, target: Path | None = None):
+    outfile = _get_out_filename(source, target, "pdf")
+    cairosvg.svg2pdf(url=str(source), write_to=str(outfile))

icplot-0.0.4/src/icplot/main_cli.py

@@ -0,0 +1,71 @@
+#!/usr/bin/env python3
+import argparse
+import logging
+from pathlib import Path
+
+from iccore import logging_utils
+from iccore import runtime
+
+from icplot.image_utils import pdf_to_png, svg_to_png, svg_to_pdf
+
+logger = logging.getLogger(__name__)
+
+
+def launch_common(args):
+    runtime.ctx.set_is_dry_run(args.dry_run)
+    logging_utils.setup_default_logger()
+
+
+def convert(args):
+    launch_common(args)
+
+    logger.info("Attempting coversion between %s %s", args.source, args.target)
+
+    if args.target:
+        target = Path(args.target).resolve()
+    else:
+        target = None
+
+    if args.source.suffix == ".pdf":
+        pdf_to_png(args.source.resolve(), target)
+    elif args.source.suffix == ".svg":
+        if target:
+            if target.suffix == ".png":
+                svg_to_png(args.source.resolve(), target)
+            elif target.suffix == ".pdf":
+                svg_to_pdf(args.source.resolve(), target)
+        else:
+            svg_to_png(args.source)
+    logger.info("Finished conversion")
+
+
+def main_cli():
+    parser = argparse.ArgumentParser()
+    parser.add_argument(
+        "--dry_run",
+        type=int,
+        default=0,
+        help="Dry run script - 0 can modify, 1 can read, 2 no modify - no read",
+    )
+    subparsers = parser.add_subparsers(required=True)
+
+    convert_parser = subparsers.add_parser("convert")
+    convert_parser.add_argument(
+        "--source",
+        type=Path,
+        help="Path to file to be converted from",
+    )
+    convert_parser.add_argument(
+        "--target",
+        type=str,
+        default="",
+        help="Path to file to be converted to",
+    )
+    convert_parser.set_defaults(func=convert)
+
+    args = parser.parse_args()
+    args.func(args)
+
+
+if __name__ == "__main__":
+    main_cli()

icplot-0.0.4/src/icplot/project_elements.py

@@ -0,0 +1,4 @@
+class GitlabUser:
+
+    def __init__(self):
+        self.name = ""

{icplot-0.0.3 → icplot-0.0.4/src/icplot.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: icplot
-Version: 0.0.3
+Version: 0.0.4
 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
@@ -15,19 +15,49 @@ Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: wand
+Requires-Dist: pycairo
+Requires-Dist: CairoSVG
+Requires-Dist: iccore==0.0.7
 Provides-Extra: test
 Requires-Dist: pytest; extra == "test"
 Requires-Dist: pytest-cov; extra == "test"
 Requires-Dist: pytest-sugar; extra == "test"
 Requires-Dist: black; extra == "test"
 Requires-Dist: mypy; extra == "test"
-Provides-Extra: cairo
-Requires-Dist: pycairo; extra == "cairo"
 
 # icplot
 
 This project is a utility library used at ICHEC for generating plots and graphics for use in technical documents.
 
+# Installation #
+
+The package is available on PyPI. For a minimal installation you can do:
+
+``` shell
+pip install icplot
+```
+
+For full functionality, particularly for conversion of image formats `imagemagick` and `cairo` are required. On Mac you can install them with:
+
+``` shell
+brew install imagemagick cairo
+```
+
+# Features #
+
+The project has support for:
+
+* Coverting image formats between pdf, svg and png
+* Building pdf output from tex files, including tikz.
+
+There is a command line interface included, mainly for testing, which may be heplful in getting to know available features.
+
+To covert between image formats you can do:
+
+``` shell
+icplot convert --source my_image.svg --target my_image.png
+```
+
 # Copyright #
 
 Copyright 2024 Irish Centre for High End Computing

{icplot-0.0.3 → icplot-0.0.4}/src/icplot.egg-info/SOURCES.txt

@@ -7,13 +7,16 @@ src/icplot/cairo_interface.py
 src/icplot/gantt.py
 src/icplot/geometry.py
 src/icplot/image_utils.py
+src/icplot/main_cli.py
 src/icplot/project_elements.py
 src/icplot/tex_interface.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
 test/test_cairo_interface.py
 test/test_gantt_chart.py
+test/test_image_utils.py
 test/test_tex_interface.py

icplot-0.0.4/src/icplot.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+icplot = icplot.main_cli:main_cli

{icplot-0.0.3 → icplot-0.0.4}/src/icplot.egg-info/requires.txt

@@ -1,7 +1,7 @@
 wand
-
-[cairo]
 pycairo
+CairoSVG
+iccore==0.0.7
 
 [test]
 pytest

{icplot-0.0.3 → icplot-0.0.4}/test/test_gantt_chart.py

@@ -1,8 +1,10 @@
 import os
 import datetime
 from pathlib import Path
+
+from iccore.project import Milestone
+
 from icplot.gantt import GanttChart
-from icplot.project_elements import Milestone
 
 
 def test_gantt_chart():

icplot-0.0.4/test/test_image_utils.py

@@ -0,0 +1,21 @@
+import os
+from pathlib import Path
+
+from icplot.image_utils import svg_to_png, svg_to_pdf
+
+def get_test_data_dir():
+    return Path(__file__).parent / "data"
+    
+def test_convert_svg():
+
+    source = get_test_data_dir() / "test.svg"
+
+    png_out = Path(os.getcwd()) / "out.png"
+    svg_to_png(source, png_out)
+    png_out.unlink()
+
+    pdf_out = Path(os.getcwd()) / "out.pdf"
+    svg_to_pdf(source, pdf_out)
+    pdf_out.unlink()
+
+    

icplot-0.0.3/README.md

@@ -1,10 +0,0 @@
-# icplot
-
-This project is a utility library used at ICHEC for generating plots and graphics for use in technical documents.
-
-# Copyright #
-
-Copyright 2024 Irish Centre for High End Computing
-
-The software in this repository can be used under the conditions of the GPLv3+ license, which is available for reading in the accompanying LICENSE file.
-

icplot-0.0.3/src/icplot/image_utils.py

@@ -1,16 +0,0 @@
-import logging
-from pathlib import Path
-
-from wand.image import Image
-from wand.color import Color
-
-logger = logging.getLogger(__name__)
-
-
-def pdf_to_png(source_path: Path):
-    png_filename = source_path.parent / f"{source_path.stem}.png"
-    with Image(filename=source_path, resolution=300) as img:
-        img.format = "png"
-        img.background_color = Color("white")
-        img.alpha_channel = "remove"
-        img.save(filename=png_filename)

icplot-0.0.3/src/icplot/project_elements.py

@@ -1,47 +0,0 @@
-import json
-
-
-class GitlabUser:
-
-    def __init__(self):
-        self.name = ""
-
-
-class Issue:
-
-    def __init__(self):
-        self.title = ""
-        self.description = ""
-        self.start_date = ""
-        self.due_date = ""
-        self.assignee = None
-
-
-class Milestone:
-
-    def __init__(self, json_input=None):
-        self.title = ""
-        self.description = ""
-        self.start_date = None
-        self.due_date = None
-        self.issues = []
-
-        if json_input:
-            self.load(json_input)
-
-    def load(self, json):
-        self.title = json["title"]
-        self.description = json["description"]
-        self.start_date = json["start_date"]
-        self.due_date = json["due_date"]
-
-    def serialize(self):
-        return {
-            "title": self.title,
-            "description": self.description,
-            "start_date": self.start_date,
-            "due_date": self.due_date,
-        }
-
-    def __str__(self):
-        return json.dumps(self.serialize())