renderdag 0.1.0__tar.gz

renderdag-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Meta Platforms, Inc. and affiliates.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

renderdag-0.1.0/PKG-INFO

@@ -0,0 +1,152 @@
+Metadata-Version: 2.3
+Name: renderdag
+Version: 0.1.0
+Summary: Render directed acyclic graphs (DAGs) as text, ported from sapling-renderdag
+Keywords: dag,graph,visualization,git,terminal
+Author: Sam Watson
+Author-email: Sam Watson <sam.watson@aprioriinvestments.com>
+License: MIT License
+         
+         Copyright (c) Meta Platforms, Inc. and affiliates.
+         
+         Permission is hereby granted, free of charge, to any person obtaining a copy
+         of this software and associated documentation files (the "Software"), to deal
+         in the Software without restriction, including without limitation the rights
+         to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+         copies of the Software, and to permit persons to whom the Software is
+         furnished to do so, subject to the following conditions:
+         
+         The above copyright notice and this permission notice shall be included in all
+         copies or substantial portions of the Software.
+         
+         THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+         IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+         FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+         AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+         LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+         SOFTWARE.
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Version Control :: Git
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+# renderdag
+
+A Python port of Meta's [sapling-renderdag](https://github.com/facebook/sapling/tree/main/eden/scm/lib/renderdag) Rust library for rendering directed acyclic graphs (DAGs) as text.
+
+
+## Renderers
+
+**ASCII** — basic characters, compact:
+
+```
+o    E  merge commit
+|\
+o |  D
+| |
+| o  C  branch
+|/
+o  B
+|
+o  A
+```
+
+**ASCII Large** — wider spacing, easier to read:
+
+```
+o     E  merge commit
+|\
+| \
+o  |  D
+|  |
+|  o  C  branch
+| /
+|/
+o  B
+|
+o  A
+```
+
+**Box Drawing** — Unicode line-drawing characters:
+
+```
+o    E  merge commit
+├─╮
+o │  D
+│ │
+│ o  C  branch
+├─╯
+o  B
+│
+o  A
+```
+
+## Install
+
+```
+pip install renderdag
+# or
+uv add renderdag
+```
+
+## Usage
+
+```python
+from renderdag import Ancestor, GraphRowRenderer
+
+renderer = GraphRowRenderer().output().build_box_drawing()
+
+# Render rows top-down (most recent commit first)
+print(renderer.next_row("C", [Ancestor.parent("B")], "o", "C  latest"))
+print(renderer.next_row("B", [Ancestor.parent("A")], "o", "B"))
+print(renderer.next_row("A", [], "o", "A  root"))
+```
+
+The API follows a row-at-a-time model: call `next_row()` for each node in topological order (heads first), passing the node identifier, its parents as `Ancestor` values, a glyph string, and a message. The renderer tracks column state and returns the formatted string for that row.
+
+### Ancestor types
+
+- `Ancestor.parent(node)` — direct parent (solid line)
+- `Ancestor.ancestor(node)` — indirect ancestor (dotted line)
+- `Ancestor.anonymous()` — unknown/missing parent (terminator `~`)
+
+### Builder options
+
+```python
+# ASCII renderer
+renderer = GraphRowRenderer().output().build_ascii()
+
+# ASCII Large with taller rows
+renderer = GraphRowRenderer().output().with_min_row_height(3).build_ascii_large()
+
+# Box Drawing with square corners instead of curved
+renderer = GraphRowRenderer().output().build_box_drawing().with_square_glyphs()
+
+# Reserve a column for a node before it appears
+renderer.reserve("some-node")
+```
+
+## Development
+
+Requires [uv](https://docs.astral.sh/uv/) and [just](https://just.systems/).
+
+```
+just demo          # see example output from all renderers
+just test          # run all tests
+just test-fast     # skip Rust cross-validation
+just test-xval     # run only Rust cross-validation
+```
+
+## License
+
+MIT. This is a derivative work of [sapling-renderdag](https://github.com/facebook/sapling/tree/main/eden/scm/lib/renderdag) by Meta Platforms, Inc. See [LICENSE](LICENSE) for details.
+
+*Note: this library was created using LLMs.*
+

renderdag-0.1.0/README.md

@@ -0,0 +1,113 @@
+# renderdag
+
+A Python port of Meta's [sapling-renderdag](https://github.com/facebook/sapling/tree/main/eden/scm/lib/renderdag) Rust library for rendering directed acyclic graphs (DAGs) as text.
+
+
+## Renderers
+
+**ASCII** — basic characters, compact:
+
+```
+o    E  merge commit
+|\
+o |  D
+| |
+| o  C  branch
+|/
+o  B
+|
+o  A
+```
+
+**ASCII Large** — wider spacing, easier to read:
+
+```
+o     E  merge commit
+|\
+| \
+o  |  D
+|  |
+|  o  C  branch
+| /
+|/
+o  B
+|
+o  A
+```
+
+**Box Drawing** — Unicode line-drawing characters:
+
+```
+o    E  merge commit
+├─╮
+o │  D
+│ │
+│ o  C  branch
+├─╯
+o  B
+│
+o  A
+```
+
+## Install
+
+```
+pip install renderdag
+# or
+uv add renderdag
+```
+
+## Usage
+
+```python
+from renderdag import Ancestor, GraphRowRenderer
+
+renderer = GraphRowRenderer().output().build_box_drawing()
+
+# Render rows top-down (most recent commit first)
+print(renderer.next_row("C", [Ancestor.parent("B")], "o", "C  latest"))
+print(renderer.next_row("B", [Ancestor.parent("A")], "o", "B"))
+print(renderer.next_row("A", [], "o", "A  root"))
+```
+
+The API follows a row-at-a-time model: call `next_row()` for each node in topological order (heads first), passing the node identifier, its parents as `Ancestor` values, a glyph string, and a message. The renderer tracks column state and returns the formatted string for that row.
+
+### Ancestor types
+
+- `Ancestor.parent(node)` — direct parent (solid line)
+- `Ancestor.ancestor(node)` — indirect ancestor (dotted line)
+- `Ancestor.anonymous()` — unknown/missing parent (terminator `~`)
+
+### Builder options
+
+```python
+# ASCII renderer
+renderer = GraphRowRenderer().output().build_ascii()
+
+# ASCII Large with taller rows
+renderer = GraphRowRenderer().output().with_min_row_height(3).build_ascii_large()
+
+# Box Drawing with square corners instead of curved
+renderer = GraphRowRenderer().output().build_box_drawing().with_square_glyphs()
+
+# Reserve a column for a node before it appears
+renderer.reserve("some-node")
+```
+
+## Development
+
+Requires [uv](https://docs.astral.sh/uv/) and [just](https://just.systems/).
+
+```
+just demo          # see example output from all renderers
+just test          # run all tests
+just test-fast     # skip Rust cross-validation
+just test-xval     # run only Rust cross-validation
+```
+
+## License
+
+MIT. This is a derivative work of [sapling-renderdag](https://github.com/facebook/sapling/tree/main/eden/scm/lib/renderdag) by Meta Platforms, Inc. See [LICENSE](LICENSE) for details.
+
+*Note: this library was created using LLMs.*
+

renderdag-0.1.0/pyproject.toml

@@ -0,0 +1,33 @@
+[project]
+name = "renderdag"
+version = "0.1.0"
+description = "Render directed acyclic graphs (DAGs) as text, ported from sapling-renderdag"
+readme = "README.md"
+license = { file = "LICENSE" }
+keywords = ["dag", "graph", "visualization", "git", "terminal"]
+classifiers = [
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Software Development :: Version Control :: Git",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+authors = [
+    { name = "Sam Watson", email = "sam.watson@aprioriinvestments.com" }
+]
+requires-python = ">=3.10"
+dependencies = []
+
+[build-system]
+requires = ["uv_build>=0.10.1,<0.11.0"]
+build-backend = "uv_build"
+
+[dependency-groups]
+dev = [
+    "marimo[mcp]>=0.19.9",
+    "polars>=1.38.1",
+    "pytest>=8.0",
+]

renderdag-0.1.0/src/renderdag/__init__.py

@@ -0,0 +1,25 @@
+from ._render import (
+    Ancestor,
+    AncestorType,
+    GraphRow,
+    GraphRowRenderer,
+    LinkLine,
+    NodeLine,
+    PadLine,
+)
+from ._ascii import AsciiRenderer
+from ._ascii_large import AsciiLargeRenderer
+from ._box_drawing import BoxDrawingRenderer
+
+__all__ = [
+    "Ancestor",
+    "AncestorType",
+    "GraphRow",
+    "GraphRowRenderer",
+    "LinkLine",
+    "NodeLine",
+    "PadLine",
+    "AsciiRenderer",
+    "AsciiLargeRenderer",
+    "BoxDrawingRenderer",
+]

renderdag-0.1.0/src/renderdag/_ascii.py

@@ -0,0 +1,165 @@
+from __future__ import annotations
+
+from ._output import OutputRendererOptions
+from ._pad import pad_lines
+from ._render import (
+    AncestorType,
+    GraphRow,
+    GraphRowRenderer,
+    LinkLine,
+    NodeLine,
+    PadLine,
+)
+
+
+class AsciiRenderer:
+    def __init__(self, inner: GraphRowRenderer, options: OutputRendererOptions) -> None:
+        self._inner = inner
+        self._options = options
+        self._extra_pad_line: str | None = None
+
+    def width(
+        self,
+        node: object | None = None,
+        parents: list[AncestorType] | None = None,
+    ) -> int:
+        return self._inner.width(node, parents) * 2 + 1
+
+    def reserve(self, node: object) -> None:
+        self._inner.reserve(node)
+
+    def next_row(
+        self,
+        node: object,
+        parents: list[AncestorType],
+        glyph: str,
+        message: str,
+    ) -> str:
+        line = self._inner.next_row(node, parents, glyph, message)
+        out: list[str] = []
+        message_lines = pad_lines(
+            line.message.splitlines(), self._options.min_row_height
+        )
+        message_iter = iter(message_lines)
+        need_extra_pad_line = False
+
+        if self._extra_pad_line is not None:
+            out.append(self._extra_pad_line.rstrip())
+            out.append("\n")
+            self._extra_pad_line = None
+
+        # Node line
+        node_line_str = ""
+        for entry in line.node_line:
+            if entry == NodeLine.NODE:
+                node_line_str += line.glyph + " "
+            elif entry == NodeLine.PARENT:
+                node_line_str += "| "
+            elif entry == NodeLine.ANCESTOR:
+                node_line_str += ". "
+            else:
+                node_line_str += "  "
+        msg = next(message_iter, None)
+        if msg is not None:
+            node_line_str += " " + msg
+        out.append(node_line_str.rstrip())
+        out.append("\n")
+
+        # Link line
+        if line.link_line is not None:
+            link_row = line.link_line
+            any_horizontal = any(
+                cur.intersects(LinkLine.HORIZONTAL) for cur in link_row
+            )
+            link_line_str = ""
+            extended = list(link_row) + [LinkLine(0)]
+            for idx in range(len(link_row)):
+                cur = extended[idx]
+                nxt = extended[idx + 1]
+
+                # Column character
+                if cur.intersects(LinkLine.HORIZONTAL):
+                    if cur.intersects(LinkLine.CHILD | LinkLine.ANY_FORK_OR_MERGE):
+                        link_line_str += "+"
+                    else:
+                        link_line_str += "-"
+                elif cur.intersects(LinkLine.VERTICAL):
+                    if cur.intersects(LinkLine.ANY_FORK_OR_MERGE) and any_horizontal:
+                        link_line_str += "+"
+                    elif cur.intersects(LinkLine.VERT_PARENT):
+                        link_line_str += "|"
+                    else:
+                        link_line_str += "."
+                elif cur.intersects(LinkLine.ANY_MERGE) and any_horizontal:
+                    link_line_str += "'"
+                elif cur.intersects(LinkLine.ANY_FORK) and any_horizontal:
+                    link_line_str += "."
+                else:
+                    link_line_str += " "
+
+                # Connecting character
+                if cur.intersects(LinkLine.HORIZONTAL):
+                    link_line_str += "-"
+                elif cur.intersects(LinkLine.RIGHT_MERGE):
+                    if nxt.intersects(LinkLine.LEFT_FORK) and not any_horizontal:
+                        link_line_str += "\\"
+                    else:
+                        link_line_str += "-"
+                elif cur.intersects(LinkLine.RIGHT_FORK):
+                    if nxt.intersects(LinkLine.LEFT_MERGE) and not any_horizontal:
+                        link_line_str += "/"
+                    else:
+                        link_line_str += "-"
+                else:
+                    link_line_str += " "
+
+            msg = next(message_iter, None)
+            if msg is not None:
+                link_line_str += " " + msg
+            out.append(link_line_str.rstrip())
+            out.append("\n")
+
+        # Term line
+        if line.term_line is not None:
+            term_row = line.term_line
+            term_strs = ["| ", "~ "]
+            for term_str in term_strs:
+                term_line_str = ""
+                for i, term in enumerate(term_row):
+                    if term:
+                        term_line_str += term_str
+                    else:
+                        if line.pad_lines[i] == PadLine.PARENT:
+                            term_line_str += "| "
+                        elif line.pad_lines[i] == PadLine.ANCESTOR:
+                            term_line_str += ". "
+                        else:
+                            term_line_str += "  "
+                msg = next(message_iter, None)
+                if msg is not None:
+                    term_line_str += " " + msg
+                out.append(term_line_str.rstrip())
+                out.append("\n")
+            need_extra_pad_line = True
+
+        # Base pad line
+        base_pad_line = ""
+        for entry in line.pad_lines:
+            if entry == PadLine.PARENT:
+                base_pad_line += "| "
+            elif entry == PadLine.ANCESTOR:
+                base_pad_line += ". "
+            else:
+                base_pad_line += "  "
+
+        # Remaining message lines
+        for msg in message_iter:
+            pad_line = base_pad_line + " " + msg
+            out.append(pad_line.rstrip())
+            out.append("\n")
+            need_extra_pad_line = False
+
+        if need_extra_pad_line:
+            self._extra_pad_line = base_pad_line
+
+        return "".join(out)