Verify the Ink/Stitch toolchain is ready (venv, checkout, fonts, pystitch).

With run_smoke_test=True, also exports a tiny test design to DST end-to-end (takes a few seconds).

List machine-embroidery file formats Ink/Stitch can read and write (dst, pes, jef, exp, vp3, ...).

List embroidery lettering fonts available to generate_lettering (name, scale limits, description).

List every legal Ink/Stitch per-element parameter name usable with set_element_params.

Inventory embroiderable elements in an SVG: ids, labels, inferred stitch type (fill/stroke/satin), and existing Ink/Stitch params.

Read Ink/Stitch parameters from SVG elements (all parameterized elements, or only the given ids).

Set or remove Ink/Stitch stitch parameters on SVG elements.

updates maps element id -> {param_name: value}; value null removes the param. Param names must come from list_known_params (e.g. angle, row_spacing_mm, running_stitch_length_mm, satin_column, fill_underlay). Booleans are written as true/false; *_mm values are millimeters. Overwrites the input SVG unless output_svg_path is given.

Compile an SVG design into a machine embroidery file (format from the output extension: .dst, .pes, .jef, .exp, .vp3, ...). Returns stitch statistics.

Defaults to /.dst when output_path is omitted.

Convert a machine embroidery file (dst/pes/jef/exp/vp3/hus/...) into an SVG of its stitch plan, editable in Inkscape.

Export an SVG design to several formats at once as a ZIP (e.g. ["dst","pes","svg","threadlist"]). x/y_repeats panelize copies with the given spacing (mm).

Stitch statistics for a machine embroidery file: stitch/jump/trim counts, color changes, threads, size in mm.

Convert one machine embroidery file to another format directly (e.g. mydesign.dst -> mydesign.pes). Format taken from the output extension.

Render a PNG preview of a design's stitches. Accepts a machine file (dst/pes/...) or an SVG (which is compiled first). Returns the image.

Plain-text thread/color report for an SVG design: design size, stitch counts, thread order.

Validate a design's embroidery elements; returns structured errors/warnings with positions and suggested fixes.

Annotate an SVG with a stitch-density heat map layer (red/yellow/green markers per stitch).

Add a rendered stitch-plan layer to an SVG (what will actually be sewn). mode: 'simple' or 'realistic-vector'.

Remove tiny/empty objects that would cause thread breaks. dry_run=True (default) only reports what would be removed.

Apply an Ink/Stitch conversion to SVG elements and save the result.

operation: stroke_to_satin (center-line pair -> satin column), auto_satin (route satins optimally), auto_run (route strokes into one running stitch), fill_to_stroke (fill -> centerline), jump_to_stroke (connect jumps with strokes, whole document), break_apart (split multi-part fill paths), outline (fill -> outline stroke). ids selects target elements (required for all but jump_to_stroke; get them from list_elements). options overrides operation-specific flags, e.g. {"threshold_mm": 5}.

Strip Ink/Stitch parameters and/or command symbols from an SVG, returning it to a plain vector design.

Create machine-embroidered text using Ink/Stitch's digitized fonts.

font is the font name from list_fonts (e.g. "Amitaclo"). formats defaults to ["dst", "svg"]. scale_percent is clamped to the font's supported range. NOTE: each newline-separated line of text becomes a SEPARATE design (own file set) — that is the batch semantics of the underlying extension. trim: off/line/word/glyph. color_sort: off/all/line/word. text_align: left/center/right/block/letterspacing. Extracted files land in output_dir (default: /lettering_).