approvalml 0.1.0

YAML-based approval workflow parser and validator

ApprovalML

YAML-based approval workflow parser and validator.

Install

pip install approvalml

Or for local development:

git clone https://github.com/yourorg/approvalml
pip install -e ./approvalml

CLI

# Validate a workflow file
approvalml validate my-workflow.yaml

# Validate with step/field details
approvalml validate my-workflow.yaml --verbose

# Print a readable summary
approvalml info my-workflow.yaml

Python API

from approvalml import parse_approvalml_file, parse_approvalml

# From a file
workflow, summary = parse_approvalml_file("leave-request.yaml")
if workflow:
    print(workflow.name)          # "Employee Leave Request"
    print(workflow.workflow.keys()) # step names
else:
    print(summary["errors"])

# From a YAML string
yaml_text = open("my-workflow.yaml").read()
workflow, summary = parse_approvalml(yaml_text)

Example Workflow

name: "Leave Request"
description: "Simple leave approval"

form:
  fields:
    - name: "leave_type"
      type: "select"
      label: "Type of Leave"
      required: true
      options:
        - value: "vacation"
          label: "Vacation"
        - value: "sick"
          label: "Sick Leave"

    - name: "total_days"
      type: "number"
      label: "Total Days"
      required: true

workflow:
  manager_approval:
    name: "manager_approval"
    type: "decision"
    approver: "${requestor.manager}"
    on_approve:
      continue_to: "done"
    on_reject:
      end_workflow: true

  done:
    name: "done"
    type: "end"
    notify_requestor: "Leave request approved"

Example Templates

Browse ready-to-use workflow templates in the examples/ folder:

Category	Template
HR	Leave Request
HR	Pre-screening Interview
Finance	Purchase Request
Finance	Expense Approval
Finance	Invoice Processing
IT	Equipment Request
Procurement	Vendor Purchase Order
Procurement	Purchase Order with Signature

Running Tests

pip install -e ".[dev]"
pytest

License

MIT