README.md

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)

By default to_mermaid() will render a chart flowing from Top to Bottom. This can be changed by declaring a direction e.g. to_mermaid(direction="LR") (Left to Right). There are 4 options:

Option	Direction
TB	Top to Bottom (Default)
BT	Bottom to Top
LR	Left to Right
RL	Right to Left

Syntax

A full guide can be found here https://workfl.ws/?help=true.

To Do

• Test scripts.