icplot 0.0.2__py3-none-any.whl → 0.0.4__py3-none-any.whl

icplot/image_utils.py

@@ -4,13 +4,33 @@ from pathlib import Path
 from wand.image import Image
 from wand.color import Color
 
+import cairosvg
+
 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:
+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=png_filename)
+        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/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/project_elements.py

@@ -1,47 +1,4 @@
-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())

icplot/tex_interface.py

@@ -11,19 +11,16 @@ logger = logging.getLogger(__name__)
 
 
 class TexInterface:
+    def __init__(self, build_dir: Path | None, output_dir: Path | None):
 
-    def __init__(self, build_dir: Path, output_dir: Path):
-
-        if not build_dir.is_absolute():
-            build_dir = Path(os.getcwd()) / build_dir
-
+        if build_dir:
+            self.build_dir: Path = build_dir.resolve()
+        else:
+            self.build_dir = Path()
         if not output_dir:
-            output_dir = build_dir
-
-        if not output_dir.is_absolute():
-            output_dir = Path(os.getcwd()) / output_dir
-        self.build_dir = build_dir
-        self.output_dir = output_dir
+            self.output_dir: Path = self.build_dir
+        else:
+            self.output_dir = output_dir.resolve()
         self.build_engine = "pdflatex"
 
     def build_pdf(self, source_path: Path, build_dir: Path):

{icplot-0.0.2.dist-info → icplot-0.0.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: icplot
-Version: 0.0.2
+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,8 +15,9 @@ Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: wand
-Provides-Extra: cairo
-Requires-Dist: pycairo ; extra == 'cairo'
+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'
@@ -28,6 +29,35 @@ Requires-Dist: mypy ; extra == 'test'
 
 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.dist-info/RECORD

@@ -0,0 +1,14 @@
+icplot/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+icplot/cairo_interface.py,sha256=55JqNKmZ-KeN0nEHEmCxZcioP7aTJtRp-gdW-Sqi4fM,2105
+icplot/gantt.py,sha256=pbk2fkpM6eep_LAgGUnu2mOn646IAokuqc44qKD8FSA,1909
+icplot/geometry.py,sha256=C8y3u2oBnGNL7o1gqb-JotH7zOwH9iRSUB811OycYMc,1033
+icplot/image_utils.py,sha256=wwMQHuu-wkP_pkssCaTGpF7-OY450APruxxI1wZdkk4,1014
+icplot/main_cli.py,sha256=Xc2bs-MpyTeJWhzEhYHxBZlVQpf51XFfzetDQ2MKyWM,1766
+icplot/project_elements.py,sha256=xXCNc4vTNCo9PKCsxe28GBMG4WDNYK_wGnKjliVjyY4,66
+icplot/tex_interface.py,sha256=QtyT5KLi8LnnuefpTF5QOi43Yl-6rnO-zWQW4qCPGA0,2605
+icplot-0.0.4.dist-info/LICENSE,sha256=JedcPd23DfREo3CH5_Sc8He0jmmbOWIm1_sQaisXZ9E,34592
+icplot-0.0.4.dist-info/METADATA,sha256=AkqhhPYegUIuPvWuoBEJG5S5ruXgIStyV4jS2h4rT-Y,2156
+icplot-0.0.4.dist-info/WHEEL,sha256=Wyh-_nZ0DJYolHNn1_hMa4lM7uDedD_RGVwbmTjyItk,91
+icplot-0.0.4.dist-info/entry_points.txt,sha256=6CdEGO5Z4NTQoOeRITTKGtzT3xNX47CGHZuWNWxZuZs,52
+icplot-0.0.4.dist-info/top_level.txt,sha256=T_ecIGmXlOO4_xP86S-OFL8nnoxmDQFXjcDoIwpiHQk,7
+icplot-0.0.4.dist-info/RECORD,,

{icplot-0.0.2.dist-info → icplot-0.0.4.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (70.3.0)
+Generator: setuptools (71.1.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

icplot-0.0.4.dist-info/entry_points.txt

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

icplot-0.0.2.dist-info/RECORD

@@ -1,12 +0,0 @@
-icplot/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-icplot/cairo_interface.py,sha256=55JqNKmZ-KeN0nEHEmCxZcioP7aTJtRp-gdW-Sqi4fM,2105
-icplot/gantt.py,sha256=pbk2fkpM6eep_LAgGUnu2mOn646IAokuqc44qKD8FSA,1909
-icplot/geometry.py,sha256=C8y3u2oBnGNL7o1gqb-JotH7zOwH9iRSUB811OycYMc,1033
-icplot/image_utils.py,sha256=roQOR02dEh2NTt3G_EYVGSNL-uYTWFwMBvqz1yVf3-w,451
-icplot/project_elements.py,sha256=bIMbiAucpIMZ_xeipJr-V6NwXLPc8DhvV7OdEL7lHXA,993
-icplot/tex_interface.py,sha256=fSI15lfee0D-H_r0QItpS3tR1-F0WdRA-MaICBu0cI0,2649
-icplot-0.0.2.dist-info/LICENSE,sha256=JedcPd23DfREo3CH5_Sc8He0jmmbOWIm1_sQaisXZ9E,34592
-icplot-0.0.2.dist-info/METADATA,sha256=vYO7-jtuO-1y4_SwiJcAwsUxhQdiqoVSvuQIOMD71nM,1433
-icplot-0.0.2.dist-info/WHEEL,sha256=Z4pYXqR_rTB7OWNDYFOm1qRk0RX6GFP2o8LgvP453Hk,91
-icplot-0.0.2.dist-info/top_level.txt,sha256=T_ecIGmXlOO4_xP86S-OFL8nnoxmDQFXjcDoIwpiHQk,7
-icplot-0.0.2.dist-info/RECORD,,