d2-widget 0.0.0__py3-none-any.whl

d2_widget/__init__.py

@@ -0,0 +1,103 @@
+import importlib.metadata
+import pathlib
+
+import anywidget
+import traitlets
+from typing import TypedDict, Optional, Literal, Annotated
+
+try:
+    __version__ = importlib.metadata.version("d2-widget")
+except importlib.metadata.PackageNotFoundError:
+    __version__ = "unknown"
+
+
+class RenderOptions(TypedDict, total=False):
+    """Matches RenderOptions from @terrastruct/d2"""
+
+    sketch: Annotated[
+        bool,
+        "Enable sketch mode [default: false]",
+    ]
+    themeID: Annotated[
+        int,
+        "Theme ID to use [default: 0]",
+    ]
+    darkThemeID: Annotated[
+        int,
+        "Theme ID to use when client is in dark mode",
+    ]
+    center: Annotated[
+        bool,
+        "Center the SVG in the containing viewbox [default: false]",
+    ]
+    pad: Annotated[
+        int,
+        "Pixels padded around the rendered diagram [default: 100]",
+    ]
+    scale: Annotated[
+        float,
+        "Scale the output",
+    ]
+    forceAppendix: Annotated[
+        bool,
+        "Adds an appendix for tooltips and links [default: false]",
+    ]
+    target: Annotated[
+        str,
+        "Target board/s to render",
+    ]
+    animateInterval: Annotated[
+        int,
+        "Multiple boards transition interval (in milliseconds)",
+    ]
+    salt: Annotated[
+        str,
+        "Add a salt value to ensure the output uses unique IDs",
+    ]
+    noXMLTag: Annotated[
+        bool,
+        "Omit XML tag from output SVG files",
+    ]
+
+
+class CompileOptions(RenderOptions, total=False):
+    """Matches CompileOptions from @terrastruct/d2"""
+
+    layout: Annotated[
+        Literal["dagre", "elk"],
+        "Layout engine to use [default: 'dagre']",
+    ]
+    fontRegular: Annotated[
+        bytes,
+        "A byte array containing .ttf file for regular font",
+    ]
+    fontItalic: Annotated[
+        bytes,
+        "A byte array containing .ttf file for italic font",
+    ]
+    fontBold: Annotated[
+        bytes,
+        "A byte array containing .ttf file for bold font",
+    ]
+    fontSemibold: Annotated[
+        bytes,
+        "A byte array containing .ttf file for semibold font",
+    ]
+
+
+class D2Widget(anywidget.AnyWidget):
+    _esm = pathlib.Path(__file__).parent / "static" / "widget.js"
+    _css = pathlib.Path(__file__).parent / "static" / "widget.css"
+    
+    _svg = traitlets.Unicode().tag(sync=True)
+    diagram = traitlets.Unicode().tag(sync=True)
+    options = traitlets.Dict({}).tag(sync=True)
+
+    def __init__(self, diagram: str, options: Optional[CompileOptions] = None):
+        super().__init__()
+        self.diagram = diagram
+        self.options = options or {}
+
+    @property
+    def svg(self) -> str:
+        return self._svg

d2_widget/static/widget.css

@@ -0,0 +1 @@
+.d2-widget{width:100%}.error{padding:10px;color:#721c24;background-color:#f8d7da;border:1px solid #f5c6cb;border-radius:4px;margin:10px 0;font-family:sans-serif}

d2_widget/static/widget.js

@@ -0,0 +1 @@
+import{D2 as c}from"https://esm.sh/@terrastruct/d2@0.1.23-nightly.20250328.0b2203c10";async function d(e,r,o){let t=await e.compile(r,{options:o});return e.render(t.diagram,t.renderOptions)}var u=()=>{let e=new c;return{async render({model:r,el:o}){let t=()=>r.get("diagram"),i=()=>r.get("options"),a=n=>{r.set("_svg",n),r.save_changes()},s=async()=>{try{let n=await d(e,t(),i());a(n),o.innerHTML=n,o.classList.add("d2-widget")}catch(n){console.error(n);let g=n instanceof Error?n.message:"Unknown error";o.innerHTML=`<div class="error">Error generating diagram: ${g}</div>`}};r.on("change:diagram",s),r.on("change:options",s),await s()}}};export{u as default};

d2_widget-0.0.0.dist-info/METADATA

@@ -0,0 +1,85 @@
+Metadata-Version: 2.4
+Name: d2-widget
+Version: 0.0.0
+Summary: AnyWidget wrapper for D2 diagrams
+Project-URL: Homepage, https://github.com/peter-gy/d2-widget
+Project-URL: Repository, https://github.com/peter-gy/d2-widget
+Project-URL: Documentation, https://github.com/peter-gy/d2-widget#readme
+Project-URL: Bug Tracker, https://github.com/peter-gy/d2-widget/issues
+Author-email: Péter Ferenc Gyarmati <dev.petergy@gmail.com>
+License: Copyright © 2025 Péter Ferenc Gyarmati
+        
+        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.
+License-File: LICENSE
+Keywords: anywidget,d2,diagram,jupyter,widget
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: Jupyter
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.8
+Requires-Dist: anywidget>=0.9
+Requires-Dist: traitlets>=5
+Description-Content-Type: text/markdown
+
+# d2-widget
+
+## Installation
+
+```sh
+pip install d2-widget
+```
+
+or with [uv](https://github.com/astral-sh/uv):
+
+```sh
+uv add d2-widget
+```
+
+## Development
+
+We recommend using [uv](https://github.com/astral-sh/uv) for development.
+It will automatically manage virtual environments and dependencies for you.
+
+```sh
+uv run jupyter lab example.ipynb
+```
+
+Alternatively, create and manage your own virtual environment:
+
+```sh
+python -m venv .venv
+source .venv/bin/activate
+pip install -e ".[dev]"
+jupyter lab example.ipynb
+```
+
+The widget front-end code bundles it's JavaScript dependencies. After setting up Python,
+make sure to install these dependencies locally:
+
+```sh
+npm install
+```
+
+While developing, you can run the following in a separate terminal to automatically
+rebuild JavaScript as you make changes:
+
+```sh
+npm run dev
+```
+
+Open `example.ipynb` in JupyterLab, VS Code, or your favorite editor
+to start developing. Changes made in `js/` will be reflected
+in the notebook.

d2_widget-0.0.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+d2_widget/__init__.py,sha256=ixnBcm3-8nuupm-vaLHhPI_OZojmVG45YwEtP0dDWLM,2669
+d2_widget/static/widget.css,sha256=YBNDbbpS4kH6s_88dl1aObaVGpdoZ2ZXXcZN4-zJycg,162
+d2_widget/static/widget.js,sha256=HOFSCyiEZ7WQvlVPqGvPmYeK9VBVaWAlK4USH6X0miE,662
+d2_widget-0.0.0.dist-info/METADATA,sha256=qma9PKodaimamgDsVL7m7lUgNM_vRp5t-bALTrinUp4,3340
+d2_widget-0.0.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+d2_widget-0.0.0.dist-info/licenses/LICENSE,sha256=4Mzdw12DcjbqLSKafAd_3GtpiWDUBYqbIsdnirpsm7o,1072
+d2_widget-0.0.0.dist-info/RECORD,,

d2_widget-0.0.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

d2_widget-0.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,7 @@
+Copyright © 2025 Péter Ferenc Gyarmati
+
+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.