A lightweight markup language for simple workflow diagrams.
Project description
workfl
Workflow Markup Language
Introduction
workfl is a lightweight markup language for simple workflow diagrams. It's designed to be quick to write and easy to read.
Example:
A
B
D
A
C
D
You can try it out for yourself at workfl.ws.
The workfl python package can convert workfl markup into dictionaries of nodes and connections. There is also a method to export the workflow into mermaid syntax.
Installation
pip install workfl
Usage
import workfl
markup = "A\nB"
flow = workfl.ws(markup)
print(flow.nodes) # A dictionary of nodes
print(flow.connections) # A dictionary of connections
mermaid = flow.to_mermaid()
print(mermaid)
Syntax
A full guide can be found here https://workfl.ws/?help=true.
To Do
- Allow for connectionless nodes.
- Test scripts.
- Some characters cause problems with the mermaid export, this needs investigation.
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
workfl-0.1.3.tar.gz
(3.1 kB
view hashes)
Built Distribution
workfl-0.1.3-py3-none-any.whl
(4.2 kB
view hashes)