A FreeCAD fork for PyFlow (since original project is abandoned)

[luzpaz]

Maybe it's worth thinking about a fork for PyFlow since it has been abandoned by the original devs pedroCabrera/PyFlow#106 ?

[AndreasCottet]

Yes, we agree, we had created our project based on the original PyFlow because the Microelly Node Editor has bugs.
This seems to be a good idea, especially since we could add packages like modules to PyFlow.

[AndreasCottet]

It should also be noted that PyFlow is not finished and some features do not work so the software can sometimes bug without reason.

[luzpaz]

Indeed.

It would be good to research if there are active forks of PyFlow as well. Did y'all check for that?

[AndreasCottet]

Yes, unfortunately there are none

[sphh]

I know, it is a pain to switch frameworks, but I wonder if you have had a look at Ryven, which is actively maintained and has a very responsive developer?

[AndreasCottet]

We agree with you. But we haven't tested your module yet and we couldn't see how to create buttons and packages under your module. If these two options are fulfilled then we can do it.

[sphh]

First I would like to point out, that Ryven is not my module. You have to kudos to the original author.

You certainly can produce packages: https://ryven.org/guide#/?id=programming-nodes

It is also possible to add any Qt widget to the graphical representation of a node: https://ryven.org/guide#/?id=custom-widgets

There is a node with a button included:

• https://github.com/leon-thomm/Ryven/blob/4d8af8025c88c96dcee6248e38658e3f8a112795/ryven/example_nodes/std/special_nodes.py#L183
• https://github.com/leon-thomm/Ryven/blob/4d8af8025c88c96dcee6248e38658e3f8a112795/ryven/example_nodes/std/widgets.py#L10

And there is a clock node included, which has a start/stop button:

• https://github.com/leon-thomm/Ryven/blob/4d8af8025c88c96dcee6248e38658e3f8a112795/ryven/example_nodes/std/special_nodes.py#L275
• https://github.com/leon-thomm/Ryven/blob/4d8af8025c88c96dcee6248e38658e3f8a112795/ryven/example_nodes/std/widgets.py#L19

Does that suffice or would you need anything else?

[FlachyJoe]

Please notice the integrated PyFlow is now FreeCAD-tuned with PySide2 dependency instead of Qt.py.

[sphh]

Good point. I am neither the developer of Ryven, nor a Qt developer. I only know, that I had to install PySide2 to get it working …

[AndreasCottet]

This weekend we are going to test Ryven and see if it could be suitable for FreeCAD.

[sphh]

@SHaiZen25, I do not know, how you embed the flow editor into AnimatinFreeCAD, but you might want to use PR leon-thomm/Ryven#96 (that's my involvement with Ryven), because it makes this process configurable. You can also always contact Ryven's author with any question – or me regarding the PR mentioned above.

Good luck!

[AndreasCottet]

We have tested your module and for the moment we find it difficult to project ourselves in it, so we prefer to stay with PyFlow

[sphh]

No problem. As I already said, it is not my module. I just thought, it might help.

Out of curiosity, may I ask, what the difficulties were you encountered?

[AndreasCottet]

As we said, we would like to have this package window containing all the blocks in categories, subcategories, etc. The arrangement of the blocks in the lower left window does not satisfy us. Also there are no buttons available. We also did not understand how to type (e.g. int, string, etc.) a variable. We find that the buttons of the nodes are not very pretty. But your strong point is that the pin values are visible directly and not on a property block. It is much more visible. Concerning getvar, setvar it's a pity not to have a dropdown list with all the variables on the right instead of having to write it. Finally we are less fan of the aesthetics of your module. You should mix PyFlow and Ryven.

[sphh]

Thanks for taking the time to reply.

Again I want to point out, that I am not the author of this library/module, so it cannot be called my module. I became only involved, because I desperately wanted command line arguments …

I find your insight very interesting:

As we said, we would like to have this package window containing all the blocks in categories, subcategories, etc. The arrangement of the blocks in the lower left window does not satisfy us.

That is exactly how I see it. It would be great, if it would be able to have at least categories. On the other hand, the tag system is really handy to just display a certain category.

Also there are no buttons available.

What do you mean, that there are no buttons available? I was always of the impression, that you could include a button in a node.

Or do you mean toolbar buttons? – That is also something, I am missing.

We also did not understand how to type (e.g. int, string, etc.) a variable.

You can use dtypes …

We find that the buttons of the nodes are not very pretty.

You are absolutely right. But how I understand it, you can write your own stylesheet and make everything in the flow window looking like you want it.

I also always use the plain windows style, which is not yet in the main branch, because I do not like the styled windows at all.

Concerning getvar, setvar it's a pity not to have a dropdown list with all the variables on the right instead of having to write it.

Can you please explain that in a bit more detail?

Finally we are less fan of the aesthetics of your module.

You are absolutely right here!! PyFlow looks really pretty. As said previously, I always use the plain window style (coming hopefully in the next release) and one of the nicer flow themes. I believe both can be changed to your liking with stylesheets, which you can adapt yourself.

You should mix PyFlow and Ryven.

Absolutely!

Myself, I was looking for a flow based ‘programming’ interface and first found VisTrail. When that stopped to be supported, I found PyFlow. Unfortunately this was also not maintained anymore, so I switched to Ryven. It would be really great, if those two packages could be merged!