plumcraft-engine 0.1.0__tar.gz

plumcraft_engine-0.1.0/.gitignore

@@ -0,0 +1,17 @@
+/target/
+target/
+**/.venv/
+__pycache__/
+*.pyc
+.DS_Store
+# claude-debug: notes (.md) are tracked; code and data are not
+claude-debug/*
+!claude-debug/*.md
+# rendered reports (the .md is the source)
+docs/**/*.pdf
+.ruff_cache/
+.pytest_cache/
+
+# local, not part of the project
+/.idea/
+/synesthesia.png

plumcraft_engine-0.1.0/LICENSE-APACHE

@@ -0,0 +1,202 @@
+
+                                 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 [yyyy] [name of copyright owner]
+
+   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.

plumcraft_engine-0.1.0/LICENSE-MIT

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (C) 2026 by Sean D. True and Swapwizard LLC
+
+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.

plumcraft_engine-0.1.0/PKG-INFO

@@ -0,0 +1,161 @@
+Metadata-Version: 2.5
+Name: plumcraft-engine
+Version: 0.1.0
+Summary: PlumCraft's Python engine SDK and the text engine in Python, speaking protocol 2 over the mode 2 socket binding, with blobs in commonkit
+Project-URL: Homepage, https://github.com/seantrue/plumcraft
+Project-URL: Repository, https://github.com/seantrue/plumcraft
+Project-URL: Issues, https://github.com/seantrue/plumcraft/issues
+Project-URL: Changelog, https://github.com/seantrue/plumcraft/blob/main/CHANGELOG.md
+Author: Sean D. True, Swapwizard LLC
+License-Expression: MIT OR Apache-2.0
+License-File: LICENSE-APACHE
+License-File: LICENSE-MIT
+Keywords: node editor,node graph,plumcraft,workflow
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: POSIX
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.11
+Requires-Dist: numpy>=1.26
+Requires-Dist: pillow>=10
+Requires-Dist: pyuncommonkit>=0.1
+Description-Content-Type: text/markdown
+
+# PlumCraft engines in Python
+
+`plumcraft_engine` is PlumCraft's engine SDK in Python: protocol 2's executor, host, the mode 2 socket and mode 3 HTTP fronts, and blobs in commonkit. `plumcraft_text` is the text engine written with it, kept byte-identical on the wire to the Rust `plumcraft-text` by the conformance suite (`cargo test -p plumcraft-text`).
+
+## Install
+
+```sh
+pip install plumcraft-engine
+plumcraft-engine new my-engine --name Mine   # a whole engine project, with tests and scripts
+```
+
+Python 3.11 or later. Running an engine needs only this package. The editor is Rust: see [PlumCraft](https://github.com/seantrue/plumcraft) to build it.
+
+## An engine in 20 lines
+
+```python
+import sys
+from typing import Annotated, Literal
+
+from plumcraft_engine import ConfigError, Cx, Engine, Range, WireType, node
+
+Text = Annotated[str, WireType("TEXT", media="text", color="#c9a227", thumb=True)]
+
+
+class Shout(Engine):
+    id, name, version = "shout", "Shout", "0.1.0"
+    category = "Text"
+
+    @node("Loud")
+    def loud(self, text: Text, marks: Annotated[int, Range(0, 5)] = 1, case: Literal["upper", "title"] = "upper") -> Text:
+        """Shout the text."""
+        if not text:
+            raise ConfigError("nothing to shout")
+        return (text.upper() if case == "upper" else text.title()) + "!" * marks
+
+    @node("Wait")
+    def wait(self, text: Text, seconds: float = 1.0, *, cx: Cx) -> Text:
+        cx.progress(0.5, "waiting")
+        return text
+
+
+if __name__ == "__main__":
+    sys.exit(Shout.serve())
+```
+
+That is the whole engine. The class is compiled when it is defined: each `@node` method becomes a NodeDef (`shout.loud`: a `TEXT` socket, an `INT` widget with `min`/`max`, an `ENUM` widget with choices, a `TEXT` output), and each mistake raises `DeclarationError` at import, not mid-run. `Shout()` builds the engine; `Shout` itself is the factory `Host` and the bindings take.
+
+## Ports from annotations
+
+| Python | Port |
+|---|---|
+| `str`, `int`, `float`, `bool` | `STRING`, `INT`, `FLOAT`, `BOOL`: a widget that can also be wired (no `socket` field, the proto's default) |
+| `Literal["a", "b"]` | `ENUM` with `choices: ["a", "b"]` |
+| `Annotated[T, WireType("ID", media=...)]` alias | a socket of type `ID` (`socket: "socket"`); declare the alias once, at module level |
+| `String`, `Int`, `Float`, `Bool` (from the SDK) | the scalar types as explicit aliases, for `wires` and annotations |
+| `Text`, `Table`, `Image`, `Audio`, `Array`, `Svg`, `Json` (from the SDK) | the core types, exactly as every engine declares them (`docs/interface.md`): a node takes and returns a `str`, a columnar table `dict`, an encoded-picture `Blob` (make one with `image(data)`), an `AudioValue(samples, sample_rate)`, an ndarray or `ArrayValue`, an SVG `Blob` (`svg(text)`), and any JSON value |
+| `= default` | `default` (an `int` default on a `float` port becomes a float) |
+| `X \| None = None` | `optional: true` |
+| `Annotated[float, Range(0, 1, 0.1)]` | `min`, `max`, `step` |
+| `Annotated[str, File("open", (("Text", ("txt",)),))]` | `path: {mode, filters}`; `open`, `save` or `dir` |
+| `Annotated[T, Port(label=, tooltip=, advanced=, socket=, name=, decimals=)]` | those fields |
+| a parameter annotated with a `@dataclass` | one port per field (with the field's annotation and default); the method receives the dataclass |
+| a parameter named `cx` (or annotated `Cx`) | not a port: the node's `Cx`, for `cx.progress(f, stage)` and `cx.cancelled()` |
+| `with_` | the port `with` (one trailing underscore is dropped, for keywords) |
+
+Outputs come from the return annotation:
+
+| Return | Outputs |
+|---|---|
+| `-> Text` (any port type) | one output, named after the wire type's id in lower case (`text`), or `@node(output="name")` |
+| `-> Pair` (a `NamedTuple`) | one output per field, typed by the field; return the tuple. `output=("a", "b")` renames them |
+| `-> None` | none (a sink) |
+
+## `@node` options
+
+`@node` alone, or `@node("Display name", ...)` with any of: `id` (default `<engine id>.<method>`), `category` (a string or a path; default the engine's `category`), `description` (default the docstring), `output`, `family` and `icon` (default the engine's), `version` (part of the memo key; bump it when results change), `memo` (a scope such as `"none"`, or a whole `memo` object), `flags`, `x` (passed through).
+
+Engine class attributes: `id`, `name`, `version`, `salt` (default `py:<id>+<version>`), `dependencies` (the packages results depend on, such as `("opencv-python-headless",)`: their versions join the memo salt, so an upgrade never reuses an old result), `category`, `family`, `icon`, and `wires`: the wire types in catalogue order. Without `wires`, the catalogue lists the types in the order the nodes first use them; with it, a node using a type not listed is a `DeclarationError`. Subclasses inherit nodes and may override them.
+
+## Values and errors
+
+Before the method runs, every input is checked against its port:
+
+- a `str` port (or a wire type over `str`) receives any value as text: strings as they are, other values as compact JSON;
+- an `int`, `float`, `bool` or `Literal` port that gets the wrong type, or a number outside its `Range`, fails the node with a `config` error naming the port (`marks: 9 is outside 0..5`);
+- `Range(..., invalid="clamp")` clamps instead, and replaces a wrong type with the default; `Range(..., invalid="pass")` makes the range a UI hint only and hands the value over as it is.
+
+Raise `ConfigError("...")` for a setting the user can fix, `OpError("...")` for a failure on this input, or `NodeError.cancelled()` when `cx.cancelled()`. Any other exception fails the node as `op` with its type and message, and the engine carries on.
+
+## Serving
+
+`MyEngine.serve()` reads the command line: `--connect unix:<path>` (or `PLUMCRAFT_ENGINE_SOCKET` and `PLUMCRAFT_ENGINE_TOKEN`) serves mode 2, `--listen host:port [--port-file f] [--lifeline]` serves mode 3. In a test, `Host(MyEngine)` runs it in process.
+
+**Pictures on nodes:** a picture file's value shows a thumbnail when it carries one. Make it with `image(data, pixels=array)`, or override `Engine.picture_thumb(blob)` to give Load Files' values one, returning (h, w, 4) uint8; the SDK itself decodes no pictures.
+
+## From the command line
+
+`plumcraft-engine` drives an engine with no Rust build:
+
+```sh
+uv run plumcraft-engine nodes                                  # the catalogue
+uv run plumcraft-engine run                                    # the [tool.plumcraft] demo, events as they come
+uv run plumcraft-engine run my.json --watch shout.text         # a workflow, with a value watched
+uv run plumcraft-engine run my.json --cancel-after 0.5 --raw   # cancel mid-run; every event as JSON
+uv run plumcraft-engine run my.json --attach http://127.0.0.1:7311   # an engine serving --listen
+```
+
+- **The engine:** `--engine module:Class`, else `[tool.plumcraft] engine` in the nearest `pyproject.toml` (this one names `plumcraft_text:TextEngine`, with `demo = "../examples/data.json"`). It runs in process, as the editor's in-process mode does; `--attach URL` talks to one already serving HTTP, with `PLUMCRAFT_ENGINE_TOKEN` when set.
+- **The workflow:** path inputs relative to the workflow's folder are made absolute, as `plumcraft run` does.
+- **The exit code:** 0 when every node is `done` or `cached`, 1 when one isn't, 2 when the engine or workflow can't be had. A script can use `run` as a smoke test.
+
+## A new engine
+
+```sh
+uv run --project ~/workspace/plumcraft/python plumcraft-engine new ~/workspace/weather-engine --name Weather --types text
+```
+
+This writes a standalone uv project that depends on this SDK, which `scripts/editor` opens in PlumCraft's editor, the editor starting the engine from its manifest: the engine with example nodes for each type, its tests (including a golden catalogue and conformance), a demo workflow, scripts for testing from the command line, PyCharm run configurations, a README for the developer, and the engine manifest. It refuses a directory with something in it and ids PlumCraft already uses, and a failure leaves nothing behind.
+
+- **`--types`:** `text`, `table`, `array`, `svg`, `image` (adds pillow), `audio`, `json`, `list` (brings `text`), `any` (the building blocks), comma-separated. Scalars are always on. A conversion is generated when both its types are chosen, always with its inverse: `table`↔`text` (CSV), `table`↔`array`, `svg`↔`text`, `image`↔`array`, `audio`↔`array`, `json`↔`text`.
+- **The other options:** `--id`, `--name`, `--package`, `--sdk pypi|path|git[@REV]`, `--python`, `--no-pycharm`, `--git`.
+
+`uv run plumcraft-engine check` runs PlumCraft's conformance cases against an engine, in process and over HTTP (`--mode` for one): the session, core types declared exactly, every node on its defaults, the demo, cancel, answers off the run path, and hostile widget values. It needs only the catalogue, plus `[tool.plumcraft] demo` and `[tool.plumcraft.conformance] slow` when set; in a test, `plumcraft_engine.conformance.assert_conformant(MyEngine, demo=..., slow=...)` fails naming every failed case.
+
+## Alternatives considered
+
+1. **A parameters dataclass per node as the only form** (the research software's `parameters = AnnealParameters`). It reads well with ten settings and badly with one, and it splits a node's inputs between the signature (sockets) and the dataclass (widgets). It is supported as a parameter type for nodes with many settings.
+2. **`Port(...)` as the default** (`find: str = Port("", label="Find")`, as typer and pydantic do). It hides the real default from type checkers and from readers. `Annotated` keeps the default a default.
+3. **Signatures plus `Annotated`** (chosen): the method is an ordinary typed function a type checker understands, the port list is the parameter list, and metadata sits beside the type it qualifies.
+
+## The low-level layer
+
+The decorators compile to the layer underneath, which stays and is the escape hatch: a `Node` subclass with a `definition` dict (a NodeDef in protocol 2's JSON) and `run(inputs, cx) -> dict`, or `simple(definition, fn)`, added with `engine.with_node(...)` to a declared engine or to `Engine(info)`. Use it for what a signature can't say yet: variadic ports, `options`, `list` ports, `active_when`, `disabled_choices`, or ports whose shape depends on configuration.

plumcraft_engine-0.1.0/README.md

@@ -0,0 +1,133 @@
+# PlumCraft engines in Python
+
+`plumcraft_engine` is PlumCraft's engine SDK in Python: protocol 2's executor, host, the mode 2 socket and mode 3 HTTP fronts, and blobs in commonkit. `plumcraft_text` is the text engine written with it, kept byte-identical on the wire to the Rust `plumcraft-text` by the conformance suite (`cargo test -p plumcraft-text`).
+
+## Install
+
+```sh
+pip install plumcraft-engine
+plumcraft-engine new my-engine --name Mine   # a whole engine project, with tests and scripts
+```
+
+Python 3.11 or later. Running an engine needs only this package. The editor is Rust: see [PlumCraft](https://github.com/seantrue/plumcraft) to build it.
+
+## An engine in 20 lines
+
+```python
+import sys
+from typing import Annotated, Literal
+
+from plumcraft_engine import ConfigError, Cx, Engine, Range, WireType, node
+
+Text = Annotated[str, WireType("TEXT", media="text", color="#c9a227", thumb=True)]
+
+
+class Shout(Engine):
+    id, name, version = "shout", "Shout", "0.1.0"
+    category = "Text"
+
+    @node("Loud")
+    def loud(self, text: Text, marks: Annotated[int, Range(0, 5)] = 1, case: Literal["upper", "title"] = "upper") -> Text:
+        """Shout the text."""
+        if not text:
+            raise ConfigError("nothing to shout")
+        return (text.upper() if case == "upper" else text.title()) + "!" * marks
+
+    @node("Wait")
+    def wait(self, text: Text, seconds: float = 1.0, *, cx: Cx) -> Text:
+        cx.progress(0.5, "waiting")
+        return text
+
+
+if __name__ == "__main__":
+    sys.exit(Shout.serve())
+```
+
+That is the whole engine. The class is compiled when it is defined: each `@node` method becomes a NodeDef (`shout.loud`: a `TEXT` socket, an `INT` widget with `min`/`max`, an `ENUM` widget with choices, a `TEXT` output), and each mistake raises `DeclarationError` at import, not mid-run. `Shout()` builds the engine; `Shout` itself is the factory `Host` and the bindings take.
+
+## Ports from annotations
+
+| Python | Port |
+|---|---|
+| `str`, `int`, `float`, `bool` | `STRING`, `INT`, `FLOAT`, `BOOL`: a widget that can also be wired (no `socket` field, the proto's default) |
+| `Literal["a", "b"]` | `ENUM` with `choices: ["a", "b"]` |
+| `Annotated[T, WireType("ID", media=...)]` alias | a socket of type `ID` (`socket: "socket"`); declare the alias once, at module level |
+| `String`, `Int`, `Float`, `Bool` (from the SDK) | the scalar types as explicit aliases, for `wires` and annotations |
+| `Text`, `Table`, `Image`, `Audio`, `Array`, `Svg`, `Json` (from the SDK) | the core types, exactly as every engine declares them (`docs/interface.md`): a node takes and returns a `str`, a columnar table `dict`, an encoded-picture `Blob` (make one with `image(data)`), an `AudioValue(samples, sample_rate)`, an ndarray or `ArrayValue`, an SVG `Blob` (`svg(text)`), and any JSON value |
+| `= default` | `default` (an `int` default on a `float` port becomes a float) |
+| `X \| None = None` | `optional: true` |
+| `Annotated[float, Range(0, 1, 0.1)]` | `min`, `max`, `step` |
+| `Annotated[str, File("open", (("Text", ("txt",)),))]` | `path: {mode, filters}`; `open`, `save` or `dir` |
+| `Annotated[T, Port(label=, tooltip=, advanced=, socket=, name=, decimals=)]` | those fields |
+| a parameter annotated with a `@dataclass` | one port per field (with the field's annotation and default); the method receives the dataclass |
+| a parameter named `cx` (or annotated `Cx`) | not a port: the node's `Cx`, for `cx.progress(f, stage)` and `cx.cancelled()` |
+| `with_` | the port `with` (one trailing underscore is dropped, for keywords) |
+
+Outputs come from the return annotation:
+
+| Return | Outputs |
+|---|---|
+| `-> Text` (any port type) | one output, named after the wire type's id in lower case (`text`), or `@node(output="name")` |
+| `-> Pair` (a `NamedTuple`) | one output per field, typed by the field; return the tuple. `output=("a", "b")` renames them |
+| `-> None` | none (a sink) |
+
+## `@node` options
+
+`@node` alone, or `@node("Display name", ...)` with any of: `id` (default `<engine id>.<method>`), `category` (a string or a path; default the engine's `category`), `description` (default the docstring), `output`, `family` and `icon` (default the engine's), `version` (part of the memo key; bump it when results change), `memo` (a scope such as `"none"`, or a whole `memo` object), `flags`, `x` (passed through).
+
+Engine class attributes: `id`, `name`, `version`, `salt` (default `py:<id>+<version>`), `dependencies` (the packages results depend on, such as `("opencv-python-headless",)`: their versions join the memo salt, so an upgrade never reuses an old result), `category`, `family`, `icon`, and `wires`: the wire types in catalogue order. Without `wires`, the catalogue lists the types in the order the nodes first use them; with it, a node using a type not listed is a `DeclarationError`. Subclasses inherit nodes and may override them.
+
+## Values and errors
+
+Before the method runs, every input is checked against its port:
+
+- a `str` port (or a wire type over `str`) receives any value as text: strings as they are, other values as compact JSON;
+- an `int`, `float`, `bool` or `Literal` port that gets the wrong type, or a number outside its `Range`, fails the node with a `config` error naming the port (`marks: 9 is outside 0..5`);
+- `Range(..., invalid="clamp")` clamps instead, and replaces a wrong type with the default; `Range(..., invalid="pass")` makes the range a UI hint only and hands the value over as it is.
+
+Raise `ConfigError("...")` for a setting the user can fix, `OpError("...")` for a failure on this input, or `NodeError.cancelled()` when `cx.cancelled()`. Any other exception fails the node as `op` with its type and message, and the engine carries on.
+
+## Serving
+
+`MyEngine.serve()` reads the command line: `--connect unix:<path>` (or `PLUMCRAFT_ENGINE_SOCKET` and `PLUMCRAFT_ENGINE_TOKEN`) serves mode 2, `--listen host:port [--port-file f] [--lifeline]` serves mode 3. In a test, `Host(MyEngine)` runs it in process.
+
+**Pictures on nodes:** a picture file's value shows a thumbnail when it carries one. Make it with `image(data, pixels=array)`, or override `Engine.picture_thumb(blob)` to give Load Files' values one, returning (h, w, 4) uint8; the SDK itself decodes no pictures.
+
+## From the command line
+
+`plumcraft-engine` drives an engine with no Rust build:
+
+```sh
+uv run plumcraft-engine nodes                                  # the catalogue
+uv run plumcraft-engine run                                    # the [tool.plumcraft] demo, events as they come
+uv run plumcraft-engine run my.json --watch shout.text         # a workflow, with a value watched
+uv run plumcraft-engine run my.json --cancel-after 0.5 --raw   # cancel mid-run; every event as JSON
+uv run plumcraft-engine run my.json --attach http://127.0.0.1:7311   # an engine serving --listen
+```
+
+- **The engine:** `--engine module:Class`, else `[tool.plumcraft] engine` in the nearest `pyproject.toml` (this one names `plumcraft_text:TextEngine`, with `demo = "../examples/data.json"`). It runs in process, as the editor's in-process mode does; `--attach URL` talks to one already serving HTTP, with `PLUMCRAFT_ENGINE_TOKEN` when set.
+- **The workflow:** path inputs relative to the workflow's folder are made absolute, as `plumcraft run` does.
+- **The exit code:** 0 when every node is `done` or `cached`, 1 when one isn't, 2 when the engine or workflow can't be had. A script can use `run` as a smoke test.
+
+## A new engine
+
+```sh
+uv run --project ~/workspace/plumcraft/python plumcraft-engine new ~/workspace/weather-engine --name Weather --types text
+```
+
+This writes a standalone uv project that depends on this SDK, which `scripts/editor` opens in PlumCraft's editor, the editor starting the engine from its manifest: the engine with example nodes for each type, its tests (including a golden catalogue and conformance), a demo workflow, scripts for testing from the command line, PyCharm run configurations, a README for the developer, and the engine manifest. It refuses a directory with something in it and ids PlumCraft already uses, and a failure leaves nothing behind.
+
+- **`--types`:** `text`, `table`, `array`, `svg`, `image` (adds pillow), `audio`, `json`, `list` (brings `text`), `any` (the building blocks), comma-separated. Scalars are always on. A conversion is generated when both its types are chosen, always with its inverse: `table`↔`text` (CSV), `table`↔`array`, `svg`↔`text`, `image`↔`array`, `audio`↔`array`, `json`↔`text`.
+- **The other options:** `--id`, `--name`, `--package`, `--sdk pypi|path|git[@REV]`, `--python`, `--no-pycharm`, `--git`.
+
+`uv run plumcraft-engine check` runs PlumCraft's conformance cases against an engine, in process and over HTTP (`--mode` for one): the session, core types declared exactly, every node on its defaults, the demo, cancel, answers off the run path, and hostile widget values. It needs only the catalogue, plus `[tool.plumcraft] demo` and `[tool.plumcraft.conformance] slow` when set; in a test, `plumcraft_engine.conformance.assert_conformant(MyEngine, demo=..., slow=...)` fails naming every failed case.
+
+## Alternatives considered
+
+1. **A parameters dataclass per node as the only form** (the research software's `parameters = AnnealParameters`). It reads well with ten settings and badly with one, and it splits a node's inputs between the signature (sockets) and the dataclass (widgets). It is supported as a parameter type for nodes with many settings.
+2. **`Port(...)` as the default** (`find: str = Port("", label="Find")`, as typer and pydantic do). It hides the real default from type checkers and from readers. `Annotated` keeps the default a default.
+3. **Signatures plus `Annotated`** (chosen): the method is an ordinary typed function a type checker understands, the port list is the parameter list, and metadata sits beside the type it qualifies.
+
+## The low-level layer
+
+The decorators compile to the layer underneath, which stays and is the escape hatch: a `Node` subclass with a `definition` dict (a NodeDef in protocol 2's JSON) and `run(inputs, cx) -> dict`, or `simple(definition, fn)`, added with `engine.with_node(...)` to a declared engine or to `Engine(info)`. Use it for what a signature can't say yet: variadic ports, `options`, `list` ports, `active_when`, `disabled_choices`, or ports whose shape depends on configuration.

plumcraft_engine-0.1.0/pyproject.toml

@@ -0,0 +1,64 @@
+[project]
+name = "plumcraft-engine"
+version = "0.1.0"
+description = "PlumCraft's Python engine SDK and the text engine in Python, speaking protocol 2 over the mode 2 socket binding, with blobs in commonkit"
+readme = "README.md"
+license = "MIT OR Apache-2.0"
+license-files = ["LICENSE-MIT", "LICENSE-APACHE"]
+authors = [{ name = "Sean D. True" }, { name = "Swapwizard LLC" }]
+keywords = ["node editor", "node graph", "workflow", "plumcraft"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Operating System :: MacOS",
+    "Operating System :: POSIX",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Software Development :: Libraries",
+]
+requires-python = ">=3.11"
+dependencies = ["numpy>=1.26", "pillow>=10", "pyuncommonkit>=0.1"]
+
+[project.urls]
+Homepage = "https://github.com/seantrue/plumcraft"
+Repository = "https://github.com/seantrue/plumcraft"
+Issues = "https://github.com/seantrue/plumcraft/issues"
+Changelog = "https://github.com/seantrue/plumcraft/blob/main/CHANGELOG.md"
+
+[project.scripts]
+plumcraft-text-engine-py = "plumcraft_text.__main__:main"
+plumcraft-engine = "plumcraft_engine.cli:main"
+
+[dependency-groups]
+dev = ["pytest>=8", "ruff>=0.6"]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/plumcraft_engine", "src/plumcraft_text"]
+
+[tool.ruff]
+line-length = 160
+target-version = "py311"
+# tests/golden holds generated projects, checked with their own settings (test_new_engine.py).
+extend-exclude = ["tests/golden"]
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I", "B", "UP"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+norecursedirs = ["golden"]
+
+# `plumcraft-engine run` and `nodes` here drive the Python text engine (plumcraft_engine.cli); a
+# generated engine's project names its own.
+[tool.plumcraft]
+engine = "plumcraft_text:TextEngine"
+demo = "../examples/data.json"
+
+[tool.plumcraft.conformance]
+slow = "text.slow"