Provide bindings that allow workflows to be executed from inside a Python script

Open
#189 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
35/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Quiet
Tech stack
python, rust

Research direction

Start by reading the pyo3 bindings and the DiagramElementRegistry entry points, then trace how a JSON diagram is built into a workflow and how the crossflow executor receives workflow requests. Done means a Python script can populate the registry with Python-based node or section builders, build a workflow from JSON, and send requests to execute it.

Written by the indexing model from the issue text.

Description

enhancement help wanted

We're currently working on allowing users to run Python scripts as node operations, but with pyo3 bindings it should be feasible to do the reverse as well: Have a Python script run a crossflow executor and send requests to run workflows.

One way this could work is to providing Python bindings for the DiagramElementRegistry so users can populate the registry with Python-based node builders, perhaps even section builders. Then they could pass in a JSON diagram to build into a workflow, and then send requests for that workflow.

With this it would be possible for the main application logic to be written in Python, and then crossflow can be used by the Python application to execute workflow requests as needed.

Dominant language
Rust
Stars
75
Forks
18
Avg merge
12d 12h
Merged PRs (30d)
3

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from open-rmf/crossflow

All issues in open-rmf/crossflow

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.