PyFlyde - Python SDK for Flyde visual programming language

PyFlyde is a Python SDK for the Flyde visual programming language. It allows you to create, modify and run Flyde programs from Python.

Documentation Contents

• Quickstart
• CLI Usage
• Package Reference

Readme

PyFlyde

Python runtime for Flyde with Data Engineering emphasis.

Links:

• Flyde homepage
• Documentation

Getting started

You need Python 3.9+ installed on your machine to run PyFlyde.

Then you can install PyFlyde to your environment using pip:

pip install pyflyde

On some systems Python3 requires pip3 command instead:

pip3 install pyflyde

Running the examples

You can copy examples folder from this repository to your local project to give it a try. Then you can run the example flow with:

pyflyde examples/HelloWorld.flyde

Or you can install this package locally after cloning this repository and run the examples directly:

pip install .
./pyflyde examples/HelloWorld.flyde

To run other examples you would need to install their dependencies:

pip install examples/

Then you can run e.g.

./pyflyde examples/Clustering.flyde

Using the visual editor

Install Flyde VSCode extension from the marketplace. It will open existing .flyde files in the visual editor. You can call Flyde: New Visual Flow command in VSCode to create a new flow file.

You can browse the component library in the panel on the right. To see your local components click the "View all" button. They will appear under the "Current project". Note that PyFlyde doesn't implement all of the Flyde's stdlib components, only a few essential ones.

Whenever you change your component library classes or their interfaces, use pyflyde gen command to generate flyde-nodes.json definitions, e.g.:

pyflyde gen examples/

This will recursively scan all Python files in the directory and its subdirectories to find PyFlyde components and generate a flyde-nodes.json file with relative paths. Flyde editor needs flyde-nodes.json files in order to "see" your components.

Running a Machine Learning example and creating your first project

For further details please check Quickstart guide.

Contributing

Install dev dependencies

pip install .\[dev\]

Run tests, linters and coverage reports

To run tests only:

make test

To run tests with coverage and see report:

make cover report

To run linters:

make lint