Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/trustmaster/pyflyde
Python runtime for Flyde - visual flow-based programming language and IDE
https://github.com/trustmaster/pyflyde
dataflow flow-based-programming visual
Last synced: 2 months ago
JSON representation
Python runtime for Flyde - visual flow-based programming language and IDE
- Host: GitHub
- URL: https://github.com/trustmaster/pyflyde
- Owner: trustmaster
- License: apache-2.0
- Created: 2024-03-25T20:29:04.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-09-28T18:01:44.000Z (4 months ago)
- Last Synced: 2024-10-31T19:51:36.324Z (2 months ago)
- Topics: dataflow, flow-based-programming, visual
- Language: Python
- Homepage: https://flyde.dev
- Size: 632 KB
- Stars: 8
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PyFlyde
[
](https://pyflyde.readthedocs.io/en/latest/)
Python runtime for [Flyde](https://github.com/flydelabs/flyde) with Data Engineering emphasis.
Links:
- [Flyde homepage](https://flyde.dev)
- [Documentation](https://pyflyde.readthedocs.io/en/latest/)
## Getting started
You need Python 3.9+ installed on your machine to run PyFlyde.
Then you can install PyFlyde using pip:
```bash
pip 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:
```bash
pyflyde examples/HelloWorld.flyde
```
To run other examples you would need to install their dependencies:
```bash
pip install examples/
```
### Using the visual editor
Install Flyde VSCode extension from the [marketplace](https://marketplace.visualstudio.com/items?itemName=flyde.flyde-vscode). 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.ts` definitions, e.g.:
```bash
pyflyde gen examples/mylib/components.py
```
Flyde editor needs `.flyde.ts` files in order to "see" your components.
### Running a Machine Learning example and creating your first project
For further details please check [Quickstart](https://pyflyde.readthedocs.io/en/latest/quickstart/) guide.
## Contributing
### Install dev dependencies
```bash
pip install .\[dev\]
```
### Run tests, linters and coverage reports
To run tests only:
```bash
make test
```
To run tests with coverage and see report:
```bash
make cover report
```
To run linters:
```bash
make lint
```