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

decksmith/validate.py

@@ -1,132 +1,132 @@
-"""
-This module provides functions for validating and transforming card specifications.
-"""
-
-from typing import Dict, Any
-
-import pandas as pd
-from jval import validate
-
-ELEMENT_SPEC: Dict[str, Any] = {
-    "?*id": "<?str>",
-    "*type": "<?str>",
-    "?*position": ["<?float>"],
-    "?*relative_to": ["<?str>"],
-    "?*anchor": "<?str>",
-}
-
-SPECS_FOR_TYPE: Dict[str, Dict[str, Any]] = {
-    "text": {
-        "*text": "<?str>",
-        "?*color": ["<?int>"],
-        "?*font_path": "<?str>",
-        "?*font_size": "<?int>",
-        "?*font_variant": "<?str>",
-        "?*line_spacing": "<?int>",
-        "?*width": "<?int>",
-        "?*align": "<?str>",
-        "?*stroke_width": "<?int>",
-        "?*stroke_color": ["<?int>"],
-    },
-    "image": {
-        "*path": "<?str>",
-        "?*filters": {
-            "?*crop_top": "<?int>",
-            "?*crop_bottom": "<?int>",
-            "?*crop_left": "<?int>",
-            "?*crop_right": "<?int>",
-            "?*crop_box": ["<?int>"],
-            "?*rotate": "<?int>",
-            "?*flip": "<?str>",
-            "?*resize": ["<?int>"],
-        },
-    },
-    "circle": {
-        "*radius": "<?int>",
-        "?*color": ["<?int>"],
-        "?*outline_color": ["<?int>"],
-        "?*outline_width": "<?int>",
-    },
-    "ellipse": {
-        "*size": ["<?int>"],
-        "?*color": ["<?int>"],
-        "?*outline_color": ["<?int>"],
-        "?*outline_width": "<?int>",
-    },
-    "polygon": {
-        "*points": [["<?int>"]],
-        "?*color": ["<?int>"],
-        "?*outline_color": ["<?int>"],
-        "?*outline_width": "<?int>",
-    },
-    "regular-polygon": {
-        "*radius": "<?int>",
-        "*sides": "<?int>",
-        "?*rotation": "<?int>",
-        "?*color": ["<?int>"],
-        "?*outline_color": ["<?int>"],
-        "?*outline_width": "<?int>",
-    },
-    "rectangle": {
-        "*size": ["<?int>"],
-        "?*corners": ["<?bool>"],
-        "?*corner_radius": "<?int>",
-        "?*color": ["<?int>"],
-        "?*outline_color": ["<?int>"],
-        "?*outline_width": "<?int>",
-    },
-}
-
-CARD_SPEC: Dict[str, Any] = {
-    "?*id": "<?str>",
-    "*width": "<?int>",
-    "*height": "<?int>",
-    "?*background_color": ["<?int>"],
-    "*elements": [],
-}
-
-
-def validate_element(element: Dict[str, Any], element_type: str):
-    """
-    Validates an element of a card against a spec, raising an exception
-    if it does not meet the spec.
-    Args:
-        element (dict): The card element.
-        element_type (str): The type of the element
-    """
-    spec = ELEMENT_SPEC | SPECS_FOR_TYPE[element_type]
-    validate(element, spec)
-
-
-def validate_card(card: Dict[str, Any]):
-    """
-    Validates a card against a spec, raising an exception
-    if it does not meet the spec.
-    Args:
-        card (Dict[str, Any]): The card.
-    """
-    # print(f"DEBUG:\n{card=}")
-    validate(card, CARD_SPEC)
-    for element in card["elements"]:
-        # print(f"DEBUG: {element['type']}")
-        validate_element(element, element["type"])
-
-
-def transform_card(card: Dict[str, Any]) -> Dict[str, Any]:
-    """
-    Perform certain automatic type casts on the card and its
-    elements. For example, cast the "text" property of elements
-    of type "text" to str, to support painting numbers as text.
-    Args:
-        card (Dict[str, Any]): The card.
-    Return:
-        Dict[str, Any]: The transformed card with all automatic casts applied.
-    """
-    for element in card.get("elements", []):
-        if element.get("type") == "text" and "text" in element:
-            if pd.isna(element["text"]):
-                element["text"] = None
-            else:
-                element["text"] = str(element["text"])
-
-    return card
+"""
+This module provides functions for validating and transforming card specifications.
+"""
+
+from typing import Any, Dict
+
+import pandas as pd
+from jval import validate
+
+ELEMENT_SPEC: Dict[str, Any] = {
+    "?*id": "<?str>",
+    "*type": "<?str>",
+    "?*position": ["<?float>"],
+    "?*relative_to": ["<?str>"],
+    "?*anchor": "<?str>",
+}
+
+SPECS_FOR_TYPE: Dict[str, Dict[str, Any]] = {
+    "text": {
+        "*text": "<?str>",
+        "?*color": ["<?int>"],
+        "?*font_path": "<?str>",
+        "?*font_size": "<?int>",
+        "?*font_variant": "<?str>",
+        "?*line_spacing": "<?int>",
+        "?*width": "<?int>",
+        "?*align": "<?str>",
+        "?*stroke_width": "<?int>",
+        "?*stroke_color": ["<?int>"],
+    },
+    "image": {
+        "*path": "<?str>",
+        "?*filters": {
+            "?*crop_top": "<?int>",
+            "?*crop_bottom": "<?int>",
+            "?*crop_left": "<?int>",
+            "?*crop_right": "<?int>",
+            "?*crop_box": ["<?int>"],
+            "?*rotate": "<?int>",
+            "?*flip": "<?str>",
+            "?*resize": ["<?int>"],
+        },
+    },
+    "circle": {
+        "*radius": "<?int>",
+        "?*color": ["<?int>"],
+        "?*outline_color": ["<?int>"],
+        "?*outline_width": "<?int>",
+    },
+    "ellipse": {
+        "*size": ["<?int>"],
+        "?*color": ["<?int>"],
+        "?*outline_color": ["<?int>"],
+        "?*outline_width": "<?int>",
+    },
+    "polygon": {
+        "*points": [["<?int>"]],
+        "?*color": ["<?int>"],
+        "?*outline_color": ["<?int>"],
+        "?*outline_width": "<?int>",
+    },
+    "regular-polygon": {
+        "*radius": "<?int>",
+        "*sides": "<?int>",
+        "?*rotation": "<?int>",
+        "?*color": ["<?int>"],
+        "?*outline_color": ["<?int>"],
+        "?*outline_width": "<?int>",
+    },
+    "rectangle": {
+        "*size": ["<?int>"],
+        "?*corners": ["<?bool>"],
+        "?*corner_radius": "<?int>",
+        "?*color": ["<?int>"],
+        "?*outline_color": ["<?int>"],
+        "?*outline_width": "<?int>",
+    },
+}
+
+CARD_SPEC: Dict[str, Any] = {
+    "?*id": "<?str>",
+    "*width": "<?int>",
+    "*height": "<?int>",
+    "?*background_color": ["<?int>"],
+    "*elements": [],
+}
+
+
+def validate_element(element: Dict[str, Any], element_type: str):
+    """
+    Validates an element of a card against a spec, raising an exception
+    if it does not meet the spec.
+    Args:
+        element (dict): The card element.
+        element_type (str): The type of the element
+    """
+    spec = ELEMENT_SPEC | SPECS_FOR_TYPE[element_type]
+    validate(element, spec)
+
+
+def validate_card(card: Dict[str, Any]):
+    """
+    Validates a card against a spec, raising an exception
+    if it does not meet the spec.
+    Args:
+        card (Dict[str, Any]): The card.
+    """
+    # print(f"DEBUG:\n{card=}")
+    validate(card, CARD_SPEC)
+    for element in card["elements"]:
+        # print(f"DEBUG: {element['type']}")
+        validate_element(element, element["type"])
+
+
+def transform_card(card: Dict[str, Any]) -> Dict[str, Any]:
+    """
+    Perform certain automatic type casts on the card and its
+    elements. For example, cast the "text" property of elements
+    of type "text" to str, to support painting numbers as text.
+    Args:
+        card (Dict[str, Any]): The card.
+    Return:
+        Dict[str, Any]: The transformed card with all automatic casts applied.
+    """
+    for element in card.get("elements", []):
+        if element.get("type") == "text" and "text" in element:
+            if pd.isna(element["text"]):
+                element["text"] = None
+            else:
+                element["text"] = str(element["text"])
+
+    return card

