frameplot 0.4.0__tar.gz → 0.5.1__tar.gz

{frameplot-0.4.0/src/frameplot.egg-info → frameplot-0.5.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: frameplot
-Version: 0.4.0
+Version: 0.5.1
 Summary: Turn Python-defined pipeline graphs into presentation-ready SVG and PNG diagrams.
 Author: Small Turtle 2
 License-Expression: MIT
@@ -38,7 +38,7 @@ Turn Python-defined pipeline graphs into presentation-ready SVG and PNG diagrams
 
 [한국어 README](https://github.com/smturtle2/frameplot/blob/main/README.ko.md)
 
-![frameplot hero image](docs/assets/frameplot-hero-retro.png)
+![frameplot hero image](docs/assets/frameplot-hero-soft-retro.png)
 
 `frameplot` is a compact Python library for rendering left-to-right pipeline diagrams with clean defaults. Define nodes, edges, groups, and optional detail panels in plain Python, then export polished SVG for documentation or high-resolution PNG for slides and papers.
 
@@ -46,9 +46,13 @@ Turn Python-defined pipeline graphs into presentation-ready SVG and PNG diagrams
 
 All built-in presets stay on a white canvas. The same hero pipeline is rendered below once per theme so you can compare them directly.
 
-| Retro | Pastel | Dark |
-| --- | --- | --- |
-| ![Retro theme hero](docs/assets/frameplot-hero-retro.png) | ![Pastel theme hero](docs/assets/frameplot-hero-pastel.png) | ![Dark theme hero](docs/assets/frameplot-hero-dark.png) |
+| Soft Retro | Retro |
+| --- | --- |
+| ![Soft Retro theme hero](docs/assets/frameplot-hero-soft-retro.png) | ![Retro theme hero](docs/assets/frameplot-hero-retro.png) |
+
+| Pastel | Dark |
+| --- | --- |
+| ![Pastel theme hero](docs/assets/frameplot-hero-pastel.png) | ![Dark theme hero](docs/assets/frameplot-hero-dark.png) |
 
 | Cyberpunk | Monochrome |
 | --- | --- |
@@ -101,17 +105,41 @@ pipeline.save_png("pipeline.png")
 
 ![Quickstart result](docs/assets/quickstart.png)
 
+## Edge-to-Edge Joins
+
+```python
+from frameplot import Edge, Node, Pipeline
+
+pipeline = Pipeline(
+    nodes=[
+        Node("source", "Source", "Primary request"),
+        Node("worker", "Worker", "Prepare response"),
+        Node("audit", "Audit", "Write side log", fill="#DBEAFE"),
+        Node("done", "Done", "Return result", fill="#D9EAD3"),
+    ],
+    edges=[
+        Edge("e1", "source", "worker"),
+        Edge("e2", "worker", "done"),
+        Edge("e3", "audit", "e2", merge_symbol="+", color="#2563EB"),
+    ],
+)
+```
+
+![Edge join result](docs/assets/edge-join.png)
+
 ## Public API
 
 Top-level imports are the supported public API:
 
 - `Node(id, title, subtitle=None, fill=None, stroke=None, text_color=None, metadata=None, width=None, height=None)`
-- `Edge(id, source, target, color=None, dashed=False, metadata=None)`
+- `Edge(id, source, target, color=None, dashed=False, merge_symbol=None, metadata=None)`
 - `Group(id, label, node_ids, edge_ids=(), stroke=None, fill=None, metadata=None)`
 - `DetailPanel(id, focus_node_id, label, nodes, edges, groups=(), stroke=None, fill=None, metadata=None)`
 - `Theme(...)`
 - `Pipeline(nodes, edges, groups=(), detail_panel=None, theme=None)`
 
+`Edge.target` may reference either a node id or another edge id. When targeting another edge, `merge_symbol="+"` or `"x"` renders a join badge at the merge point.
+
 `Pipeline` exposes:
 
 - `to_svg() -> str`
@@ -125,12 +153,12 @@ The hero image at the top and the theme gallery above are generated from [`examp
 
 - **Complex Routing**: Seamlessly connecting AWS (S3/Lambda) to GCP (Pub/Sub/Dataflow) services.
 - **Contextual Details**: Using a `DetailPanel` to explain the internal Spark Job Pipeline of the "Dataflow" node.
-- **Retro Editorial Styling**: Applying the built-in `Theme.retro()` preset on a white canvas.
+- **Soft Retro Styling**: Applying the built-in `Theme.soft_retro()` preset on a white canvas.
 
 ## Design Notes
 
 - Layout is intentionally left-to-right in v0.x.
-- Edge labels are not supported yet.
+- Edge labels are not supported yet, but edge-to-edge joins can render optional `+` / `x` badges.
 - Groups stay visual overlays, and routes leaving or re-entering grouped nodes bend outside grouped areas.
 - Detail panels render as separate lower insets attached to a focus node in the main flow.
 

{frameplot-0.4.0 → frameplot-0.5.1}/README.md

@@ -9,7 +9,7 @@ Turn Python-defined pipeline graphs into presentation-ready SVG and PNG diagrams
 
 [한국어 README](https://github.com/smturtle2/frameplot/blob/main/README.ko.md)
 
-![frameplot hero image](docs/assets/frameplot-hero-retro.png)
+![frameplot hero image](docs/assets/frameplot-hero-soft-retro.png)
 
 `frameplot` is a compact Python library for rendering left-to-right pipeline diagrams with clean defaults. Define nodes, edges, groups, and optional detail panels in plain Python, then export polished SVG for documentation or high-resolution PNG for slides and papers.
 
@@ -17,9 +17,13 @@ Turn Python-defined pipeline graphs into presentation-ready SVG and PNG diagrams
 
 All built-in presets stay on a white canvas. The same hero pipeline is rendered below once per theme so you can compare them directly.
 
-| Retro | Pastel | Dark |
-| --- | --- | --- |
-| ![Retro theme hero](docs/assets/frameplot-hero-retro.png) | ![Pastel theme hero](docs/assets/frameplot-hero-pastel.png) | ![Dark theme hero](docs/assets/frameplot-hero-dark.png) |
+| Soft Retro | Retro |
+| --- | --- |
+| ![Soft Retro theme hero](docs/assets/frameplot-hero-soft-retro.png) | ![Retro theme hero](docs/assets/frameplot-hero-retro.png) |
+
+| Pastel | Dark |
+| --- | --- |
+| ![Pastel theme hero](docs/assets/frameplot-hero-pastel.png) | ![Dark theme hero](docs/assets/frameplot-hero-dark.png) |
 
 | Cyberpunk | Monochrome |
 | --- | --- |
@@ -72,17 +76,41 @@ pipeline.save_png("pipeline.png")
 
 ![Quickstart result](docs/assets/quickstart.png)
 
+## Edge-to-Edge Joins
+
+```python
+from frameplot import Edge, Node, Pipeline
+
+pipeline = Pipeline(
+    nodes=[
+        Node("source", "Source", "Primary request"),
+        Node("worker", "Worker", "Prepare response"),
+        Node("audit", "Audit", "Write side log", fill="#DBEAFE"),
+        Node("done", "Done", "Return result", fill="#D9EAD3"),
+    ],
+    edges=[
+        Edge("e1", "source", "worker"),
+        Edge("e2", "worker", "done"),
+        Edge("e3", "audit", "e2", merge_symbol="+", color="#2563EB"),
+    ],
+)
+```
+
+![Edge join result](docs/assets/edge-join.png)
+
 ## Public API
 
 Top-level imports are the supported public API:
 
 - `Node(id, title, subtitle=None, fill=None, stroke=None, text_color=None, metadata=None, width=None, height=None)`
-- `Edge(id, source, target, color=None, dashed=False, metadata=None)`
+- `Edge(id, source, target, color=None, dashed=False, merge_symbol=None, metadata=None)`
 - `Group(id, label, node_ids, edge_ids=(), stroke=None, fill=None, metadata=None)`
 - `DetailPanel(id, focus_node_id, label, nodes, edges, groups=(), stroke=None, fill=None, metadata=None)`
 - `Theme(...)`
 - `Pipeline(nodes, edges, groups=(), detail_panel=None, theme=None)`
 
+`Edge.target` may reference either a node id or another edge id. When targeting another edge, `merge_symbol="+"` or `"x"` renders a join badge at the merge point.
+
 `Pipeline` exposes:
 
 - `to_svg() -> str`
@@ -96,12 +124,12 @@ The hero image at the top and the theme gallery above are generated from [`examp
 
 - **Complex Routing**: Seamlessly connecting AWS (S3/Lambda) to GCP (Pub/Sub/Dataflow) services.
 - **Contextual Details**: Using a `DetailPanel` to explain the internal Spark Job Pipeline of the "Dataflow" node.
-- **Retro Editorial Styling**: Applying the built-in `Theme.retro()` preset on a white canvas.
+- **Soft Retro Styling**: Applying the built-in `Theme.soft_retro()` preset on a white canvas.
 
 ## Design Notes
 
 - Layout is intentionally left-to-right in v0.x.
-- Edge labels are not supported yet.
+- Edge labels are not supported yet, but edge-to-edge joins can render optional `+` / `x` badges.
 - Groups stay visual overlays, and routes leaving or re-entering grouped nodes bend outside grouped areas.
 - Detail panels render as separate lower insets attached to a focus node in the main flow.
 

{frameplot-0.4.0 → frameplot-0.5.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "frameplot"
-version = "0.4.0"
+version = "0.5.1"
 description = "Turn Python-defined pipeline graphs into presentation-ready SVG and PNG diagrams."
 readme = "README.md"
 requires-python = ">=3.11"

{frameplot-0.4.0 → frameplot-0.5.1}/src/frameplot/layout/__init__.py

@@ -139,6 +139,13 @@ def _rank_gap_overrides(
     ).items():
         required_gaps[key] = round(max(required_gaps.get(key, 0.0), required_gap), 2)
 
+    for key, required_gap in _join_target_gap_requirements(
+        validated,
+        placed_nodes,
+        routed_edges,
+    ).items():
+        required_gaps[key] = round(max(required_gaps.get(key, 0.0), required_gap), 2)
+
     for key, required_gap in required_gaps.items():
         if required_gap > base_gap + EPSILON:
             overrides[key] = round(required_gap, 2)
@@ -146,6 +153,64 @@ def _rank_gap_overrides(
     return overrides
 
 
+def _join_target_gap_requirements(
+    validated: "ValidatedPipeline | ValidatedDetailPanel",
+    placed_nodes: dict[str, LayoutNode],
+    routed_edges: tuple[RoutedEdge, ...],
+) -> dict[tuple[int, int], float]:
+    route_by_id = {route.edge.id: route for route in routed_edges}
+    joins_by_target_segment: dict[tuple[str, int], list[RoutedEdge]] = {}
+
+    for routed_edge in routed_edges:
+        if routed_edge.target_kind != "edge" or routed_edge.target_edge_id is None:
+            continue
+        if routed_edge.join_segment_index is None:
+            continue
+        joins_by_target_segment.setdefault(
+            (routed_edge.target_edge_id, routed_edge.join_segment_index),
+            [],
+        ).append(routed_edge)
+
+    required_gaps: dict[tuple[int, int], float] = {}
+    badge_diameter = max(validated.theme.arrow_size * 1.8, validated.theme.stroke_width * 6.0)
+    join_spacing = max(validated.theme.arrow_size * 1.5, validated.theme.stroke_width * 6.0)
+
+    for (target_edge_id, join_segment_index), joins in joins_by_target_segment.items():
+        target_edge = validated.edge_lookup[target_edge_id]
+        target_target = validated.edge_targets[target_edge_id]
+        source_node = placed_nodes[target_edge.source]
+        target_node = placed_nodes[target_target.node_id]
+        target_route = route_by_id.get(target_edge_id)
+        if target_route is None:
+            continue
+        if source_node.component_id != target_node.component_id:
+            continue
+        if source_node.rank >= target_node.rank or source_node.order != target_node.order:
+            continue
+        if join_segment_index >= len(target_route.points) - 1:
+            continue
+
+        start = target_route.points[join_segment_index]
+        end = target_route.points[join_segment_index + 1]
+        if start.y != end.y:
+            continue
+
+        current_segment_length = abs(end.x - start.x)
+        required_segment_length = (
+            validated.theme.route_track_gap
+            + badge_diameter * len(joins)
+            + join_spacing * max(0, len(joins) - 1)
+        )
+        if current_segment_length >= required_segment_length - EPSILON:
+            continue
+
+        required_gap = validated.theme.route_track_gap + (required_segment_length - current_segment_length)
+        key = (source_node.component_id, source_node.rank)
+        required_gaps[key] = max(required_gaps.get(key, 0.0), round(required_gap, 2))
+
+    return required_gaps
+
+
 def _group_boundary_gap_requirements(
     placed_nodes: dict[str, LayoutNode],
     overlays: tuple[GroupOverlay, ...],
@@ -506,6 +571,22 @@ def _shift_edge(route: RoutedEdge, shift_x: float, shift_y: float) -> RoutedEdge
             height=route.bounds.height,
         ),
         stroke=route.stroke,
+        target_kind=route.target_kind,
+        target_node_id=route.target_node_id,
+        target_edge_id=route.target_edge_id,
+        join_point=(
+            Point(route.join_point.x + shift_x, route.join_point.y + shift_y)
+            if route.join_point is not None
+            else None
+        ),
+        badge_center=(
+            Point(route.badge_center.x + shift_x, route.badge_center.y + shift_y)
+            if route.badge_center is not None
+            else None
+        ),
+        join_segment_index=route.join_segment_index,
+        show_arrowhead=route.show_arrowhead,
+        join_badge_radius=route.join_badge_radius,
     )
 
 

{frameplot-0.4.0 → frameplot-0.5.1}/src/frameplot/layout/order.py

@@ -47,9 +47,10 @@ def _forward_neighbors(
     outgoing: dict[str, list[str]] = defaultdict(list)
 
     for edge in validated.edges:
-        if ranks[edge.source] < ranks[edge.target]:
-            incoming[edge.target].append(edge.source)
-            outgoing[edge.source].append(edge.target)
+        target_node_id = validated.edge_targets[edge.id].node_id
+        if ranks[edge.source] < ranks[target_node_id]:
+            incoming[target_node_id].append(edge.source)
+            outgoing[edge.source].append(target_node_id)
 
     return incoming, outgoing
 
@@ -120,10 +121,11 @@ def _detail_focus_path_nodes(
     forward_incoming: dict[str, list[str]] = defaultdict(list)
 
     for edge in validated.edges:
-        if edge.dashed or ranks[edge.source] >= ranks[edge.target]:
+        target_node_id = validated.edge_targets[edge.id].node_id
+        if edge.dashed or ranks[edge.source] >= ranks[target_node_id]:
             continue
-        forward_outgoing[edge.source].append(edge.target)
-        forward_incoming[edge.target].append(edge.source)
+        forward_outgoing[edge.source].append(target_node_id)
+        forward_incoming[target_node_id].append(edge.source)
 
     ancestors = _reachable(focus_node_id, forward_incoming)
     descendants = _reachable(focus_node_id, forward_outgoing)
@@ -152,8 +154,9 @@ def _reachable(start: str, adjacency: dict[str, list[str]]) -> set[str]:
 def _weak_component_nodes(validated: ValidatedPipeline, start_node_id: str) -> set[str]:
     adjacency: dict[str, set[str]] = {node.id: set() for node in validated.nodes}
     for edge in validated.edges:
-        adjacency[edge.source].add(edge.target)
-        adjacency[edge.target].add(edge.source)
+        target_node_id = validated.edge_targets[edge.id].node_id
+        adjacency[edge.source].add(target_node_id)
+        adjacency[target_node_id].add(edge.source)
 
     seen = {start_node_id}
     queue = deque([start_node_id])

{frameplot-0.4.0 → frameplot-0.5.1}/src/frameplot/layout/place.py

@@ -101,8 +101,9 @@ def place_nodes(
 def _weak_components(validated: "ValidatedPipeline | ValidatedDetailPanel") -> list[tuple[str, ...]]:
     adjacency: dict[str, set[str]] = {node.id: set() for node in validated.nodes}
     for edge in validated.edges:
-        adjacency[edge.source].add(edge.target)
-        adjacency[edge.target].add(edge.source)
+        target_node_id = validated.edge_targets[edge.id].node_id
+        adjacency[edge.source].add(target_node_id)
+        adjacency[target_node_id].add(edge.source)
 
     components: list[tuple[str, ...]] = []
     seen: set[str] = set()
@@ -148,10 +149,11 @@ def _row_gap_after(
         row_padding[row] = max((node_padding.get(n, 0.0) for n in nodes_in_row), default=0.0)
 
     for edge in validated.edges:
-        if edge.source not in component_set or edge.target not in component_set:
+        target_node_id = validated.edge_targets[edge.id].node_id
+        if edge.source not in component_set or target_node_id not in component_set:
             continue
         source_row = rows[edge.source]
-        target_row = rows[edge.target]
+        target_row = rows[target_node_id]
         if source_row == target_row:
             continue
         for row in range(min(source_row, target_row), max(source_row, target_row)):

{frameplot-0.4.0 → frameplot-0.5.1}/src/frameplot/layout/rank.py

@@ -14,7 +14,7 @@ def assign_ranks(validated: ValidatedPipeline, scc_result: SccResult) -> dict[st
 
     for edge in validated.edges:
         source_component = scc_result.node_to_component[edge.source]
-        target_component = scc_result.node_to_component[edge.target]
+        target_component = scc_result.node_to_component[validated.edge_targets[edge.id].node_id]
         if source_component == target_component:
             continue
         predecessors[target_component].add(source_component)