decksmith 0.1.12__tar.gz → 0.1.15__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (14) hide show
  1. decksmith-0.1.15/PKG-INFO +102 -0
  2. {decksmith-0.1.12 → decksmith-0.1.15}/decksmith/card_builder.py +627 -627
  3. {decksmith-0.1.12 → decksmith-0.1.15}/decksmith/deck_builder.py +101 -101
  4. {decksmith-0.1.12 → decksmith-0.1.15}/decksmith/export.py +168 -168
  5. {decksmith-0.1.12 → decksmith-0.1.15}/decksmith/main.py +138 -138
  6. {decksmith-0.1.12 → decksmith-0.1.15}/decksmith/templates/deck.csv +5 -5
  7. {decksmith-0.1.12 → decksmith-0.1.15}/decksmith/templates/deck.json +31 -31
  8. {decksmith-0.1.12 → decksmith-0.1.15}/decksmith/utils.py +69 -69
  9. {decksmith-0.1.12 → decksmith-0.1.15}/decksmith/validate.py +132 -132
  10. decksmith-0.1.15/docs/README.md +77 -0
  11. {decksmith-0.1.12 → decksmith-0.1.15}/pyproject.toml +1 -1
  12. decksmith-0.1.12/PKG-INFO +0 -54
  13. decksmith-0.1.12/docs/README.md +0 -29
  14. {decksmith-0.1.12 → decksmith-0.1.15}/decksmith/__init__.py +0 -0
decksmith-0.1.15/PKG-INFO ADDED
@@ -0,0 +1,102 @@
1
+ Metadata-Version: 2.4
2
+ Name: decksmith
3
+ Version: 0.1.15
4
+ Summary: A command-line application to dynamically generate decks of cards from a JSON specification and a CSV data file, inspired by nandeck.
5
+ License-Expression: GPL-2.0-only
6
+ Author: Julio Cabria
7
+ Author-email: juliocabria@tutanota.com
8
+ Requires-Python: >=3.11
9
+ Classifier: Programming Language :: Python :: 3
10
+ Classifier: Programming Language :: Python :: 3.11
11
+ Classifier: Programming Language :: Python :: 3.12
12
+ Classifier: Programming Language :: Python :: 3.13
13
+ Classifier: Programming Language :: Python :: 3.14
14
+ Provides-Extra: dev
15
+ Requires-Dist: click
16
+ Requires-Dist: jval (==1.0.6)
17
+ Requires-Dist: pandas
18
+ Requires-Dist: pillow (>=11.3.0)
19
+ Requires-Dist: poetry ; extra == "dev"
20
+ Requires-Dist: pytest ; extra == "dev"
21
+ Requires-Dist: reportlab (>=4.4.3)
22
+ Project-URL: Homepage, https://github.com/Julynx/decksmith
23
+ Description-Content-Type: text/markdown
24
+
25
+ # DeckSmith
26
+
27
+ *A command-line application to dynamically generate decks of cards from a JSON specification and a CSV data file, inspired by nandeck.*
28
+
29
+ <br>
30
+ <p align="center">
31
+ <img width="600" src="https://raw.githubusercontent.com/Julynx/decksmith/refs/heads/main/docs/assets/decksmith.png">
32
+ </p>
33
+
34
+ <br>
35
+ <p align="center">
36
+ <img width="600" src="https://raw.githubusercontent.com/Julynx/decksmith/refs/heads/main/docs/assets/banner.png">
37
+ </p>
38
+
39
+ <br>
40
+
41
+ DeckSmith is ideal for automating the creation of all kinds of decks, including TCG decks, tarot decks, business cards, and even slides.
42
+
43
+ ## Why DeckSmith?
44
+
45
+ - ✨ Consistent layout and formatting across all cards. Define once, edit anytime, generate as many cards as you need.
46
+ - 🍳 Pure python, with easy installation via pip.
47
+ - ⚡ Highly performant card generation using parallel processing.
48
+ - 📖 Intuitive syntax and extensive [documentation](https://github.com/Julynx/decksmith/blob/main/docs/DOCS.md) with examples to help you get started.
49
+ - 🧰 Tons of powerful features such as:
50
+ - [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)
51
+ - [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)
52
+ - [Link any field to a column in the CSV file](https://github.com/Julynx/decksmith/blob/main/docs/DOCS.md#basic-example-with-deckcsv)
53
+ - [Position elements absolutely or relative to other elements, using anchors to simplify placement](https://github.com/Julynx/decksmith/blob/main/docs/DOCS.md#positioning)
54
+ - [Powerful image transformations using filters like crop, resize, rotate, or flip](https://github.com/Julynx/decksmith/blob/main/docs/DOCS.md#images)
55
+ - [Export your deck as images or as a PDF for printing](https://github.com/Julynx/decksmith/blob/main/docs/DOCS.md#building-the-deck)
56
+
57
+ ## Getting started
58
+
59
+ ### Installation
60
+
61
+ - To begin, install DeckSmith by running:
62
+
63
+ ```bash
64
+ pip install decksmith
65
+ ```
66
+
67
+ ### Creating a project
68
+
69
+ - Run the following command to start from sample `deck.json` and `deck.csv` files:
70
+
71
+ ```text
72
+ decksmith init
73
+ ```
74
+
75
+ - `deck.json` defines the layout for the cards in the deck.
76
+ - `deck.csv` holds the data for each card, like the content of the text fields and the image paths.
77
+
78
+ ### Defining the layout
79
+
80
+ - Edit `deck.json` to include all the elements you want on your cards.
81
+ 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).
82
+
83
+ - You can reference any column from `deck.csv` in the `deck.json` file as `%column_name%`.
84
+
85
+ ### Building the deck
86
+
87
+ - When you are ready to generate the deck images, run:
88
+
89
+ ```text
90
+ decksmith build
91
+ ```
92
+
93
+ - After building a deck, you can export it to PDF by running:
94
+
95
+ ```text
96
+ decksmith export
97
+ ```
98
+
99
+ ## Documentation
100
+
101
+ Check out the [full documentation](https://github.com/Julynx/decksmith/blob/main/docs/DOCS.md) for more detailed information on how to use DeckSmith.
102
+