decksmith 0.1.12__py3-none-any.whl → 0.1.15__py3-none-any.whl

decksmith/main.py

@@ -1,138 +1,138 @@
-"""
-This module provides a command-line tool for building decks of cards.
-"""
-
-import shutil
-from importlib import resources
-from pathlib import Path
-import traceback
-
-import click
-from decksmith.deck_builder import DeckBuilder
-from decksmith.export import PdfExporter
-
-
-@click.group()
-def cli():
-    """A command-line tool for building decks of cards."""
-
-
-@cli.command()
-def init():
-    """Initializes a new project by creating deck.json and deck.csv."""
-    if Path("deck.json").exists() or Path("deck.csv").exists():
-        click.echo("(!) Project already initialized.")
-        return
-
-    with resources.path("decksmith.templates", "deck.json") as template_path:
-        shutil.copy(template_path, "deck.json")
-    with resources.path("decksmith.templates", "deck.csv") as template_path:
-        shutil.copy(template_path, "deck.csv")
-
-    click.echo("(✔) Initialized new project from templates.")
-
-
-@cli.command(context_settings={"show_default": True})
-@click.option("--output", default="output", help="The output directory for the deck.")
-@click.option(
-    "--spec", default="deck.json", help="The path to the deck specification file."
-)
-@click.option("--data", default="deck.csv", help="The path to the data file.")
-@click.pass_context
-def build(ctx, output, spec, data):
-    """Builds the deck of cards."""
-    output_path = Path(output)
-    output_path.mkdir(exist_ok=True)
-
-    click.echo(f"(i) Building deck in {output_path}...")
-
-    try:
-        spec_path = Path(spec)
-        if not spec_path.exists():
-            raise FileNotFoundError(f"Spec file not found: {spec_path}")
-
-        csv_path = Path(data)
-        if not csv_path.exists():
-            source = ctx.get_parameter_source("data")
-            if source.name == "DEFAULT":
-                click.echo(
-                    f"(i) Building a single card deck because '{csv_path}' was not found"
-                )
-                csv_path = None
-            else:
-                raise FileNotFoundError(f"Data file not found: {csv_path}")
-
-        builder = DeckBuilder(spec_path, csv_path)
-        builder.build_deck(output_path)
-    except FileNotFoundError as exc:
-        click.echo(f"(x) {exc}")
-        ctx.exit(1)
-    # pylint: disable=W0718
-    except Exception as exc:
-        with open("log.txt", "a", encoding="utf-8") as log:
-            log.write(traceback.format_exc())
-        # print(f"{traceback.format_exc()}", end="\n")
-        print(f"(x) Error building deck '{data}' from spec '{spec}':")
-        print(" " * 4 + f"{exc}")
-        ctx.exit(1)
-
-    click.echo("(✔) Deck built successfully.")
-
-
-@cli.command(context_settings={"show_default": True})
-@click.argument("image_folder")
-@click.option(
-    "--output", default="output.pdf", help="The path for the output PDF file."
-)
-@click.option(
-    "--page-size", default="A4", help="The page size for the PDF (e.g., A4, Letter)."
-)
-@click.option(
-    "--width", type=float, default=63.5, help="The width for each image in millimeters."
-)
-@click.option(
-    "--height",
-    type=float,
-    default=88.9,
-    help="The height for each image in millimeters.",
-)
-@click.option(
-    "--gap", type=float, default=0, help="The gap between images in millimeters."
-)
-@click.option(
-    "--margins",
-    type=float,
-    nargs=2,
-    default=[2, 2],
-    help="The horizontal and vertical page margins in millimeters.",
-)
-def export(image_folder, output, page_size, width, height, gap, margins):
-    """Exports images from a folder to a PDF file."""
-    try:
-        image_folder_path = Path(image_folder)
-        if not image_folder_path.exists():
-            raise FileNotFoundError(f"Image folder not found: {image_folder_path}")
-
-        exporter = PdfExporter(
-            image_folder=image_folder_path,
-            output_path=Path(output),
-            page_size_str=page_size,
-            image_width=width,
-            image_height=height,
-            gap=gap,
-            margins=margins,
-        )
-        exporter.export()
-        click.echo(f"(✔) Successfully exported PDF to {output}")
-    except FileNotFoundError as exc:
-        click.echo(f"(x) {exc}")
-    # pylint: disable=W0718
-    except Exception as exc:
-        with open("log.txt", "a", encoding="utf-8") as log:
-            log.write(traceback.format_exc())
-        print(f"(x) Error exporting images to '{output}':")
-        print(" " * 4 + f"{exc}")
-
-
-if __name__ == "__main__":
-    cli()
+"""
+This module provides a command-line tool for building decks of cards.
+"""
+
+import shutil
+from importlib import resources
+from pathlib import Path
+import traceback
+
+import click
+from decksmith.deck_builder import DeckBuilder
+from decksmith.export import PdfExporter
+
+
+@click.group()
+def cli():
+    """A command-line tool for building decks of cards."""
+
+
+@cli.command()
+def init():
+    """Initializes a new project by creating deck.json and deck.csv."""
+    if Path("deck.json").exists() or Path("deck.csv").exists():
+        click.echo("(!) Project already initialized.")
+        return
+
+    with resources.path("decksmith.templates", "deck.json") as template_path:
+        shutil.copy(template_path, "deck.json")
+    with resources.path("decksmith.templates", "deck.csv") as template_path:
+        shutil.copy(template_path, "deck.csv")
+
+    click.echo("(✔) Initialized new project from templates.")
+
+
+@cli.command(context_settings={"show_default": True})
+@click.option("--output", default="output", help="The output directory for the deck.")
+@click.option(
+    "--spec", default="deck.json", help="The path to the deck specification file."
+)
+@click.option("--data", default="deck.csv", help="The path to the data file.")
+@click.pass_context
+def build(ctx, output, spec, data):
+    """Builds the deck of cards."""
+    output_path = Path(output)
+    output_path.mkdir(exist_ok=True)
+
+    click.echo(f"(i) Building deck in {output_path}...")
+
+    try:
+        spec_path = Path(spec)
+        if not spec_path.exists():
+            raise FileNotFoundError(f"Spec file not found: {spec_path}")
+
+        csv_path = Path(data)
+        if not csv_path.exists():
+            source = ctx.get_parameter_source("data")
+            if source.name == "DEFAULT":
+                click.echo(
+                    f"(i) Building a single card deck because '{csv_path}' was not found"
+                )
+                csv_path = None
+            else:
+                raise FileNotFoundError(f"Data file not found: {csv_path}")
+
+        builder = DeckBuilder(spec_path, csv_path)
+        builder.build_deck(output_path)
+    except FileNotFoundError as exc:
+        click.echo(f"(x) {exc}")
+        ctx.exit(1)
+    # pylint: disable=W0718
+    except Exception as exc:
+        with open("log.txt", "a", encoding="utf-8") as log:
+            log.write(traceback.format_exc())
+        # print(f"{traceback.format_exc()}", end="\n")
+        print(f"(x) Error building deck '{data}' from spec '{spec}':")
+        print(" " * 4 + f"{exc}")
+        ctx.exit(1)
+
+    click.echo("(✔) Deck built successfully.")
+
+
+@cli.command(context_settings={"show_default": True})
+@click.argument("image_folder")
+@click.option(
+    "--output", default="output.pdf", help="The path for the output PDF file."
+)
+@click.option(
+    "--page-size", default="A4", help="The page size for the PDF (e.g., A4, Letter)."
+)
+@click.option(
+    "--width", type=float, default=63.5, help="The width for each image in millimeters."
+)
+@click.option(
+    "--height",
+    type=float,
+    default=88.9,
+    help="The height for each image in millimeters.",
+)
+@click.option(
+    "--gap", type=float, default=0, help="The gap between images in millimeters."
+)
+@click.option(
+    "--margins",
+    type=float,
+    nargs=2,
+    default=[2, 2],
+    help="The horizontal and vertical page margins in millimeters.",
+)
+def export(image_folder, output, page_size, width, height, gap, margins):
+    """Exports images from a folder to a PDF file."""
+    try:
+        image_folder_path = Path(image_folder)
+        if not image_folder_path.exists():
+            raise FileNotFoundError(f"Image folder not found: {image_folder_path}")
+
+        exporter = PdfExporter(
+            image_folder=image_folder_path,
+            output_path=Path(output),
+            page_size_str=page_size,
+            image_width=width,
+            image_height=height,
+            gap=gap,
+            margins=margins,
+        )
+        exporter.export()
+        click.echo(f"(✔) Successfully exported PDF to {output}")
+    except FileNotFoundError as exc:
+        click.echo(f"(x) {exc}")
+    # pylint: disable=W0718
+    except Exception as exc:
+        with open("log.txt", "a", encoding="utf-8") as log:
+            log.write(traceback.format_exc())
+        print(f"(x) Error exporting images to '{output}':")
+        print(" " * 4 + f"{exc}")
+
+
+if __name__ == "__main__":
+    cli()

