decksmith 0.1.12__py3-none-any.whl → 0.1.15__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 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

decksmith-0.1.15.dist-info/METADATA

@@ -0,0 +1,102 @@
+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.
+License-Expression: GPL-2.0-only
+Author: Julio Cabria
+Author-email: juliocabria@tutanota.com
+Requires-Python: >=3.11
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Provides-Extra: dev
+Requires-Dist: click
+Requires-Dist: jval (==1.0.6)
+Requires-Dist: pandas
+Requires-Dist: pillow (>=11.3.0)
+Requires-Dist: poetry ; extra == "dev"
+Requires-Dist: pytest ; extra == "dev"
+Requires-Dist: reportlab (>=4.4.3)
+Project-URL: Homepage, https://github.com/Julynx/decksmith
+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.*
+
+<br>
+<p align="center">
+  <img width="600" src="https://raw.githubusercontent.com/Julynx/decksmith/refs/heads/main/docs/assets/decksmith.png">
+</p>
+
+<br>
+<p align="center">
+  <img width="600" src="https://raw.githubusercontent.com/Julynx/decksmith/refs/heads/main/docs/assets/banner.png">
+</p>
+
+<br>
+
+DeckSmith is ideal for automating the creation of all kinds of decks, including TCG decks, tarot decks, business cards, and even slides.
+
+## Why DeckSmith?
+
+- ✨ 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.
+- ⚡ 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)
+  - [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)
+
+## Getting started
+
+### Installation
+
+- To begin, install DeckSmith by running:
+
+  ```bash
+  pip install decksmith
+  ```
+
+### Creating a project
+
+- Run the following command to start from sample `deck.json` and `deck.csv` files:
+
+  ```text
+  decksmith init
+  ```
+
+  - `deck.json` 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.
+  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%`.
+
+### Building the deck
+
+- When you are ready to generate the deck images, run:
+
+  ```text
+  decksmith build
+  ```
+
+- After building a deck, you can export it to PDF by running:
+
+  ```text
+  decksmith export
+  ```
+
+## Documentation
+
+Check out the [full documentation](https://github.com/Julynx/decksmith/blob/main/docs/DOCS.md) for more detailed information on how to use DeckSmith.
+

decksmith-0.1.15.dist-info/RECORD

@@ -0,0 +1,13 @@
+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,,

decksmith-0.1.12.dist-info/METADATA

@@ -1,54 +0,0 @@
-Metadata-Version: 2.4
-Name: decksmith
-Version: 0.1.12
-Summary: A command-line application to dynamically generate decks of cards from a JSON specification and a CSV data file, inspired by nandeck.
-License-Expression: GPL-2.0-only
-Author: Julio Cabria
-Author-email: juliocabria@tutanota.com
-Requires-Python: >=3.11
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Programming Language :: Python :: 3.14
-Provides-Extra: dev
-Requires-Dist: click
-Requires-Dist: jval (==1.0.6)
-Requires-Dist: pandas
-Requires-Dist: pillow (>=11.3.0)
-Requires-Dist: poetry ; extra == "dev"
-Requires-Dist: pytest ; extra == "dev"
-Requires-Dist: reportlab (>=4.4.3)
-Project-URL: Homepage, https://github.com/Julynx/decksmith
-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.*
-
-<br>
-<p align="center">
-  <img width="600" src="https://raw.githubusercontent.com/Julynx/decksmith/refs/heads/main/docs/assets/decksmith.png">
-</p>
-<br>
-
-DeckSmith is ideal for automating the creation of all kinds of decks, including TCG decks, tarot decks, business cards, and even slides.
-
-## Features
-
-- [Initialize a sample project and edit it instead of starting from scratch](https://github.com/Julynx/decksmith/blob/main/docs/DOCS.md#creating-a-project)
-
-- [Include 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 different kinds of 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)
-
-- [Position elements absolutely or relative to other elements, using anchors to simplify placement](https://github.com/Julynx/decksmith/blob/main/docs/DOCS.md#positioning)
-
-- [Transform images using filters like crop, resize, rotate, or flip](https://github.com/Julynx/decksmith/blob/main/docs/DOCS.md#images)
-
-- [Build card images and export to PDF for printing](https://github.com/Julynx/decksmith/blob/main/docs/DOCS.md#building-the-deck)
-
-## Getting started
-
-To start creating decks, check out [Getting Started](https://github.com/Julynx/decksmith/blob/main/docs/DOCS.md/#getting-started).
-

decksmith-0.1.12.dist-info/RECORD

@@ -1,13 +0,0 @@
-decksmith/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-decksmith/card_builder.py,sha256=9pxiPqeN7_mxVFw8Ii-npseTtlD5KyF9Wg95h7OmCz0,25790
-decksmith/deck_builder.py,sha256=WoaY2A0RDrYNvWZtBckcsR5MKHOXdCpNHaI2J5JZlKU,3835
-decksmith/export.py,sha256=55TaK1fSL0EvtKCoAvUx-47ljNOL5zPeFJguDqL4BVU,5631
-decksmith/main.py,sha256=upBSH8yCOiwCPjW-zf9QpqPTO-RIIaAuEACkWhUTgEw,4542
-decksmith/templates/deck.csv,sha256=pNJebNxoDIfM8m0-aj05YrANHih1BTKOMry1kspIpPI,462
-decksmith/templates/deck.json,sha256=BTTnmaFP5AkbbC_B7uMF6R4bOM7JizW6EATcsjjJrT4,695
-decksmith/utils.py,sha256=vwRrzQEjpZq4x0GJLgJc7TqrC9LLJJqcHAsz1ar-vVs,2301
-decksmith/validate.py,sha256=zA3ygyzOpx3ai6AhkSw611Qik3syZvR5ZmI_w3Pj_No,3813
-decksmith-0.1.12.dist-info/entry_points.txt,sha256=-usRztjj2gnfmPubb8nFYHD22drzThAmSfM6geWI98Y,48
-decksmith-0.1.12.dist-info/METADATA,sha256=Ann7yKRK27_obgKvXnds1dBQ-9omU2JAaTDUw4jxn9g,2507
-decksmith-0.1.12.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
-decksmith-0.1.12.dist-info/RECORD,,