kohakunode 0.2.1__tar.gz

kohakunode-0.2.1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Shih-Ying Yeh (aka KohakuBlueLeaf, KBlueLeaf)
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

kohakunode-0.2.1/PKG-INFO

@@ -0,0 +1,478 @@
+Metadata-Version: 2.4
+Name: kohakunode
+Version: 0.2.1
+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: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Rust
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Software Development :: Compilers
+Requires-Dist: lark>=1.2
+Requires-Dist: pytest>=8 ; extra == 'dev'
+Requires-Dist: ruff ; extra == 'dev'
+Requires-Dist: black ; extra == 'dev'
+Requires-Dist: pygls>=2 ; extra == 'dev'
+Requires-Dist: maturin>=1.8,<2 ; extra == 'dev'
+Requires-Dist: pygls>=2 ; extra == 'lsp'
+Provides-Extra: dev
+Provides-Extra: lsp
+License-File: LICENSE
+Summary: KIR: a text IR for node graphs, with a sequential meaning per job
+Author-email: "Shih-Ying Yeh(KohakuBlueLeaf)" <apolloyeh0123@gmail.com>
+License: Apache-2.0
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Homepage, https://kblueleaf.net/
+Project-URL: Repository, https://github.com/KohakuBlueleaf/KohakuNodeIR
+
+<h1 align="center">KohakuNodeIR</h1>
+<p align="center">
+  <strong>A text IR for node graphs: what an editor draws, a person reads, and a machine runs, as one program.</strong>
+</p>
+<p align="center">
+  <img src="https://img.shields.io/badge/python-3.10%2B-blue" alt="Python 3.10+">
+  <img src="https://img.shields.io/badge/license-Apache--2.0-green" alt="License: Apache-2.0">
+  <img src="https://img.shields.io/pypi/v/kohakunode" alt="PyPI version">
+  <a href="https://github.com/KohakuBlueleaf/KohakuNodeIR"><img src="https://img.shields.io/github/stars/KohakuBlueleaf/KohakuNodeIR?style=social" alt="GitHub stars"></a>
+</p>
+<p align="center">
+  <a href="docs/spec/README.md"><strong>Specification</strong></a> &nbsp;·&nbsp;
+  <a href="docs/architecture.md"><strong>Architecture</strong></a> &nbsp;·&nbsp;
+  <a href="examples/README.md"><strong>Examples</strong></a> &nbsp;·&nbsp;
+  <a href="https://discord.gg/xWYrkyvJ2s"><strong>Discord</strong></a>
+</p>
+
+---
+
+## Is this for you?
+
+**You probably want KIR if** you build node-based tools (an image pipeline, an
+agent workflow, a captioning graph) and want the graph to be a real program:
+diffable text, loops and branches as explicit control flow, typed nodes from
+signature files, a reference interpreter that defines the result, and an
+executor that is free to run whatever the wires allow in parallel.
+
+**You probably don't if** a plain DAG of tasks covers everything you need (a
+workflow scheduler already does that well), or you want a general-purpose
+scripting language. KIR has no expressions: every computation is a node, and
+nodes are written in your host language.
+
+## What KIR is
+
+KIR describes **one job** as a node graph. Nodes are joined by two kinds of
+wire: **control** wires ("then", top and bottom ports) and **data** wires
+(values, side ports). The text is that graph written line by line:
+
+```
+(inputs)node(outputs)          a node; data wires are the names
+label:                         a namespace, entered only by a builtin
+(cond)branch(`yes`, `no`)      control flow is explicit: branch, switch, jump, parallel, each
+@dataflow:                     a block ordered by data alone
+@def (x: int)double(y: int):   a subgraph, called like any node
+```
+
+A complete program ([examples/tour/01_each.kir](examples/tour/01_each.kir)):
+
+```
+image = "photo"
+boxes = [1, 2, 3, 4]
+nodes = []
+(boxes)each(box, i, `body`)
+body:
+    (box)is_new(fresh)
+    (fresh)branch(`new_box`, `known_box`)
+    new_box:
+        (image, box)crop(c)
+        (c)entity(node)
+    known_box:
+        node = None
+    (nodes, node)append(nodes)
+(nodes)summarize(summary)
+```
+
+**A job means its sequential run.** Statements run top to bottom, namespaces
+are entered only by builtins, and a name holds the value last written to it.
+
+**Parallel by default.** Nodes talk only through their wires, so an executor
+may run any two nodes in either order or at once unless a data wire, the
+control path, or a node flag (`mutates`, `ordered`) orders them. Nothing in a
+program has to say what may run in parallel, the way a CPU issues several
+instructions of one thread at once while the program order still defines the
+result. `parallel` exists, but it states intent only.
+
+**One language, many forms.** A program can be shown as a graph (for editors)
+or as text (for people and tools). Optimization passes rewrite it into simpler
+programs in the same language, down to a form an interpreter runs directly.
+Nothing in the text marks which form it is in; every form is KIR, and every
+form runs.
+
+## Where it fits
+
+|  | Graph is the program | Text form | Control flow | Typed nodes | Parallel by default |
+|--|--|--|--|--|--|
+| Node editor save files (e.g. ComfyUI workflow JSON) | yes | JSON only | no | per editor | executor-specific |
+| Visual scripting (Blueprints, Scratch) | yes | no | yes | yes | no |
+| Workflow DAGs (task schedulers) | yes | code or YAML | limited | no | yes |
+| **KIR** | **yes** | **yes, line per node** | **yes, as wires** | **yes, signature files** | **yes** |
+
+KIR sits between editors and executors. An editor (the example in
+`apps/kir-editor`, a ComfyUI import, a Python builder, or a person with a text
+editor) produces KIR; a machine receives KIR plus engines that implement its
+nodes and never needs to know how the KIR was made.
+
+## Key features
+
+- **Text and graph are the same program.** `kir graph` / `kir text` convert
+  both ways; canonical text survives the round trip byte for byte, and
+  behaviour is always preserved.
+- **Explicit control flow as wires.** `branch`, `switch`, `jump`, `parallel`,
+  `each` and `@try` / `@except` each have a node shape, so loops and branches
+  are visible in the graph, not hidden in node code.
+- **Optimization passes over one language.** `order_dataflow`, `inline`,
+  `expand_each`, `version`, `group`, `strip_meta`. Any prefix of the list is a
+  valid program with the same behaviour; a tool picks the form it wants
+  (`kir lower --passes ...`, `compile_source(..., passes=[...])`).
+- **Signatures and `@use`.** Node libraries export `.kirsig.json` files
+  (ports, types, defaults, flags), so the checker, editors and the language
+  server never import node code. `@use "gbc" as g` makes a library callable.
+- **A static checker.** Undefined reads on any path, wrong port counts, type
+  mismatches, ambiguous names, bad labels, dataflow cycles: one code per rule
+  ([checks.md](docs/spec/checks.md)).
+- **Program hashes.** A semantic hash (ignores `@meta` and `@hint`) to key
+  caches and reproducibility, and a full hash that also covers hints.
+- **Hints that never change results.** `@hint lane="vlm"` tells a scheduler
+  something; deleting every hint leaves every result unchanged.
+- **A reference interpreter with a call hook**, so a machine can replay its
+  recorded node results and check that it computed what the program means.
+- **Editing support.** A tree-sitter grammar, a VS Code extension, and a
+  language server (`kir-lsp`: diagnostics, hover, completion, go-to-definition,
+  formatting).
+- **ComfyUI import / export.** Both the UI workflow and the API prompt.
+- **A Rust core** (PyO3 module and WASM build) that reproduces the Python
+  reference byte for byte on the shared golden corpus.
+
+## Quick start
+
+> **Python** 3.10 or newer. At run time `kohakunode` depends only on `lark`.
+
+### 1. Install
+
+```bash
+pip install kohakunode                 # the Python reference, the Rust core (kohakunode._rs), `kir`
+pip install "kohakunode[lsp]"          # plus the language server `kir-lsp`
+```
+
+From source (builds the Rust core, so a Rust toolchain is needed):
+
+```bash
+git clone https://github.com/KohakuBlueleaf/KohakuNodeIR.git
+cd KohakuNodeIR
+pip install -e ".[dev]"                # pytest, ruff, black, pygls, maturin
+```
+
+### 2. Write nodes
+
+```python
+# my_nodes.py
+from kohakunode import NodeLibrary
+
+lib = NodeLibrary("my_nodes")
+
+@lib.node(outputs=["sum"])
+def add(a: int, b: int) -> int:
+    return a + b
+
+@lib.node(outputs=["graph"], mutates=["graph"])   # changes its input in place
+def attach(graph: list, node: str) -> list:
+    graph.append(node)
+    return graph
+
+@lib.node(ordered=True)                             # touches the outside world
+def log(message: str) -> None:
+    print(message)
+```
+
+A node may depend only on its inputs and affect the job only through its
+outputs; the two flags declare the exceptions once, in the registry
+([writing nodes](docs/guides/writing-nodes.md)).
+
+### 3. Export signatures for tools that should not import your code
+
+```bash
+kir sig export my_nodes -o sigs/       # writes sigs/my_nodes.kirsig.json
+```
+
+Programs then say `@use "my_nodes"`; the tools find the file on `--sig-path`
+or `KIR_SIG_PATH`.
+
+### 4. Use the toolchain
+
+```bash
+kir check prog.kir --lib my_nodes            # diagnostics with codes (checks.md)
+kir fmt prog.kir -w                          # canonical text, in place
+kir lower prog.kir --lib my_nodes            # after every pass
+kir lower prog.kir --passes order_dataflow,inline --hash
+kir graph prog.kir -o prog.kirgraph          # text -> graph view (--data variables: name -> node -> name)
+kir text prog.kirgraph                       # graph view -> canonical text (--no-meta to drop ids/positions)
+kir run prog.kir --lib my_nodes              # the reference run; prints final values
+kir-lsp                                      # language server on stdio
+```
+
+`--lib` imports a Python module that defines a `NodeLibrary`; `--sig-path`
+adds directories of signature files.
+
+## Core mental model
+
+### Two kinds of wire
+
+```text
+            control in
+               |
+      +--------v--------+
+ a -->|                 |--> sum         data wires: values, by name
+ b -->|   (a, b)add     |
+      +--------+--------+
+               |
+            control out                  control wires: "then"
+```
+
+A call node has control ports on top and bottom and data ports on its sides.
+`branch` has one control output per label, `merge` joins control paths (a
+labelled merge is a loop entry), `each` has `body` / `done` outputs and a
+`next` input its body returns to. The full list of node kinds and ports is in
+[graph.md](docs/spec/graph.md).
+
+### Namespaces and continuation
+
+```
+(is_big)branch(`big`, `small`)
+big:
+    (x)shrink(x)
+small:
+    (x)grow(x)
+(x)log()              # both paths continue here, after the namespace definitions
+```
+
+A namespace is skipped when reached in sequence and entered only by a builtin.
+When its body ends, execution continues after the namespace's definition; an
+`each` body returns to its `each`; `parallel` arms run one after another;
+`@dataflow:` and `@try` bodies continue after their statement. `jump` is the
+only way back, so a loop is a namespace entered by a `jump` from before it and
+re-entered by a `jump` from inside it.
+
+### The pass pipeline
+
+```text
+ .kirgraph (editor) <-> canonical .kir text
+                             |
+                         check (E/W codes)
+                             |
+  order_dataflow -> inline -> expand_each -> version -> group -> strip_meta
+       (every intermediate program is valid KIR and runs)
+                             |
+          +------------------+------------------+
+          |                                     |
+ reference interpreter                  machines (parallel,
+ (sequential, defines the result)       as if sequential)
+```
+
+After every pass, each `@dataflow:` block is a straight run whose dependence
+graph a machine computes once: every write has its own version `x__n`, and a
+name written on several paths gets a home version `x__0`. Control statements
+between blocks choose what runs next; a job's state is its position plus its
+values ([passes.md](docs/spec/passes.md)).
+
+## Toolchain
+
+| Piece | Where | What |
+|---|---|---|
+| Python reference | `src/kohakunode/` | parser, writer, checker, passes, hashes, graph view, interpreter, CLI, ComfyUI, language server; the ground truth |
+| Rust core | `rust/` | the same parse, write, check, passes, hashes and graph conversion; shipped in the wheel as `kohakunode._rs`, plus a WASM build |
+| tree-sitter grammar | `editors/tree-sitter-kir/` | highlighting and structure for any tree-sitter editor |
+| VS Code extension | `editors/vscode/` | highlighting, snippets, folding, and a client for `kir-lsp` |
+| Example node editor | `apps/kir-editor/` | Vue 3 + Vue Flow + elkjs + CodeMirror: nodes, flowchart, sequence, blocks and text views of one program |
+
+### Rust core
+
+```bash
+maturin develop --release                   # from the repo root: kohakunode with kohakunode._rs, into the active venv
+python rust/tests/parity/parity.py          # the Rust core against the Python reference
+cd rust && cargo test                       # unit tests + golden corpus, byte for byte
+
+# WASM for browsers
+rustup target add wasm32-unknown-unknown
+cargo install wasm-bindgen-cli --version 0.2.129   # must match wasm-bindgen in Cargo.lock
+cargo build --release --target wasm32-unknown-unknown --features wasm
+wasm-bindgen --target web --out-dir pkg target/wasm32-unknown-unknown/release/kohakunode_rs.wasm
+```
+
+`kohakunode._rs` takes and returns text: `format`, `parse_to_json`, `check`,
+`lower(passes=None)`, `hashes`, `to_graph`, `from_graph`, `std_signatures`;
+signatures come as `.kirsig.json` texts and, for `check` / `lower` / `hashes` /
+`to_graph`, through `base=` and `sig_path=` the way `@use` resolves them. The
+WASM build exposes the same functions to browsers (signature texts only). `\N{...}` string escapes use the default
+`unicode-names` feature; `--no-default-features --features wasm` builds a
+smaller WASM file without it.
+
+### VS Code
+
+```bash
+pip install -e ".[lsp]"
+cd editors/vscode && npm install
+ln -s "$(pwd)" ~/.vscode/extensions/kir-language
+```
+
+Settings `kir.server.path`, `kir.server.args` and `kir.sigPath` choose the
+server command and the signature directories ([editors/vscode](editors/vscode/README.md)).
+
+### Example node editor
+
+```bash
+pip install fastapi uvicorn
+cd apps/kir-editor/backend && python -m uvicorn kir_editor.app:app --port 48888
+cd apps/kir-editor/frontend && npm install && npm run dev     # http://localhost:5173
+```
+
+Five views of one program: nodes (ComfyUI / Blender / UE style, with data as
+variables or wires and control as exec wires or frames), a classic ROBO Pro
+flowchart, an EV3-style sequence, Scratch blocks, and text; any two side by
+side. A palette built from signature files, an inspector, undo / redo, and
+Problems / Run / Lowered panels with per-pass toggles
+([apps/kir-editor](apps/kir-editor/README.md)).
+
+## Python API
+
+```python
+from kohakunode import (
+    parse, write,                  # text <-> AST; parse(write(p)) == p
+    check,                         # diagnostics
+    compile_source, compile_file,  # env + check + passes + hashes in one call
+    Interpreter,                   # the sequential reference run, with a call hook
+    NodeLibrary,                   # the node registry
+)
+from kohakunode.graph import to_graph, from_graph          # graph view
+from kohakunode.comfyui import from_comfyui, to_api        # ComfyUI
+from kohakunode.lower import PASSES, run_passes            # individual passes
+
+compiled = compile_source(text, [lib], passes=["order_dataflow", "expand_each"])
+compiled.program         # the checked program as written
+compiled.lowered         # after the chosen passes (all of them when passes=None)
+compiled.diagnostics     # warnings; errors raise KirCheckError
+compiled.semantic_hash, compiled.full_hash
+
+graph = to_graph(compiled.program, compiled.env)   # .kirgraph dict
+text = write(from_graph(graph, with_meta=False))   # canonical text
+
+def replay(name, inputs, call):                    # a machine's recorded results
+    return recorded[(name, key(inputs))]
+
+Interpreter(compiled.lowered, compiled.env, hook=replay).run()
+```
+
+## Codebase map
+
+```text
+src/kohakunode/
+  syntax/      kir.lark grammar, parser, AST, canonical writer
+  sig/         NodeLibrary, .kirsig.json files, @use resolution, types, kir.std
+  flow/        control-flow graph, reaching definitions, dataflow ordering
+  check/       every rule of docs/spec/checks.md
+  lower/       the optimization passes and program hashes
+  run/         the sequential reference interpreter
+  graph/       text <-> graph view
+  comfyui/     ComfyUI workflow / API prompt import and export
+  lsp/         the language server (kir-lsp)
+  cli/         the kir command
+  compiler.py  compile_source / compile_program / compile_file
+rust/          the Rust core, PyO3 and WASM bindings
+editors/       tree-sitter-kir, vscode
+apps/          kir-editor (example node editor)
+examples/      basics (v1 programs), tour (one file per feature), gbc, comfyui
+tests/         unit tests, the v1 reference corpus, the golden corpus
+docs/          spec/, guides/, architecture.md, plan/
+```
+
+## Documentation map
+
+### Specification
+[Overview](docs/spec/README.md) · [Language](docs/spec/language.md) · [Semantics](docs/spec/semantics.md) · [Signatures and `@use`](docs/spec/signatures.md) · [Graph view](docs/spec/graph.md) · [Optimization passes](docs/spec/passes.md) · [Checks](docs/spec/checks.md)
+
+### Guides
+[Writing nodes](docs/guides/writing-nodes.md) · [Running KIR on a machine](docs/guides/machines.md) · [Examples](examples/README.md)
+
+### Internals
+[Architecture](docs/architecture.md) · [v2 work plan](docs/plan/v2.md)
+
+## Testing
+
+```bash
+pytest                                   # the Python reference: unit tests, golden corpus, v1 parity, generated programs
+cd rust && cargo test                    # the Rust core against the same golden corpus
+cd apps/kir-editor/frontend && npm run test:e2e   # one browser smoke run of the example editor
+```
+
+The golden corpus (`tests/corpus/golden`) holds the canonical text, the fully
+optimized text, the graph view and the hashes of every case; the Python
+reference and the Rust core must both reproduce it byte for byte. The v1
+corpus (`tests/corpus/v1`) records what the v1 implementation printed for
+every v1 program; v2 reproduces it except for listed, deliberate differences.
+
+## Releases
+
+`kohakunode` is one wheel: the Python reference plus the Rust core as the
+extension module `kohakunode._rs`. The version is `rust/Cargo.toml`'s
+(`pyproject.toml` reads it dynamically). Publishing a GitHub release, or
+pushing a `v*` tag, runs `release.yml`: wheels for CPython 3.10–3.14 on Linux
+x86_64 / aarch64 (manylinux 2_28), Windows x64 and macOS arm64, Android wheels
+(arm64, x86_64; Python 3.13) and the sdist, all uploaded to PyPI and to the
+GitHub release.
+
+## Coming from v1
+
+v2 keeps v1's model (sequential meaning, namespaces entered by builtins,
+`jump` loops, `@dataflow:`, `@def`) and every program v1 parsed still parses. New:
+`@use`, `each`, `@try` / `@except err`, typed `@def` parameters and outputs,
+`@hint`, node flags, the graph view with control ports, and optimization
+passes in place of fixed levels. The v1 implementation is in the git history
+(commit `1abda17`).
+
+## License
+
+[Apache-2.0](LICENSE)
+
+Copyright 2026 Shih-Ying Yeh (KohakuBlueLeaf) and contributors.
+
+## Community
+
+- Discord: https://discord.gg/xWYrkyvJ2s
+- Issues: https://github.com/KohakuBlueleaf/KohakuNodeIR/issues
+
+## FAQ
+
+**Does a program have to say what runs in parallel?**
+No. A job means its sequential run, and an executor may overlap anything the
+wires, the control path and node flags allow. `parallel` states intent only.
+
+**Why is there no expression syntax?**
+Every computation is a node, so the graph and the text stay the same thing.
+`kir.std` provides the small pure nodes most programs need (`add`, `less`,
+`len`, `append`, `to_str`, ...).
+
+**What does an executor need besides the text?**
+Implementations of the nodes the program calls. Signature files describe them
+to tools; executors map node names to implementations themselves.
+
+**How do I know a machine computed the right thing?**
+Run sample jobs on the machine and on the reference interpreter with a call
+hook that replays the machine's node results, then compare final values
+([machines.md](docs/guides/machines.md)).
+
+**Which pass output should a machine run?**
+Its choice. The fully optimized program is the simplest to schedule; a machine
+that schedules `each` itself can stop before `expand_each`. Every form means
+the same thing.
+