decksmith/templates/deck.csv

@@ -1,5 +1,5 @@
-title;description
-Welcome to DeckSmith!;To get started, edit "deck.csv" to add new cards, or "deck.json" to change their structure.
-Building the deck;Run "decksmith build" when you are ready to save the cards as images.
-Exporting to PDF;You can create a printable PDF with "decksmith export --width 63.5 --height 88.9 output" after building.
-Check out the guide;Visit "github.com/julynx/decksmith" to learn all the things you can do using DeckSmith. Enjoy!
+title;description
+Welcome to DeckSmith!;To get started, edit "deck.csv" to add new cards, or "deck.json" to change their structure.
+Building the deck;Run "decksmith build" when you are ready to save the cards as images.
+Exporting to PDF;You can create a printable PDF with "decksmith export --width 63.5 --height 88.9 output" after building.
+Check out the guide;Visit "github.com/julynx/decksmith" to learn all the things you can do using DeckSmith. Enjoy!

decksmith/templates/deck.json

@@ -1,31 +1,31 @@
-{
-  "width": 250,
-  "height": 350,
-  "background_color": [200, 200, 200],
-  "elements": [
-    {
-      "id": "title",
-      "type": "text",
-      "position": [125, 25],
-      "anchor": "top-center",
-      "text": "%title%",
-      "color": [0, 0, 0],
-      "font_path": "arial.ttf",
-      "font_size": 20,
-      "align": "center"
-    },
-    {
-      "id": "description",
-      "type": "text",
-      "position": [0, 25],
-      "relative_to": ["title", "bottom-center"],
-      "anchor": "top-center",
-      "text": "%description%",
-      "color": [0, 0, 0],
-      "font_path": "arial.ttf",
-      "font_size": 16,
-      "width": 200,
-      "align": "center"
-    }
-  ]
-}
+{
+  "width": 250,
+  "height": 350,
+  "background_color": [200, 200, 200],
+  "elements": [
+    {
+      "id": "title",
+      "type": "text",
+      "position": [125, 25],
+      "anchor": "top-center",
+      "text": "%title%",
+      "color": [0, 0, 0],
+      "font_path": "arial.ttf",
+      "font_size": 20,
+      "align": "center"
+    },
+    {
+      "id": "description",
+      "type": "text",
+      "position": [0, 25],
+      "relative_to": ["title", "bottom-center"],
+      "anchor": "top-center",
+      "text": "%description%",
+      "color": [0, 0, 0],
+      "font_path": "arial.ttf",
+      "font_size": 16,
+      "width": 200,
+      "align": "center"
+    }
+  ]
+}

