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] \
                         [--quiet] [--verbose] [--config-file PATH] 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.
• --quiet, -q: Suppress startup and exception ASCII banners.
• --verbose, -V: Enable debug logging.
• --config-file: Load workflow config from a YAML file. 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)

From Source

# Lock and install dependencies
poetry lock
poetry install

Build Package

# Run tests
poetry run pytest

# Build distributable
poetry build

🏷️ Releasing

Releases are cut from dev and published automatically when a version tag is pushed. See CHANGELOG.md for the release history.

1. Bump the version in pyproject.toml (single source of truth — setup.py and the docs derive from it). Follow SemVer: patch for fixes, minor for backward-compatible features, major for breaking changes.
2. Update CHANGELOG.md — move the relevant notes under a new ## [x.y.z] - YYYY-MM-DD heading.
3. Open a PR dev → main and merge once CI is green.
4. Tag the merged commit on main and push it:

   git checkout main && git pull
   git tag vX.Y.Z          # must equal the pyproject.toml version
   git push origin vX.Y.Z
   

Pushing the vX.Y.Z tag triggers the release pipeline (.github/workflows/release.yml), which validates the tag/version match, runs the tests, builds the docs, wheel, sdist and signed .deb, then publishes to GitHub Releases, PyPI, the Ubuntu PPA, and the Homebrew tap, and deploys the docs to GitHub Pages.

The tag version must match pyproject.toml exactly, or the pipeline fails at the validate-version step.

📚 Learn More

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

📄 License

MIT License — see LICENSE.

👤 Authors

• Jason Lyu
• Baptiste Lacroix
• Sébastien Mosser
• Corentin Veillard

How to cite?

@software{mcscert:jpipe-runner,
  author = {Mosser, Sébastien and Lyu, Jason and Lacroix, Baptiste, and Corentin Veillard},
  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