Add basic pystitch examples

kantoniak · kantoniak · commit ae028d766960 · 2025-09-20T01:56:44.000-07:00
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -0,0 +1,5 @@
+{
+    "recommendations": [
+        "ms-python.python"
+    ]
+}
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,4 @@
+{
+  "files.trimFinalNewlines": true,
+  "files.trimTrailingWhitespace": true,
+}
diff --git a/README.md b/README.md
@@ -1 +1,5 @@
 # Bytes to Bobbins
+
+## Examples
+
+Go to [examples/README.md](examples/README.md) for instructions.
diff --git a/examples/.gitignore b/examples/.gitignore
@@ -0,0 +1,3 @@
+# Outputs
+**/out/**
+!**/out/.gitkeep
diff --git a/examples/Pipfile b/examples/Pipfile
@@ -0,0 +1,13 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+pystitch = "*"
+
+[dev-packages]
+
+[requires]
+python_version = "3.12"
+python_full_version = "3.12.3"
diff --git a/examples/Pipfile.lock b/examples/Pipfile.lock
diff --git a/examples/README.md b/examples/README.md
@@ -0,0 +1,18 @@
+# Examples
+
+Examples are written in Python. To set up environment, install `pipenv` and run:
+```bash
+pipenv sync
+pipenv shell
+```
+To run an example, enter one of the directories and execute `main.py`, for example:
+```bash
+cd python-pystitch-helloworld
+python main.py
+```
+You can preview output files in Inkscape with Ink/Stitch installed.
+
+## Example list
+
+* `python-pystitch-helloworld`: Basic example, a small square
+* `python-pystitch-addblock`: Simplified syntax, multiple squares with color changing
diff --git a/examples/python-pystitch-addblock/main.py b/examples/python-pystitch-addblock/main.py
@@ -0,0 +1,19 @@
+from pathlib import Path
+from pystitch import EmbPattern
+from typing import List, Tuple
+from utils import parse_args, UNITS_PER_MM
+
+args = parse_args(default_filename = f'out/{Path(__file__).parent.name}.jef')
+
+# Create and encode pattern
+STITCH_UNITS = 2 * UNITS_PER_MM
+CENTERED_SQUARE_COORDS = [(-1/2, -1/2), (1/2, -1/2), (1/2, 1/2), (-1/2, 1/2), (-1/2, -1/2)]
+
+def scale_pattern(coords: List[Tuple[float, float]], scale: float):
+    return list((scale*x, scale*y) for (x, y) in coords)
+
+pattern = EmbPattern()
+pattern.add_block(scale_pattern(CENTERED_SQUARE_COORDS, 1*STITCH_UNITS), "red") # 2 mm stitch
+pattern.add_block(scale_pattern(CENTERED_SQUARE_COORDS, 2*STITCH_UNITS), "orange") # 4 mm stitch
+pattern.add_block(scale_pattern(CENTERED_SQUARE_COORDS, 3*STITCH_UNITS), "yellow") # 6 mm stitch
+pattern.write(args.output)
diff --git a/examples/python-pystitch-addblock/out/.gitkeep b/examples/python-pystitch-addblock/out/.gitkeep
diff --git a/examples/python-pystitch-addblock/utils.py b/examples/python-pystitch-addblock/utils.py
@@ -0,0 +1,28 @@
+from argparse import ArgumentParser
+import os
+
+UNITS_PER_MM = 10
+
+def parse_args(default_filename: str = 'out/out.jef'):
+  ALLOWED_EXTENSIONS = [
+    '.dst',  # Tajima Embroidery Format
+    '.exp',  # Melco Expanded Embroidery Format
+    '.gcode',  # gcode Format, Text File
+    '.jef',  # Janome Embroidery Format
+    '.pec',  # Brother Embroidery Format
+    '.pes',  # Brother Embroidery Format
+    '.tbf',  # Tajima Embroidery Format
+    '.u01',  # Barudan Embroidery Format
+    '.vp3',  # Pfaff Embroidery Format
+    '.xxx'   # Singer Embroidery Format
+  ]
+
+  parser = ArgumentParser(description="Generate an embroidery design.")
+  parser.add_argument('-o', '--output', type=str, default=default_filename, help=f"Output file path. {default_filename} by default")
+  args = parser.parse_args()
+
+  _, ext = os.path.splitext(args.output)
+  if ext.lower() not in ALLOWED_EXTENSIONS:
+    raise ValueError(f"Invalid file extension '{ext}'. Allowed extensions: {ALLOWED_EXTENSIONS}")
+
+  return args
diff --git a/examples/python-pystitch-helloworld/main.py b/examples/python-pystitch-helloworld/main.py
@@ -0,0 +1,18 @@
+from pathlib import Path
+from pystitch import EmbPattern, STITCH, TRIM, END
+from utils import parse_args, UNITS_PER_MM
+
+args = parse_args(default_filename = f'out/{Path(__file__).parent.name}.jef')
+
+# Create and encode pattern
+STITCH_UNITS = 3 * UNITS_PER_MM
+
+pattern = EmbPattern()
+pattern.add_stitch_absolute(STITCH, x=-STITCH_UNITS/2, y=-STITCH_UNITS/2)
+pattern.add_stitch_relative(STITCH, dx=STITCH_UNITS, dy=0)
+pattern.add_stitch_relative(STITCH, dx=0, dy=STITCH_UNITS)
+pattern.add_stitch_relative(STITCH, dx=-STITCH_UNITS, dy=0)
+pattern.add_stitch_relative(STITCH, dx=0, dy=-STITCH_UNITS)
+pattern.add_command(TRIM)
+pattern.add_command(END)
+pattern.write(args.output)
diff --git a/examples/python-pystitch-helloworld/out/.gitkeep b/examples/python-pystitch-helloworld/out/.gitkeep
diff --git a/examples/python-pystitch-helloworld/utils.py b/examples/python-pystitch-helloworld/utils.py
@@ -0,0 +1,28 @@
+from argparse import ArgumentParser
+import os
+
+UNITS_PER_MM = 10
+
+def parse_args(default_filename: str = 'out/out.jef'):
+  ALLOWED_EXTENSIONS = [
+    '.dst',  # Tajima Embroidery Format
+    '.exp',  # Melco Expanded Embroidery Format
+    '.gcode',  # gcode Format, Text File
+    '.jef',  # Janome Embroidery Format
+    '.pec',  # Brother Embroidery Format
+    '.pes',  # Brother Embroidery Format
+    '.tbf',  # Tajima Embroidery Format
+    '.u01',  # Barudan Embroidery Format
+    '.vp3',  # Pfaff Embroidery Format
+    '.xxx'   # Singer Embroidery Format
+  ]
+
+  parser = ArgumentParser(description="Generate an embroidery design.")
+  parser.add_argument('-o', '--output', type=str, default=default_filename, help=f"Output file path. {default_filename} by default")
+  args = parser.parse_args()
+
+  _, ext = os.path.splitext(args.output)
+  if ext.lower() not in ALLOWED_EXTENSIONS:
+    raise ValueError(f"Invalid file extension '{ext}'. Allowed extensions: {ALLOWED_EXTENSIONS}")
+
+  return args

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +{
 +    "recommendations": [
 +        "ms-python.python"
 +    ]
 +}
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# Outputs`
	`2`	`+/out/`
	`3`	`+!**/out/.gitkeep`