PyFlowRED

A port of Node-RED 5.0.7 to Python.

The same editor, the same flow file, the same node set, the same HTTP admin API — with a Python runtime and nodes written in Python.

What "port" means here

The editor is not a reimplementation. It is Node-RED's own editor, talking to a Python implementation of the API it expects. Flows exported from Node-RED import into PyFlowRED and back again: the flow file is the same JSON, and the credentials file uses the same encryption.

See docs/porting.md for the full correspondence.

The nodes it adds

Beyond the ported core set, nineteen node types in five packages come with the distribution — no palette install, no dependency to add. They are aimed at the industrial case: readings arriving from a plant that have to become measurements and events before anything can be done with them.

The state a stream operator keeps lives in RocksDB rather than in the process, which is the difference between a hundred thousand keys costing tens of megabytes resident and costing a gigabyte of Python objects. A window closed by a control message — a shift, a batch, a production order, a cleaning cycle — is one mechanism rather than four nodes, and it is what an availability figure is actually computed from.

Every one of these carries its help text in the editor's info sidebar, and a worked example flow — Import > Examples > node-red in the editor. Sixteen of them, one per node: inject, the node, debug, and a comment block beside each row saying what to look for. docs/nodes/ is the long form: every setting, what each node puts on the message, and the reasoning where the behaviour is not the obvious one.

Where it deliberately differs

Two things cannot be carried over one-to-one, because they are the JavaScript runtime:

1. The Function node runs Python. The same three tabs (On Start, On Message, On Stop), the same node / flow / env objects, the same send and done semantics — but the body is Python:

   msg["payload"] = msg["payload"] * 2
   return msg
   

   The body is compiled into an async def, so await works directly. global is a Python keyword, so the global context object is global_.

   The editor knows it is Python. pylsp runs alongside the runtime, so the Function node has completion, hover, signature help and problems as you type — for the standard library and for anything the Setup tab installed, and for msg, node, flow, global_ and env, whose stubs are generated from the runtime's own classes rather than kept by hand.

2. Packages come from PyPI. The Function node's Setup tab and the palette manager install Python distributions. A PyFlowRED node package is an ordinary distribution that advertises a pyflowred.nodes entry point.

Installing

pip install pyflowred     # or: uv pip install pyflowred
pyflowred

One name throughout: the distribution on PyPI, the command, the import package, the PYFLOWRED_* settings and the editor are all pyflowred. (pyred was already taken on PyPI, which is where the name came from; up to 0.1.0 the import package and command were still pyred, and 0.2.0 renamed them to match.)

The wheel carries the built editor, so this needs Python and nothing else — no Node, no build step. The editor is then at http://127.0.0.1:1880/.

In a container

Two images, same application. Dockerfile installs the released package with uv and carries no build tooling; Dockerfile.source builds this checkout in three stages, Node included.

docker build -t pyflowred:0.6.0 .                        # released
docker build -f Dockerfile.source -t pyflowred:source .  # this checkout
docker run -d -p 1880:1880 -v pyflowred-data:/data pyflowred:0.6.0

Your own CA is a build argument or a mount, and reaches every library in the runtime. See docker/README.md.

Is it keeping up?

pyflowred health                         # the local instance
pyflowred health https://host/pyflowred  # any instance

  [ok  ] flows         running
  [ok  ] event_loop    0.0% of 60 samples over 100 ms, worst 1 ms
  [ok  ] cpu           2% of one core, about 49x this load fits
  [ok  ] throughput    312.3 messages/s received, 65 us of CPU each
  [ok  ] node_errors   0.00 node errors/s
  [ok  ] backpressure  0 in flight, deepest node queue 3

Exit code 0 healthy, 1 degraded, 2 failing, 3 unreachable. The same report is at <httpAdminRoot>health as JSON — 200 while the instance is doing its job, 503 when it is not — for a Kubernetes probe or an uptime monitor. The runtime is one asyncio loop, so what matters is not the core count but whether that loop keeps up; see docs/operations.md.

Building it

Node.js is needed once, to build the editor. It is never needed at runtime.

npm install          # editor build dependencies
npm run build        # builds src/pyflowred/editor_client/public
uv build --wheel     # ~10 MB, py3-none-any

