[Suggestion] Restructure package folder?

[XzzX]

This is about this folder https://github.com/pythonworkflow/python-workflow-definition/tree/main/src/python_workflow_definition

• Move WfM specific stuff into own repositories? For me they do not belong into a spec repository.
• Why is https://github.com/pythonworkflow/python-workflow-definition/blob/main/src/python_workflow_definition/shared.py not using the pydantic models?
• What is this for? https://github.com/pythonworkflow/python-workflow-definition/blob/main/src/python_workflow_definition/models.py#L123-L254 In my opinion this does not belong to the spec and irritates as the names are pretty similar to functions provided by pydantic.

[jan-janssen]

Hi @XzzX ,

• I agree that the workflow engine specific part should ideally be included in the workflow engines. At the moment it is primarily included in this repository to enable faster iteration of the Python Workflow Definition.
• Simply for historic reasons - pydantic classes were only added later on Add pydantic validation #97
• I agree it makes sense to separate the JSON writer to a separate module.

While I am not exactly sure how we want to address the first issue, the second and third could be address directly. Feel free to open a corresponding pull request.

[XzzX]

These are API breaking changes. Is that ok?

[jan-janssen]

These are API breaking changes. Is that ok?

I guess we have to properly increase the version but as long as the JOSN format remains the same, I am fine. I think the main focus at the moment is on maintaining backwards compatibility to exported workflows.