predictygraph 0.2.3__tar.gz → 0.2.4__tar.gz

{predictygraph-0.2.3 → predictygraph-0.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: predictygraph
-Version: 0.2.3
+Version: 0.2.4
 Summary: Predictable graphs: a readable, CSS-styled diagram DSL with per-group layouts, rendered to SVG/APNG
 Author-Email: Reza Jelveh <git@jelveh.me>
 License: GPL-3.0-or-later
@@ -27,16 +27,40 @@ Editor support: [tree-sitter-pdg](https://github.com/predictygraph/tree-sitter-p
 Rendered examples and the gallery: [predictygraph.github.io](https://predictygraph.github.io/). This repo keeps
 only `.pdg` sources; images live in the docs repo (git-lfs).
 
+## Install
+
+```bash
+uv tool install "predictygraph[apng]"    # or: pipx install "predictygraph[apng]"
+```
+
+`[apng]` adds PNG output. `pdg` is the short alias of the `predictygraph` command.
+
+## Use
+
 ```bash
-uv run pdg examples/hami_flow.pdg                    # -> examples/hami_flow.svg (not committed)
-uv run pdg diagram.pdg --css theme.css -o out.svg
-uv run pdg diagram.pdg -o out.png                    # animated PNG (APNG)
-uv run pdg diagram.pdg --check                       # validate only
-uv run pdg diagram.pdg -o d.png --width 1000 --colors 64   # small PNG for chat
-uv run pdg diagram.pdg --target web                  # size labels to fit any browser font
+pdg examples/annotations.pdg                     # -> examples/annotations.svg (not committed)
+pdg diagram.pdg --css theme.css -o out.svg
+pdg diagram.pdg -o out.png                       # PNG (animated if the diagram moves)
+pdg diagram.pdg --check                          # validate only
+pdg diagram.pdg -o d.png --width 1000 --colors 64   # small PNG for chat
+pdg diagram.pdg --target web                     # size labels to fit any browser font
 ```
 
-`pdg` is the short alias of the `predictygraph` command.
+From a checkout, prefix these with `uv run`. Start with
+[examples/annotations.pdg](examples/annotations.pdg): one small diagram that uses every
+annotation feature, with a comment for each.
+
+## Agent skill
+
+[skills/predictygraph](skills/predictygraph) teaches an AI agent to write, render and
+check `.pdg` diagrams.
+
+```bash
+# Hermes Agent
+hermes skills install https://raw.githubusercontent.com/predictygraph/predictygraph/master/skills/predictygraph/SKILL.md
+# Claude Code and other agents that read SKILL.md folders: copy the folder
+cp -r skills/predictygraph ~/.claude/skills/
+```
 
 ## Credits
 

{predictygraph-0.2.3 → predictygraph-0.2.4}/README.md

@@ -13,16 +13,40 @@ Editor support: [tree-sitter-pdg](https://github.com/predictygraph/tree-sitter-p
 Rendered examples and the gallery: [predictygraph.github.io](https://predictygraph.github.io/). This repo keeps
 only `.pdg` sources; images live in the docs repo (git-lfs).
 
+## Install
+
+```bash
+uv tool install "predictygraph[apng]"    # or: pipx install "predictygraph[apng]"
+```
+
+`[apng]` adds PNG output. `pdg` is the short alias of the `predictygraph` command.
+
+## Use
+
 ```bash
-uv run pdg examples/hami_flow.pdg                    # -> examples/hami_flow.svg (not committed)
-uv run pdg diagram.pdg --css theme.css -o out.svg
-uv run pdg diagram.pdg -o out.png                    # animated PNG (APNG)
-uv run pdg diagram.pdg --check                       # validate only
-uv run pdg diagram.pdg -o d.png --width 1000 --colors 64   # small PNG for chat
-uv run pdg diagram.pdg --target web                  # size labels to fit any browser font
+pdg examples/annotations.pdg                     # -> examples/annotations.svg (not committed)
+pdg diagram.pdg --css theme.css -o out.svg
+pdg diagram.pdg -o out.png                       # PNG (animated if the diagram moves)
+pdg diagram.pdg --check                          # validate only
+pdg diagram.pdg -o d.png --width 1000 --colors 64   # small PNG for chat
+pdg diagram.pdg --target web                     # size labels to fit any browser font
 ```
 
-`pdg` is the short alias of the `predictygraph` command.
+From a checkout, prefix these with `uv run`. Start with
+[examples/annotations.pdg](examples/annotations.pdg): one small diagram that uses every
+annotation feature, with a comment for each.
+
+## Agent skill
+
+[skills/predictygraph](skills/predictygraph) teaches an AI agent to write, render and
+check `.pdg` diagrams.
+
+```bash
+# Hermes Agent
+hermes skills install https://raw.githubusercontent.com/predictygraph/predictygraph/master/skills/predictygraph/SKILL.md
+# Claude Code and other agents that read SKILL.md folders: copy the folder
+cp -r skills/predictygraph ~/.claude/skills/
+```
 
 ## Credits
 

{predictygraph-0.2.3 → predictygraph-0.2.4}/pyproject.toml

@@ -12,7 +12,7 @@ dependencies = [
 ]
 requires-python = ">=3.11"
 readme = "README.md"
-version = "0.2.3"
+version = "0.2.4"
 
 [project.license]
 text = "GPL-3.0-or-later"

{predictygraph-0.2.3 → predictygraph-0.2.4}/src/predictygraph/layout.py

@@ -160,6 +160,9 @@ class LineLayout(Layout):
             if j != i + 1:
                 continue
             w, _, _ = text_block(e.label, e.label_style or e.style, 11, bold=False)
+            if e.attrs.get("step"):  # the step badge sits just left of the label
+                bw, bh, _ = text_block(e.attrs["step"][:3], e.step_style or e.style, 11, bold=True)
+                w += max(bw, bh) + 12
             need[i] = max(need.get(i, 0.0), w + 34)
         return need
 
@@ -570,20 +573,26 @@ def shift(item: Item, dx: float) -> None:
 
 def align_x(doc: Document) -> None:
     """`align-x=ID`: centre an item horizontally on another item, e.g. line up a box with
-    the one it calls in the panel below. It only moves within its parent's content box and
-    never past a sibling, so nothing overlaps and no group is resized."""
+    the one it calls in the panel below. Siblings on the side it moves towards travel with
+    it, so every gap (and the edge labels in it) keeps its width; the whole block stays
+    inside the parent's content box, so no group is resized and nothing overlaps."""
     for item in list(doc.walk()):
         ref = doc.items.get(item.attrs.get("align-x", ""))
         p = item.parent
         if ref is None or ref is item or p is None:
             continue
         pr = box4(p.style.get("padding"), 14)[1]
-        sibs = [s for s in p.children if s is not item]
-        lo = max([s.ax + s.w + 8 for s in sibs if s.ax + s.w <= item.ax + 1e-6], default=p.ax + p.ox)
-        hi = min([s.ax - 8 for s in sibs if s.ax >= item.ax + item.w - 1e-6], default=p.ax + p.w - pr)
-        new = min(max(ref.cx - item.w / 2, lo), hi - item.w)
-        if abs(new - item.ax) > 0.01:
-            shift(item, new - item.ax)
+        lo_edge, hi_edge = p.ax + p.ox, p.ax + p.w - pr
+        dx = ref.cx - item.cx
+        if dx > 0:  # item and everything right of it move right, up to the right edge
+            block = [s for s in p.children if s is item or s.ax >= item.ax + item.w - 1e-6]
+            dx = min(dx, hi_edge - max(s.ax + s.w for s in block))
+        else:       # item and everything left of it move left, down to the left edge
+            block = [s for s in p.children if s is item or s.ax + s.w <= item.ax + 1e-6]
+            dx = max(dx, lo_edge - min(s.ax for s in block))
+        if abs(dx) > 0.01:
+            for s in block:
+                shift(s, dx)
 
 
 def layout(doc: Document) -> None:

{predictygraph-0.2.3 → predictygraph-0.2.4}/tests/test_stack.py

@@ -82,3 +82,17 @@ def test_accent_bar_stays_inside_rounded_corners():
     assert min(ys) > 0 and max(ys) < 40  # starts below the top edge: it follows the arc
     right = accent_segs(0, 0, 100, 40, 4, 10, "right")
     assert min(s[-2] for s in right if s[0] != "Z") >= 96
+
+
+def test_align_x_keeps_gaps_by_moving_neighbours():
+    src = ('graph layout=column align=stretch\n'
+           'group top layout=row gap=300 {\n p "p"\n q "q"\n}\n'
+           'group bottom layout=row gap=30 {\n a "aaaa" align-x=q\n b "bbbb"\n}\n'
+           'a -> b "a fairly long label"\n')
+    plain = parse(src.replace(" align-x=q", ""))
+    build_scene(plain)
+    doc = parse(src)
+    build_scene(doc)
+    gap = lambda d: d.items["b"].ax - (d.items["a"].ax + d.items["a"].w)
+    assert abs(gap(doc) - gap(plain)) < 0.01  # b moved with a: the label still fits
+    assert doc.items["a"].ax > plain.items["a"].ax