{decksmith-0.1.15.dist-info → decksmith-0.9.2.dist-info}/METADATA

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: decksmith
-Version: 0.1.15
-Summary: A command-line application to dynamically generate decks of cards from a JSON specification and a CSV data file, inspired by nandeck.
+Version: 0.9.2
+Summary: A command-line application to dynamically generate decks of cards from a YAML specification and a CSV data file, inspired by nandeck.
 License-Expression: GPL-2.0-only
 Author: Julio Cabria
 Author-email: juliocabria@tutanota.com
@@ -13,27 +13,28 @@ Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
 Provides-Extra: dev
 Requires-Dist: click
+Requires-Dist: crossfiledialog (>=1.1.0)
+Requires-Dist: flask (>=3.1.2)
 Requires-Dist: jval (==1.0.6)
 Requires-Dist: pandas
 Requires-Dist: pillow (>=11.3.0)
-Requires-Dist: poetry ; extra == "dev"
+Requires-Dist: platformdirs (>=4.5.1)
 Requires-Dist: pytest ; extra == "dev"
+Requires-Dist: pywin32 (>=311) ; sys_platform == "win32"
 Requires-Dist: reportlab (>=4.4.3)
-Project-URL: Homepage, https://github.com/Julynx/decksmith
+Requires-Dist: ruamel-yaml (>=0.19.1)
+Requires-Dist: waitress (>=3.0.2)
 Description-Content-Type: text/markdown
 
 # DeckSmith
 
