Skip to main content

make python function easily accessible from Node-RED

Project description Documentation Status


Make your python functions available in Node-RED using a simple decorator.

pynodered is a server communicating with Node-RED to make available your python functions as blocks in Node-RED. pynodered reads modules and python files containing functions decorated with ‘node_red’, register them as blocks in Node-RED. pynodred then handles communications between Node-RED (in javascript) to run your function whenever the block receives a message.

Quick Start

Requires python>=3.5

$ pip install pynodered
# Install node dependencies
$ npm install follow-redirects url querystring


A simple example to lowercase the payload of the messages:

from pynodered import node_red

def lower_case(node, msg):

    msg['payload'] = str(msg['payload']).lower()
    return msg

Put this snippet is in a file “”, run the pynodered server with:

$ pynodered

and in another console:

$ node-red

In Node-RED, you now have a new category “pyfuncs” with a function lower_case. It can be used in a flow as any other blocks:


It is possible to add block properties (constant arguments provided by the user in Node-RED) by defining a property in the decorator:

from pynodered import node_red, NodeProperty

          properties=dict(number=NodeProperty("Number", value="1")))

def repeat(node, msg):

    msg['payload'] = msg['payload'] * int(node.number.value)
    return msg

Don’t forget to restart the pynodered server everytime your python files change. Node-RED also needs to be restarted but only when the function name or properties change or a new function is added. Refreshing the browser is then necessary.

By default pynodered exports the functions in the Node-RED package ‘pynodered’ and the category ‘default’. The category name can be changed with the decorator optional argument. For the package name and information, the python module containing the functions can declare a ‘package’ dictonary like this:

package = {
    "name" : "FFT filters",
    "version" : "0.01",
    "description"  : "Nodes written in Python for signal processing",


pynodered is not ready for production use yet. On a multi-user computer, be aware that pynodered server will respond to anyone request and will execute code under the account that launched the server. NODE-Red has a similar issue (


Copyright (C) 2019 Ghislain Picard

Free software: GNU General Public License v3

This package is a rewrite and extension of the code intially written by Tomaž Šolc for sigfox-toolbox Copyright (2017) SensorLab, Jožef Stefan Institute and licensed under GPL version 3

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pynodered-0.2.0.tar.gz (17.0 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page