figquilt 0.1.2__tar.gz → 0.1.3__tar.gz

{figquilt-0.1.2 → figquilt-0.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: figquilt
-Version: 0.1.2
+Version: 0.1.3
 Summary: figquilt is a small, language-agnostic CLI tool that composes multiple figures (PDF/SVG/PNG) into a single publication-ready figure, based on a simple layout file (YAML/JSON). The key function is creating a PDF by composing multiple PDFs and adding subfigure labels and minimal annotations.
 Author: YY Ahn
 Author-email: YY Ahn <yongyeol@gmail.com>
@@ -24,9 +24,16 @@ Description-Content-Type: text/markdown
 
 # figquilt
 
-**Figure quilter**: A CLI tool to compositing multiple figures (PDF, SVG, PNG) into a publication-ready figure layout.
+**Figure quilter**: A declarative CLI tool for compositing multiple figures (PDF, SVG, PNG) into publication-ready layouts.
 
-`figquilt` takes a simple layout file (YAML) describing panels and their positions, composed of various inputs (plots from R/Python, diagrams, photos), and stitches them into a single output file (PDF, SVG) with precise dimension control and automatic labeling.
+`figquilt` takes a simple layout file (YAML) describing panels and their structure, composed of various inputs (plots from R/Python, diagrams, photos), and stitches them into a single output file (PDF, SVG) with automatic labeling and precise dimension control.
+
+## Philosophy
+
+- **Declarative over imperative**: Describe *what* your figure should look like, not *how* to construct it. Layouts are data, not scripts.
+- **Structural composition first**: Prefer high-level layout (rows, columns, ratios) over manual coordinate placement. Let the tool handle positioning.
+- **Fine control when needed**: Override with explicit coordinates and dimensions when precision matters.
+- **Automation-friendly**: Designed to fit into reproducible workflows (Snakemake, Make, CI pipelines). No GUI, no manual steps.
 
 ## Features
 

{figquilt-0.1.2 → figquilt-0.1.3}/README.md

@@ -1,8 +1,15 @@
 # figquilt
 
-**Figure quilter**: A CLI tool to compositing multiple figures (PDF, SVG, PNG) into a publication-ready figure layout.
+**Figure quilter**: A declarative CLI tool for compositing multiple figures (PDF, SVG, PNG) into publication-ready layouts.
 
-`figquilt` takes a simple layout file (YAML) describing panels and their positions, composed of various inputs (plots from R/Python, diagrams, photos), and stitches them into a single output file (PDF, SVG) with precise dimension control and automatic labeling.
+`figquilt` takes a simple layout file (YAML) describing panels and their structure, composed of various inputs (plots from R/Python, diagrams, photos), and stitches them into a single output file (PDF, SVG) with automatic labeling and precise dimension control.
+
+## Philosophy
+
+- **Declarative over imperative**: Describe *what* your figure should look like, not *how* to construct it. Layouts are data, not scripts.
+- **Structural composition first**: Prefer high-level layout (rows, columns, ratios) over manual coordinate placement. Let the tool handle positioning.
+- **Fine control when needed**: Override with explicit coordinates and dimensions when precision matters.
+- **Automation-friendly**: Designed to fit into reproducible workflows (Snakemake, Make, CI pipelines). No GUI, no manual steps.
 
 ## Features
 

{figquilt-0.1.2 → figquilt-0.1.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "figquilt"
-version = "0.1.2"
+version = "0.1.3"
 description = "figquilt is a small, language-agnostic CLI tool that composes multiple figures (PDF/SVG/PNG) into a single publication-ready figure, based on a simple layout file (YAML/JSON). The key function is creating a PDF by composing multiple PDFs and adding subfigure labels and minimal annotations."
 readme = "README.md"
 authors = [

{figquilt-0.1.2 → figquilt-0.1.3}/src/figquilt/compose_pdf.py

@@ -1,15 +1,16 @@
 import fitz
 from pathlib import Path
 from .layout import Layout, Panel
-from .units import mm_to_pt
+from .units import mm_to_pt, to_pt
 from .errors import FigQuiltError
 
 
 class PDFComposer:
     def __init__(self, layout: Layout):
         self.layout = layout
-        self.width_pt = mm_to_pt(layout.page.width)
-        self.height_pt = mm_to_pt(layout.page.height)
+        self.units = layout.page.units
+        self.width_pt = to_pt(layout.page.width, self.units)
+        self.height_pt = to_pt(layout.page.height, self.units)
 
     def compose(self, output_path: Path):
         doc = self.build()
@@ -63,9 +64,9 @@ class PDFComposer:
         self, doc: fitz.Document, page: fitz.Page, panel: Panel, index: int
     ):
         # Calculate position and size first
-        x = mm_to_pt(panel.x)
-        y = mm_to_pt(panel.y)
-        w = mm_to_pt(panel.width)
+        x = to_pt(panel.x, self.units)
+        y = to_pt(panel.y, self.units)
+        w = to_pt(panel.width, self.units)
 
         # Determine height from aspect ratio if needed
         # We need to open the source to get aspect ratio
@@ -89,7 +90,7 @@ class PDFComposer:
             aspect = src_rect.height / src_rect.width
 
             if panel.height is not None:
-                h = mm_to_pt(panel.height)
+                h = to_pt(panel.height, self.units)
             else:
                 h = w * aspect
 

{figquilt-0.1.2 → figquilt-0.1.3}/src/figquilt/compose_svg.py

@@ -2,7 +2,7 @@ from pathlib import Path
 import base64
 from lxml import etree
 from .layout import Layout, Panel
-from .units import mm_to_pt
+from .units import mm_to_pt, to_pt
 from .errors import FigQuiltError
 import fitz
 
@@ -10,8 +10,9 @@ import fitz
 class SVGComposer:
     def __init__(self, layout: Layout):
         self.layout = layout
-        self.width_pt = mm_to_pt(layout.page.width)
-        self.height_pt = mm_to_pt(layout.page.height)
+        self.units = layout.page.units
+        self.width_pt = to_pt(layout.page.width, self.units)
+        self.height_pt = to_pt(layout.page.height, self.units)
 
     def compose(self, output_path: Path):
         # Create root SVG element
@@ -20,8 +21,10 @@ class SVGComposer:
             "xlink": "http://www.w3.org/1999/xlink",
         }
         root = etree.Element("svg", nsmap=nsmap)
-        root.set("width", f"{self.layout.page.width}mm")
-        root.set("height", f"{self.layout.page.height}mm")
+        # SVG uses "in" for inches, "pt" for points, "mm" for millimeters
+        svg_unit = "in" if self.units == "inches" else self.units
+        root.set("width", f"{self.layout.page.width}{svg_unit}")
+        root.set("height", f"{self.layout.page.height}{svg_unit}")
         root.set("viewBox", f"0 0 {self.width_pt} {self.height_pt}")
         root.set("version", "1.1")
 
@@ -42,9 +45,9 @@ class SVGComposer:
             tree.write(f, pretty_print=True, xml_declaration=True, encoding="utf-8")
 
     def _place_panel(self, root: etree.Element, panel: Panel, index: int):
-        x = mm_to_pt(panel.x)
-        y = mm_to_pt(panel.y)
-        w = mm_to_pt(panel.width)
+        x = to_pt(panel.x, self.units)
+        y = to_pt(panel.y, self.units)
+        w = to_pt(panel.width, self.units)
 
         # Determine content sizing
         # For simplicity in V0, relying on fitz for aspect ratio of all inputs (robust)
@@ -59,7 +62,7 @@ class SVGComposer:
             aspect = src_rect.height / src_rect.width
 
             if panel.height is not None:
-                h = mm_to_pt(panel.height)
+                h = to_pt(panel.height, self.units)
             else:
                 h = w * aspect
 

figquilt-0.1.3/src/figquilt/units.py

@@ -0,0 +1,25 @@
+def mm_to_pt(mm: float) -> float:
+    """Converts millimeters to points (1 inch = 25.4 mm = 72 pts)."""
+    return mm * 72 / 25.4
+
+
+def pt_to_mm(pt: float) -> float:
+    """Converts points to millimeters."""
+    return pt * 25.4 / 72
+
+
+def inches_to_pt(inches: float) -> float:
+    """Converts inches to points (1 inch = 72 pts)."""
+    return inches * 72
+
+
+def to_pt(value: float, units: str) -> float:
+    """Convert a value from the given units to points."""
+    if units == "mm":
+        return mm_to_pt(value)
+    elif units == "inches":
+        return inches_to_pt(value)
+    elif units == "pt":
+        return value
+    else:
+        raise ValueError(f"Unknown unit: {units}")

figquilt-0.1.2/src/figquilt/units.py

@@ -1,7 +0,0 @@
-def mm_to_pt(mm: float) -> float:
-    """Converts millimeters to points (1 inch = 25.4 mm = 72 pts)."""
-    return mm * 72 / 25.4
-
-def pt_to_mm(pt: float) -> float:
-    """Converts points to millimeters."""
-    return pt * 25.4 / 72