decksmith/utils.py

@@ -1,69 +1,69 @@
-"""
-This module provides utility functions for text wrapping and positioning.
-"""
-
-from typing import Tuple
-
-from PIL import ImageFont
-
-
-def get_wrapped_text(text: str, font: ImageFont.ImageFont, line_length: int) -> str:
-    """
-    Wraps text to fit within a specified line length using the given font,
-    preserving existing newlines.
-    Args:
-        text (str): The text to wrap.
-        font (ImageFont.ImageFont): The font to use for measuring text length.
-        line_length (int): The maximum length of each line in pixels.
-
-    Returns:
-        str: The wrapped text with newlines inserted where necessary.
-    """
-    wrapped_lines = []
-    for line in text.split("\n"):
-        lines = [""]
-        for word in line.split():
-            line_to_check = f"{lines[-1]} {word}".strip()
-            if font.getlength(line_to_check) <= line_length:
-                lines[-1] = line_to_check
-            else:
-                lines.append(word)
-        wrapped_lines.extend(lines)
-    return "\n".join(wrapped_lines)
-
-
-def apply_anchor(size: Tuple[int, ...], anchor: str) -> Tuple[int, int]:
-    """
-    Applies an anchor to a size tuple to determine the position of an element.
-    Args:
-        size (Tuple[int, ...]): A tuple representing the size (width, height)
-            or a bounding box (x1, y1, x2, y2).
-        anchor (str): The anchor position, e.g., "center", "top-left".
-    Returns:
-        Tuple[int, int]: A tuple representing the position (x, y) based on the anchor.
-    """
-    if len(size) == 2:
-        w, h = size
-        x, y = 0, 0
-    elif len(size) == 4:
-        x, y, x2, y2 = size
-        w, h = x2 - x, y2 - y
-    else:
-        raise ValueError("Size must be a tuple of 2 or 4 integers.")
-
-    anchor_points = {
-        "top-left": (x, y),
-        "top-center": (x + w // 2, y),
-        "top-right": (x + w, y),
-        "middle-left": (x, y + h // 2),
-        "center": (x + w // 2, y + h // 2),
-        "middle-right": (x + w, y + h // 2),
-        "bottom-left": (x, y + h),
-        "bottom-center": (x + w // 2, y + h),
-        "bottom-right": (x + w, y + h),
-    }
-
-    if anchor not in anchor_points:
-        raise ValueError(f"Unknown anchor: {anchor}")
-
-    return anchor_points[anchor]
+"""
+This module provides utility functions for text wrapping and positioning.
+"""
+
+from typing import Tuple
+
+from PIL import ImageFont
+
+
+def get_wrapped_text(text: str, font: ImageFont.ImageFont, line_length: int) -> str:
+    """
+    Wraps text to fit within a specified line length using the given font,
+    preserving existing newlines.
+    Args:
+        text (str): The text to wrap.
+        font (ImageFont.ImageFont): The font to use for measuring text length.
+        line_length (int): The maximum length of each line in pixels.
+
+    Returns:
+        str: The wrapped text with newlines inserted where necessary.
+    """
+    wrapped_lines = []
+    for line in text.split("\n"):
+        lines = [""]
+        for word in line.split():
+            line_to_check = f"{lines[-1]} {word}".strip()
+            if font.getlength(line_to_check) <= line_length:
+                lines[-1] = line_to_check
+            else:
+                lines.append(word)
+        wrapped_lines.extend(lines)
+    return "\n".join(wrapped_lines)
+
+
+def apply_anchor(size: Tuple[int, ...], anchor: str) -> Tuple[int, int]:
+    """
+    Applies an anchor to a size tuple to determine the position of an element.
+    Args:
+        size (Tuple[int, ...]): A tuple representing the size (width, height)
+            or a bounding box (x1, y1, x2, y2).
+        anchor (str): The anchor position, e.g., "center", "top-left".
+    Returns:
+        Tuple[int, int]: A tuple representing the position (x, y) based on the anchor.
+    """
+    if len(size) == 2:
+        w, h = size
+        x, y = 0, 0
+    elif len(size) == 4:
+        x, y, x2, y2 = size
+        w, h = x2 - x, y2 - y
+    else:
+        raise ValueError("Size must be a tuple of 2 or 4 integers.")
+
+    anchor_points = {
+        "top-left": (x, y),
+        "top-center": (x + w // 2, y),
+        "top-right": (x + w, y),
+        "middle-left": (x, y + h // 2),
+        "center": (x + w // 2, y + h // 2),
+        "middle-right": (x + w, y + h // 2),
+        "bottom-left": (x, y + h),
+        "bottom-center": (x + w // 2, y + h),
+        "bottom-right": (x + w, y + h),
+    }
+
+    if anchor not in anchor_points:
+        raise ValueError(f"Unknown anchor: {anchor}")
+
+    return anchor_points[anchor]