jPipe Runner

     _ ____  _              ____                              
   (_)  _ \(_)_ __   ___   |  _ \ _   _ _ __  _ __   ___ _ __ 
   | | |_) | | '_ \ / _ \  | |_) | | | | '_ \| '_ \ / _ \ '__|
   | |  __/| | |_) |  __/  |  _ <| |_| | | | | | | |  __/ |   
  _/ |_|   |_| .__/ \___|  |_| \_\\__,_|_| |_|_| |_|\___|_|   
 |__/        |_|                                              

A Justification Runner designed for jPipe.

🚀 Usage

CLI

poetry run jpipe-runner [-h] [--variable NAME:VALUE] [--library LIB] \
                         [--diagram PATTERN] [--output FILE] [--dry-run] \
                         [--verbose] [--config-file PATH] [--gui] jd_file

Key options:

• --variable, -v: Define NAME:VALUE pairs for template variables.
• --library, -l: Load additional Python modules (steps).
• --diagram, -d: Select diagrams by wildcard pattern.
• --output, -o: Specify output image file (format inferred by extension).
• --dry-run: Validate workflow without executing.
• --verbose, -V: Enable debug logging.
• --config-file: Load workflow config from a YAML file.
• --gui: Launch the Tkinter-based GraphWorkflowVisualizer

Example:

poetry run jpipe-runner --variable X:10 --diagram "flow*" \
                         --output diagram.png workflow.jd

For detailed instructions on how to execute the project, including descriptions of all CLI parameters and usage examples, see the Usage Guide.

⚙️Installation

Prerequisites

• Python 3.10+
• Poetry
• Graphviz (libgraphviz-dev, pkg-config)
• Optional for GUI version: Tkinter

From Source

# Lock and install dependencies
poetry lock
poetry install

Build Package

# Run tests
poetry run pytest

# Build distributable
poetry build

📚 Learn More

• Usage Guide
• Packaging & CI/CD
• Troubleshooting
• Developer Docs (Sphinx)
• Contributing

📄 License

MIT License — see LICENSE.

👤 Authors

• Jason Lyu
• Baptiste Lacroix
• Sébastien Mosser

How to cite?

@software{mcscert:jpipe-runner,
  author = {Mosser, Sébastien and Lyu, Jason and Lacroix, Baptiste},
  license = {MIT},
  title = {{jPipe Runner}},
  url = {https://github.com/ace-design/jpipe-runner}
}

Contact Us

If you're interested in contributing to the research effort related to jPipe projects, feel free to contact the PI:

• Dr. Sébastien Mosser