-*A command-line application to dynamically generate decks of cards from a JSON specification and a CSV data file, inspired by nandeck.*
+[julynx.github.io/decksmith](https://julynx.github.io/decksmith/)
 
-<br>
-<p align="center">
-  <img width="600" src="https://raw.githubusercontent.com/Julynx/decksmith/refs/heads/main/docs/assets/decksmith.png">
-</p>
+*A powerful application to dynamically generate decks of cards from a YAML specification and a CSV data file.*
 
 <br>
 <p align="center">
-  <img width="600" src="https://raw.githubusercontent.com/Julynx/decksmith/refs/heads/main/docs/assets/banner.png">
+  <img src="https://raw.githubusercontent.com/Julynx/decksmith/refs/heads/main/docs/assets/screenshot.png" width='100%'>
 </p>
 
 <br>
@@ -44,12 +45,13 @@ DeckSmith is ideal for automating the creation of all kinds of decks, including
 
 - ✨ Consistent layout and formatting across all cards. Define once, edit anytime, generate as many cards as you need.
 - 🍳 Pure python, with easy installation via pip.
+- 🖥️ User-friendly GUI for easy project management and generation.
 - ⚡ Highly performant card generation using parallel processing.
 - 📖 Intuitive syntax and extensive [documentation](https://github.com/Julynx/decksmith/blob/main/docs/DOCS.md) with examples to help you get started.
 - 🧰 Tons of powerful features such as:
   - [Start from a sample project and edit it instead of starting from scratch](https://github.com/Julynx/decksmith/blob/main/docs/DOCS.md#creating-a-project)
   - [Extensive support for images](https://github.com/Julynx/decksmith/blob/main/docs/DOCS.md#images), [text](https://github.com/Julynx/decksmith/blob/main/docs/DOCS.md#text), [and all kinds of different shapes](https://github.com/Julynx/decksmith/blob/main/docs/DOCS.md#shapes)
-  - [Link any field to a column in the CSV file](https://github.com/Julynx/decksmith/blob/main/docs/DOCS.md#basic-example-with-deckcsv)
+  - [Link any field to a column in the CSV file](https://github.com/Julynx/decksmith/blob/main/docs/DOCS.md#example-with-deckcsv)
   - [Position elements absolutely or relative to other elements, using anchors to simplify placement](https://github.com/Julynx/decksmith/blob/main/docs/DOCS.md#positioning)
   - [Powerful image transformations using filters like crop, resize, rotate, or flip](https://github.com/Julynx/decksmith/blob/main/docs/DOCS.md#images)
   - [Export your deck as images or as a PDF for printing](https://github.com/Julynx/decksmith/blob/main/docs/DOCS.md#building-the-deck)
@@ -64,23 +66,29 @@ DeckSmith is ideal for automating the creation of all kinds of decks, including
   pip install decksmith
   ```
 
+- To launch the GUI, run:
+
+  ```bash
+  decksmith --gui
+  ```
+
 ### Creating a project
 
-- Run the following command to start from sample `deck.json` and `deck.csv` files:
+- Run the following command to start from sample `deck.yaml` and `deck.csv` files:
 
   ```text
   decksmith init
   ```
 
-  - `deck.json` defines the layout for the cards in the deck.
+  - `deck.yaml` defines the layout for the cards in the deck.
   - `deck.csv` holds the data for each card, like the content of the text fields and the image paths.
 
 ### Defining the layout
 
-- Edit `deck.json` to include all the elements you want on your cards.
+- Edit `deck.yaml` to include all the elements you want on your cards.
   You can find a complete list of all the available elements and their properties in the [documentation](https://github.com/Julynx/decksmith/blob/main/docs/DOCS.md).
 
-- You can reference any column from `deck.csv` in the `deck.json` file as `%column_name%`.
+- You can reference any column from `deck.csv` in the `deck.yaml` file as `%column_name%`.
 
 ### Building the deck
 

decksmith-0.9.2.dist-info/RECORD

@@ -0,0 +1,27 @@
+decksmith/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+decksmith/card_builder.py,sha256=hxDVS7-dngCiT392pP2aiWgasfSp1ou3v3lzWmLXxL4,5618
+decksmith/deck_builder.py,sha256=J_Zdj4m-tXPSZh67mEyOCQ_CTphRCsPiyHSh1HcNM0M,3305
+decksmith/export.py,sha256=rzRGdyfK1YXu_k9cpkXvNFZZBkpfXW5zPr_iotlJxcY,5979
+decksmith/gui/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+decksmith/gui/app.py,sha256=NQPR_hfCVvrr0QnEUmJXQv_A4lFXXoF8_OostVLwZkU,10178
+decksmith/gui/static/css/style.css,sha256=QZlE4UgTPqdflIa9poaDhIHZ5OlwcF6uACLKaEYjE4E,13837
+decksmith/gui/static/img/decksmith.ico,sha256=bkz7MTDpQELzP2GSvR42Jn7OgIw_j0uBhN4L2i-m1uo,28366
+decksmith/gui/static/js/main.js,sha256=A1Vz4kxlokqTadESYT7PlZf4XkVlaT0AXmSNNSrmixw,21680
+decksmith/gui/templates/index.html,sha256=-rZ-eO7O35gh5bJrQrb-5M-tnYEqSVqGWJh5sCe2e5c,9551
+decksmith/image_ops.py,sha256=8UzibqfoED_Jch-lt--l2LIAoIwdBrXH7so5UqY5pqw,4737
+decksmith/logger.py,sha256=uSMzIpv7xT7ICMz4a88x_Z9-Izz0WU9MdZ9JEwWnOC4,1020
+decksmith/macro.py,sha256=prHs0fTIqxE5kjT1usqnWg8CNZEoWUVNAezD-qJslRY,1584
+decksmith/main.py,sha256=Jm98JBo3a2H_S7mwHEWg8NzyUBXdbFewFxzlpPxjDLI,4653
+decksmith/project.py,sha256=QbhSOAveCuQ05P2Dp-uIc7hkC_o0-NAq3LIWQ4g-FnU,3885
+decksmith/renderers/__init__.py,sha256=xF0SsNJSQEbY-NoSN0N4admLTGc_4JcZumDMpQahWBM,76
+decksmith/renderers/image.py,sha256=SKj_21wlAjHGEG6M0GGu4OkwmJrxf0Nnk9TCu_2BP38,2218
+decksmith/renderers/shapes.py,sha256=iSCCr4hn2lj4EGchq324_eHtuuYAhemYP9PSEUFBkxM,7855
+decksmith/renderers/text.py,sha256=rN3vYUPWy_OpbxiGI5nydOu2V4O1CnoVKaqRIv64waU,4465
+decksmith/templates/deck.csv,sha256=8P3XknSg6kXulNyAmqFHgJDIzGjMnvdMQ8ctTtUoIzE,782
+decksmith/templates/deck.yaml,sha256=3BMpTUH1It25wrmQXZSrERoPo4-8TBKXKxfaRtYowt8,1034
+decksmith/utils.py,sha256=-QHYbNKQeB1SXB5Ovswn6Yql9sfSb5CmSNVpsw3LiVM,2909
+decksmith/validate.py,sha256=uNkBg0ruZp63gOu687Ed2hrtepV9Ez6NwnikKfvexzs,3813
+decksmith-0.9.2.dist-info/entry_points.txt,sha256=-usRztjj2gnfmPubb8nFYHD22drzThAmSfM6geWI98Y,48
+decksmith-0.9.2.dist-info/METADATA,sha256=XqfNoFFAmElTYvBHOLUl9vQkdyiMHHm3OqASmvPIixI,4316
+decksmith-0.9.2.dist-info/WHEEL,sha256=kJCRJT_g0adfAJzTx2GUMmS80rTJIVHRCfG0DQgLq3o,88
+decksmith-0.9.2.dist-info/RECORD,,

{decksmith-0.1.15.dist-info → decksmith-0.9.2.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 2.2.1
+Generator: poetry-core 2.3.1
 Root-Is-Purelib: true
 Tag: py3-none-any

decksmith/templates/deck.json

@@ -1,31 +0,0 @@
-{
-  "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-0.1.15.dist-info/RECORD

@@ -1,13 +0,0 @@
-decksmith/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-decksmith/card_builder.py,sha256=F8m4sMhwuSCcf16QFdWkZG3I8_n04ITeSFwIcyIWjtg,25163
-decksmith/deck_builder.py,sha256=vWjzGPu4OaoiyOdmQ4ONYWOHmiEzOZdubPWiXrxead4,3734
-decksmith/export.py,sha256=8hyYv4B-77OS6xnZ50VBJJNBDfBoQr_i1FR0HVXYpuQ,5463
-decksmith/main.py,sha256=88OTPGV5pmjIrKyAk55C8fkIybYcG2AF5Khs5I3gI7w,4404
-decksmith/templates/deck.csv,sha256=C-Fdeb_byPnGlZNoDq7VlI1aThsvfhMdkieGBA8vglQ,457
-decksmith/templates/deck.json,sha256=Yv-Bb_PmhuMpuDMTgus4swtgFxIjItMws9bKqXTjX_s,664
-decksmith/utils.py,sha256=UkXraPtT3HKlUUu_Cl4gs9SrZHoW-doLY5L-qNpYXFo,2232
-decksmith/validate.py,sha256=bN_SPk08vPeeyJjkzrXnH2sqh99Z3uQBI0BHY7j8ElQ,3681
-decksmith-0.1.15.dist-info/METADATA,sha256=q5aPwAv3Phc7XUk4CA5FY0sSag6PD2ANVXx5TSoTFhE,4150
-decksmith-0.1.15.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
-decksmith-0.1.15.dist-info/entry_points.txt,sha256=-usRztjj2gnfmPubb8nFYHD22drzThAmSfM6geWI98Y,48
-decksmith-0.1.15.dist-info/RECORD,,