That build output is a git-ignored artifact, so the wheel has to pull it back in deliberately (tool.hatch.build.targets.wheel.artifacts). A build hook refuses to produce a wheel when the editor has not been built, because the failure mode otherwise is a package that installs, starts, and serves a blank page. The editor source is excluded from the wheel and kept in the sdist, where it can be rebuilt.

Working on it

npm install && npm run build
uv venv --python 3.13
uv pip install -e ".[dev]"
.venv/bin/pyflowred

Without adminAuth, anyone who can reach the editor can run arbitrary Python as the user running the process. See docs/operations.md.

Writing a node

def register(RED):
    class LowerCaseNode(RED.Node):
        def __init__(self, config):
            super().__init__(config)
            self.on("input", self._on_input)

        def _on_input(self, msg, send, done):
            msg["payload"] = msg["payload"].lower()
            send(msg)
            done()

    RED.nodes.register_type("lower-case", LowerCaseNode)

with the matching .html next to it, exactly as in Node-RED. A complete example package is in examples/pyflowred-node-lowercase; the details are in docs/writing-nodes.md.

Layout

src/pyflowred/
  util/            property expressions, JSONata, mustache, cloning, logging, i18n
  runtime/         flow engine, node registry, context, credentials, storage
  registry/        node discovery, loading, palette installation
  api/             HTTP admin API, editor routes, comms WebSocket (Starlette)
  metrics/         the Prometheus registry, runtime instrumentation, endpoint
  lsp/             Python language support for the Function node's editor
  streaming/       keyed state on RocksDB, windows, aggregate functions
  nodes/core/      the core node set: Python implementations + Node-RED dialogs
  nodes/core/examples/  a worked example flow per added node type
  editor_client/   the Node-RED editor, vendored and built
tools/
  editor-build/    the Node-RED editor build pipeline, re-pointed at this repo
  devserver.sh     start/stop a throwaway instance
  uicheck.py       load the editor in a real browser and report on it
  uiflow.py        deploy and run a flow through the editor, in a real browser
  uiprojects.py    commit a deploy through the project UI, in a real browser
  uigcs.py         check the Cloud Storage dialogs are typed inputs, in a browser
  uistream.py      check the stream processing dialogs, in a browser
  uilsp.py         check the Function node's completion and problems, in a browser
  exampleflows.py  the per-node example flows the editor offers on Import
  e2eflows.py      the end-to-end integration test: 18 tabs, 157 assertions
  coverage.py      what a run reached: node types and dialog choices
  e2e/             the MQTT broker and Kafka the test talks to
  benchflows.py    seven benchmark flows, 82 nodes across 33 node types
  loadtest.py      drive them and sample the runtime's CPU, RSS and fds
  rawbaseline.py   a bare Starlette endpoint, to measure the runtime against
Dockerfile         the released package, installed with uv
Dockerfile.source  this checkout, editor and all
docker/            entrypoint, compose, CA drop-in
examples/
  e2e-stack/       the integration test as a compose stack you can bring up
  pyflowred-node-lowercase/  a node package, complete and installable
docs/              porting notes, node authoring, operations, benchmarks
docs/nodes/        reference for the nineteen node types this adds
tests/             the test suite, including a browser test of the editor

Tests

.venv/bin/python -m pytest tests

docs/test-coverage.md is the standing record of what is tested, how, and what is not - including the 24% of end-to-end assertions that so far only check that something arrived rather than what it was.

The suite covers every node group against real sockets (including an in-process MQTT broker), the runtime (subflows, groups, context, credentials, deploy types), the admin API, projects against a real git binary, and — when Playwright is available — the actual editor in a headless browser: import a flow, press Deploy, open the Function node, click Inject, read the debug sidebar.

On top of that there is an end-to-end integration test that runs against a real service rather than in-process: eighteen tabs, 803 nodes, 157 assertions. One command brings the whole thing up in containers — application, MQTT, Kafka, and a one-shot that deploys the flows and runs the checks:

docker compose -f examples/e2e-stack/compose.yml up -d
# the editor, with all eighteen tabs in it:
open http://127.0.0.1:1881/pyflowred/

It is also the quickest way to read this project: every node type it adds is wired into a working flow with the assertion that proves it sitting next to it. See examples/e2e-stack.

Licence

Apache-2.0, as Node-RED is. The vendored editor and node dialogs keep their original copyright headers.